mil.nga.tiff

Class Rasters

java.lang.Object

mil.nga.tiff.Rasters

public class Rasters
extends Object

Raster image values

Author:

osbornb

Constructor Summary

Constructors

Constructor and Description
Rasters(int width, int height, int samplesPerPixel, int bitsPerSample) Constructor
Rasters(int width, int height, int samplesPerPixel, List<Integer> bitsPerSample) Constructor
Rasters(int width, int height, int samplesPerPixel, List<Integer> bitsPerSample, Number[] interleaveValues) Constructor
Rasters(int width, int height, int samplesPerPixel, List<Integer> bitsPerSample, Number[][] sampleValues) Constructor
Rasters(int width, int height, int samplesPerPixel, List<Integer> bitsPerSample, Number[][] sampleValues, Number[] interleaveValues) Constructor

Method Summary

Modifier and Type	Method and Description
void	addToInterleave(int coordinate, Number value) Add a value to the interleaved results
void	addToSample(int sampleIndex, int coordinate, Number value) Add a value to the sample results
int	calculateRowsPerStrip(int planarConfiguration) Calculate the rows per strip to write
int	calculateRowsPerStrip(int planarConfiguration, int maxBytesPerStrip) Calculate the rows per strip to write
List<Integer>	getBitsPerSample() Get the bits per sample
Number	getFirstPixelSample(int x, int y) Get the first pixel sample value, useful for single sample pixels (grayscale)
int	getHeight() Get the height of pixels
int	getInterleaveIndex(int x, int y) Get the interleave index location
Number[]	getInterleaveValues() Get the results stored as interleaved pixel samples
int	getNumPixels() Return the number of pixels
Number[]	getPixel(int x, int y) Get the pixel sample values
Number	getPixelSample(int sample, int x, int y) Get a pixel sample value
int	getSampleIndex(int x, int y) Get the sample index location
int	getSamplesPerPixel() Get the number of samples per pixel
Number[][]	getSampleValues() Get the results stored by samples
int	getWidth() Get the width of pixels
boolean	hasInterleaveValues() True if the results are stored interleaved
boolean	hasSampleValues() True if the results are stored by samples
void	setFirstPixelSample(int x, int y, Number value) Set the first pixel sample value, useful for single sample pixels (grayscale)
void	setInterleaveValues(Number[] interleaveValues) Set the results stored as interleaved pixel samples
void	setPixel(int x, int y, Number[] values) Set the pixel sample values
void	setPixelSample(int sample, int x, int y, Number value) Set a pixel vample value
void	setSampleValues(Number[][] sampleValues) Set the results stored by samples
int	size() Size in bytes of the image
int	sizePixel() Size in bytes of a pixel
int	sizeSample(int sample) Size in bytes of a sample

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Rasters

public Rasters(int width,
               int height,
               int samplesPerPixel,
               List<Integer> bitsPerSample,
               Number[][] sampleValues)

Constructor

Parameters:

width - width of pixels

height - height of pixels

samplesPerPixel - samples per pixel

bitsPerSample - bits per sample

sampleValues - empty sample values double array

Rasters

public Rasters(int width,
               int height,
               int samplesPerPixel,
               List<Integer> bitsPerSample,
               Number[] interleaveValues)

Constructor

Parameters:

width - width of pixels

height - height of pixels

samplesPerPixel - samples per pixel

bitsPerSample - bits per sample

interleaveValues - empty interleaved values array

Rasters

public Rasters(int width,
               int height,
               int samplesPerPixel,
               List<Integer> bitsPerSample,
               Number[][] sampleValues,
               Number[] interleaveValues)

Constructor

Parameters:

width - width of pixels

height - height of pixels

samplesPerPixel - samples per pixel

bitsPerSample - bits per sample

sampleValues - empty sample values double array

interleaveValues - empty interleaved values array

Rasters

public Rasters(int width,
               int height,
               int samplesPerPixel,
               List<Integer> bitsPerSample)

Constructor

Parameters:

width - width of pixels

height - height of pixels

samplesPerPixel - samples per pixel

bitsPerSample - bits per sample

Rasters

public Rasters(int width,
               int height,
               int samplesPerPixel,
               int bitsPerSample)

Constructor

Parameters:

width - width of pixels

height - height of pixels

samplesPerPixel - samples per pixel

bitsPerSample - single sample bits per sample

Method Detail

hasSampleValues

public boolean hasSampleValues()

True if the results are stored by samples

Returns:

true if results exist

hasInterleaveValues

public boolean hasInterleaveValues()

True if the results are stored interleaved

Returns:

true if results exist

addToSample

public void addToSample(int sampleIndex,
                        int coordinate,
                        Number value)

Add a value to the sample results

Parameters:

sampleIndex - sample index

coordinate - coordinate location

value - value

addToInterleave

public void addToInterleave(int coordinate,
                            Number value)

Add a value to the interleaved results

Parameters:

coordinate - coordinate location

value - value

getWidth

public int getWidth()

Get the width of pixels

Returns:

width

getHeight

public int getHeight()

Get the height of pixels

Returns:

height

getNumPixels

public int getNumPixels()

Return the number of pixels

Returns:

number of pixels

getSamplesPerPixel

public int getSamplesPerPixel()

Get the number of samples per pixel

Returns:

samples per pixel

getBitsPerSample

public List<Integer> getBitsPerSample()

Get the bits per sample

Returns:

bits per sample

getSampleValues

public Number[][] getSampleValues()

Get the results stored by samples

Returns:

sample values

setSampleValues

public void setSampleValues(Number[][] sampleValues)

Set the results stored by samples

Parameters:

sampleValues - sample values

getInterleaveValues

public Number[] getInterleaveValues()

Get the results stored as interleaved pixel samples

Returns:

interleaved values

setInterleaveValues

public void setInterleaveValues(Number[] interleaveValues)

Set the results stored as interleaved pixel samples

Parameters:

interleaveValues - interleaved values

getPixel

public Number[] getPixel(int x,
                         int y)

Get the pixel sample values

Parameters:

x - x coordinate (>= 0 && < getWidth())

y - y coordinate (>= 0 && < getHeight())

Returns:

pixel sample values

setPixel

public void setPixel(int x,
                     int y,
                     Number[] values)

Set the pixel sample values

Parameters:

x - x coordinate (>= 0 && < getWidth())

y - y coordinate (>= 0 && < getHeight())

values - pixel values

getPixelSample

public Number getPixelSample(int sample,
                             int x,
                             int y)

Get a pixel sample value

Parameters:

sample - sample index (>= 0 && < samplesPerPixel)

x - x coordinate (>= 0 && < getWidth())

y - y coordinate (>= 0 && < getHeight())

Returns:

pixel sample

setPixelSample

public void setPixelSample(int sample,
                           int x,
                           int y,
                           Number value)

Set a pixel vample value

Parameters:

sample - sample index (>= 0 && < samplesPerPixel)

x - x coordinate (>= 0 && < getWidth())

y - y coordinate (>= 0 && < getHeight())

value - pixel value

getFirstPixelSample

public Number getFirstPixelSample(int x,
                                  int y)

Get the first pixel sample value, useful for single sample pixels (grayscale)

Parameters:

x - x coordinate (>= 0 && < getWidth())

y - y coordinate (>= 0 && < getHeight())

Returns:

first pixel sample

setFirstPixelSample

public void setFirstPixelSample(int x,
                                int y,
                                Number value)

Set the first pixel sample value, useful for single sample pixels (grayscale)

Parameters:

x - x coordinate (>= 0 && < getWidth())

y - y coordinate (>= 0 && < getHeight())

value - pixel value

getSampleIndex

public int getSampleIndex(int x,
                          int y)

Get the sample index location

Parameters:

x - x coordinate

y - y coordinate

Returns:

sample index

getInterleaveIndex

public int getInterleaveIndex(int x,
                              int y)

Get the interleave index location

Parameters:

x - x coordinate

y - y coordinate

Returns:

interleave index

size

public int size()

Size in bytes of the image

Returns:

bytes

sizePixel

public int sizePixel()

Size in bytes of a pixel

Returns:

bytes

sizeSample

public int sizeSample(int sample)

Size in bytes of a sample

Parameters:

sample - sample index

Returns:

bytes

calculateRowsPerStrip

public int calculateRowsPerStrip(int planarConfiguration)

Calculate the rows per strip to write

Parameters:

planarConfiguration - chunky or planar

Returns:

rows per strip

calculateRowsPerStrip

public int calculateRowsPerStrip(int planarConfiguration,
                                 int maxBytesPerStrip)

Calculate the rows per strip to write

Parameters:

planarConfiguration - chunky or planar

maxBytesPerStrip - attempted max bytes per strip

Returns:

rows per strip