Class BandedSampleModel

java.lang.Object

java.awt.image.SampleModel

java.awt.image.ComponentSampleModel

java.awt.image.BandedSampleModel

public final class BandedSampleModel
extends ComponentSampleModel

This class represents image data which is stored in a band interleaved fashion and for which each sample of a pixel occupies one data element of the DataBuffer. It subclasses ComponentSampleModel but provides a more efficient implementation for accessing band interleaved image data than is provided by ComponentSampleModel. This class should typically be used when working with images which store sample data for each band in a different bank of the DataBuffer. Accessor methods are provided so that image data can be manipulated directly. Pixel stride is the number of data array elements between two samples for the same band on the same scanline. The pixel stride for a BandedSampleModel is one. Scanline stride is the number of data array elements between a given sample and the corresponding sample in the same column of the next scanline. Band offsets denote the number of data array elements from the first data array element of the bank of the DataBuffer holding each band to the first sample of the band. The bands are numbered from 0 to N-1. Bank indices denote the correspondence between a bank of the data buffer and a band of image data. This class supports TYPE_BYTE, TYPE_USHORT, TYPE_SHORT, TYPE_INT, TYPE_FLOAT, and TYPE_DOUBLE datatypes

Field Summary

Fields declared in class ComponentSampleModel

bandOffsets, bankIndices, numBands, numBanks, pixelStride, scanlineStride

Modifier and Type	Field	Description
protected int[]	bandOffsets	Offsets for all bands in data array elements.
protected int[]	bankIndices	Index for each bank storing a band of image data.
protected int	numBands	The number of bands in this ComponentSampleModel.
protected int	numBanks	The number of banks in this ComponentSampleModel.
protected int	pixelStride	Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.
protected int	scanlineStride	Line stride (in data array elements) of the region of image data described by this ComponentSampleModel.

Fields declared in class SampleModel

dataType, height, width

Modifier and Type	Field	Description
protected int	dataType	Data type of the DataBuffer storing the pixel data.
protected int	height	Height in pixels of the region of image data that this SampleModel describes.
protected int	width	Width in pixels of the region of image data that this SampleModel describes.

Constructor Summary

Constructors

Constructor	Description
BandedSampleModel(int dataType, int w, int h, int numBands)	Constructs a BandedSampleModel with the specified parameters.
BandedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets)	Constructs a BandedSampleModel with the specified parameters.

Method Summary

Modifier and Type	Method	Description
SampleModel	createCompatibleSampleModel(int w, int h)	Creates a new BandedSampleModel with the specified width and height.
DataBuffer	createDataBuffer()	Creates a DataBuffer that corresponds to this BandedSampleModel, The DataBuffer's data type, number of banks, and size will be consistent with this BandedSampleModel.
SampleModel	createSubsetSampleModel(int[] bands)	Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel.
Object	getDataElements(int x, int y, Object obj, DataBuffer data)	Returns data for a single pixel in a primitive array of type TransferType.
int[]	getPixel(int x, int y, int[] iArray, DataBuffer data)	Returns the samples for a specified pixel in an int array, one sample per array element.
int[]	getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)	Returns all samples for a rectangle of pixels in an int array, one sample per array element.
int	getSample(int x, int y, int b, DataBuffer data)	Returns the sample in a specified band for the pixel located at (x,y) as an int.
double	getSampleDouble(int x, int y, int b, DataBuffer data)	Returns the sample in a specified band for a pixel located at (x,y) as a double.
float	getSampleFloat(int x, int y, int b, DataBuffer data)	Returns the sample in a specified band for the pixel located at (x,y) as a float.
int[]	getSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)	Returns the samples for a specified band for the specified rectangle of pixels in an int array, one sample per array element.
void	setDataElements(int x, int y, Object obj, DataBuffer data)	Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType.
void	setPixel(int x, int y, int[] iArray, DataBuffer data)	Sets a pixel in the DataBuffer using an int array of samples for input.
void	setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)	Sets all samples for a rectangle of pixels from an int array containing one sample per array element.
void	setSample(int x, int y, int b, double s, DataBuffer data)	Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a double for input.
void	setSample(int x, int y, int b, float s, DataBuffer data)	Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input.
void	setSample(int x, int y, int b, int s, DataBuffer data)	Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using an int for input.
void	setSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)	Sets the samples in the specified band for the specified rectangle of pixels from an int array containing one sample per array element.

Methods declared in class ComponentSampleModel

getBandOffsets, getBankIndices, getNumDataElements, getOffset, getOffset, getPixelStride, getSampleSize, getSampleSize, getScanlineStride

Modifier and Type	Method	Description
final int[]	getBandOffsets()	Returns the band offset for all bands.
final int[]	getBankIndices()	Returns the bank indices for all bands.
final int	getNumDataElements()	Returns the number of data elements needed to transfer a pixel with the ComponentSampleModel.getDataElements(int, int, Object, DataBuffer) and ComponentSampleModel.setDataElements(int, int, Object, DataBuffer) methods.
int	getOffset(int x, int y)	Gets the offset for the first band of pixel (x,y).
int	getOffset(int x, int y, int b)	Gets the offset for band b of pixel (x,y).
final int	getPixelStride()	Returns the pixel stride of this ComponentSampleModel.
final int[]	getSampleSize()	Returns the number of bits per sample for all bands.
final int	getSampleSize(int band)	Returns the number of bits per sample for the specified band.
final int	getScanlineStride()	Returns the scanline stride of this ComponentSampleModel.

Methods declared in class SampleModel

getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSamples, setSamples

Modifier and Type	Method	Description
Object	getDataElements(int x, int y, int w, int h, Object obj, DataBuffer data)	Returns the pixel data for the specified rectangle of pixels in a primitive array of type TransferType.
final int	getDataType()	Returns the data type of the DataBuffer storing the pixel data.
final int	getHeight()	Returns the height in pixels.
final int	getNumBands()	Returns the total number of bands of image data.
double[]	getPixel(int x, int y, double[] dArray, DataBuffer data)	Returns the samples for the specified pixel in an array of double.
float[]	getPixel(int x, int y, float[] fArray, DataBuffer data)	Returns the samples for the specified pixel in an array of float.
double[]	getPixels(int x, int y, int w, int h, double[] dArray, DataBuffer data)	Returns all samples for a rectangle of pixels in a double array, one sample per array element.
float[]	getPixels(int x, int y, int w, int h, float[] fArray, DataBuffer data)	Returns all samples for a rectangle of pixels in a float array, one sample per array element.
double[]	getSamples(int x, int y, int w, int h, int b, double[] dArray, DataBuffer data)	Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element.
float[]	getSamples(int x, int y, int w, int h, int b, float[] fArray, DataBuffer data)	Returns the samples for a specified band for the specified rectangle of pixels in a float array, one sample per array element.
int	getTransferType()	Returns the TransferType used to transfer pixels via the getDataElements and setDataElements methods.
final int	getWidth()	Returns the width in pixels.
void	setDataElements(int x, int y, int w, int h, Object obj, DataBuffer data)	Sets the data for a rectangle of pixels in the specified DataBuffer from a primitive array of type TransferType.
void	setPixel(int x, int y, double[] dArray, DataBuffer data)	Sets a pixel in the DataBuffer using a double array of samples for input.
void	setPixel(int x, int y, float[] fArray, DataBuffer data)	Sets a pixel in the DataBuffer using a float array of samples for input.
void	setPixels(int x, int y, int w, int h, double[] dArray, DataBuffer data)	Sets all samples for a rectangle of pixels from a double array containing one sample per array element.
void	setPixels(int x, int y, int w, int h, float[] fArray, DataBuffer data)	Sets all samples for a rectangle of pixels from a float array containing one sample per array element.
void	setSamples(int x, int y, int w, int h, int b, double[] dArray, DataBuffer data)	Sets the samples in the specified band for the specified rectangle of pixels from a double array containing one sample per array element.
void	setSamples(int x, int y, int w, int h, int b, float[] fArray, DataBuffer data)	Sets the samples in the specified band for the specified rectangle of pixels from a float array containing one sample per array element.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

BandedSampleModel

public BandedSampleModel(int dataType,
 int w,
 int h,
 int numBands)

Constructs a BandedSampleModel with the specified parameters. The pixel stride will be one data element. The scanline stride will be the same as the width. Each band will be stored in a separate bank and all band offsets will be zero.

Parameters:

dataType - The data type for storing samples.

w - The width (in pixels) of the region of image data described.

h - The height (in pixels) of the region of image data described.

numBands - The number of bands for the image data.

Throws:

IllegalArgumentException - if w and h are not both greater than 0

IllegalArgumentException - if the product of w and h is greater than Integer.MAX_VALUE

IllegalArgumentException - if numBands is not > 0

IllegalArgumentException - if dataType is not one of the supported data types for this sample model.

BandedSampleModel

public BandedSampleModel(int dataType,
 int w,
 int h,
 int scanlineStride,
 int[] bankIndices,
 int[] bandOffsets)

Constructs a BandedSampleModel with the specified parameters. The number of bands will be inferred from the lengths of the bandOffsets bankIndices arrays, which must be equal. The pixel stride will be one data element.

Parameters:

dataType - The data type for storing samples.

w - The width (in pixels) of the region of image data described.

h - The height (in pixels) of the region of image data described.

scanlineStride - The line stride of the of the image data.

bankIndices - The bank index for each band.

bandOffsets - The band offset for each band.

Throws:

IllegalArgumentException - if w and h are not both greater than 0

IllegalArgumentException - if the product of w and h is greater than Integer.MAX_VALUE

IllegalArgumentException - if scanlineStride is less than 0

NullPointerException - if bankIndices is null

NullPointerException - if bandOffsets is null

IllegalArgumentException - if bandOffsets.length is 0

IllegalArgumentException - if the length of bankIndices does not equal the length of bandOffsets

IllegalArgumentException - if any of the bank indices of bandIndices is less than 0

IllegalArgumentException - if dataType is not one of the supported data types for this sample model

Method Details

createCompatibleSampleModel

public SampleModel createCompatibleSampleModel(int w,
 int h)

Creates a new BandedSampleModel with the specified width and height. The new BandedSampleModel will have the same number of bands, storage data type, and bank indices as this BandedSampleModel. The band offsets will be compressed such that the offset between bands will be w*pixelStride and the minimum of all of the band offsets is zero.

Overrides:

createCompatibleSampleModel in class ComponentSampleModel

Parameters:

w - the width of the resulting BandedSampleModel

h - the height of the resulting BandedSampleModel

Returns:

a new BandedSampleModel with the specified width and height.

Throws:

IllegalArgumentException - if the product of w and h is greater than Integer.MAX_VALUE or w or h is not greater than 0.

createSubsetSampleModel

public SampleModel createSubsetSampleModel(int[] bands)

Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel. The new BandedSampleModel can be used with any DataBuffer that the existing BandedSampleModel can be used with. The new BandedSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original BandedSampleModel/DataBuffer combination.

Overrides:

createSubsetSampleModel in class ComponentSampleModel

Parameters:

bands - a subset of bands from this ComponentSampleModel

Returns:

a ComponentSampleModel created with a subset of bands from this ComponentSampleModel.

Throws:

RasterFormatException - if the number of bands is greater than the number of banks in this sample model.

IllegalArgumentException - if the number of bands is not greater than 0

ArrayIndexOutOfBoundsException - if any of the bank indices is out of bounds

createDataBuffer

public DataBuffer createDataBuffer()

Creates a DataBuffer that corresponds to this BandedSampleModel, The DataBuffer's data type, number of banks, and size will be consistent with this BandedSampleModel.

Overrides:

createDataBuffer in class ComponentSampleModel

Returns:

a DataBuffer whose data type, number of banks and size are consistent with this ComponentSampleModel.

Throws:

IllegalArgumentException - if dataType is not one of the supported types.

getDataElements

public Object getDataElements(int x,
 int y,
 Object obj,
 DataBuffer data)

Returns data for a single pixel in a primitive array of type TransferType. For a BandedSampleModel, this will be the same as the data type, and samples will be returned one per array element. Generally, obj should be passed in as null, so that the Object will be created automatically and will be of the right primitive data type.

The following code illustrates transferring data for one pixel from DataBuffer db1, whose storage layout is described by BandedSampleModel bsm1, to DataBuffer db2, whose storage layout is described by BandedSampleModel bsm2. The transfer will generally be more efficient than using getPixel/setPixel.

      BandedSampleModel bsm1, bsm2;
      DataBufferInt db1, db2;
      bsm2.setDataElements(x, y, bsm1.getDataElements(x, y, null, db1),
                           db2);

Using getDataElements/setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModels have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same.

If obj is non-null, it should be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is non-null and is not large enough to hold the pixel data.

Overrides:

getDataElements in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location

y - The Y coordinate of the pixel location

obj - If non-null, a primitive array in which to return the pixel data.

data - The DataBuffer containing the image data.

Returns:

the data for the specified pixel.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if obj is too small to hold the output.

See Also:

• setDataElements(int, int, Object, DataBuffer)

getPixel

public int[] getPixel(int x,
 int y,
 int[] iArray,
 DataBuffer data)

Returns the samples for a specified pixel in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

getPixel in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location

y - The Y coordinate of the pixel location

iArray - If non-null, returns the samples in this array

data - The DataBuffer containing the image data

Returns:

the samples for the specified pixel.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if iArray is too small to hold the output.

See Also:

• SampleModel.setPixel(int, int, int[], DataBuffer)

getPixels

public int[] getPixels(int x,
 int y,
 int w,
 int h,
 int[] iArray,
 DataBuffer data)

Returns all samples for a rectangle of pixels in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

getPixels in class ComponentSampleModel

Parameters:

x - The X coordinate of the upper left pixel location.

y - The Y coordinate of the upper left pixel location.

w - The width of the pixel rectangle.

h - The height of the pixel rectangle.

iArray - If non-null, returns the samples in this array.

data - The DataBuffer containing the image data.

Returns:

the samples for the specified region of pixels.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or w or h is negative. or if iArray is too small to hold the output.

See Also:

• SampleModel.setPixels(int, int, int, int, int[], DataBuffer)

getSample

public int getSample(int x,
 int y,
 int b,
 DataBuffer data)

Returns the sample in a specified band for the pixel located at (x,y) as an int. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

getSample in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location.

y - The Y coordinate of the pixel location.

b - The band to return.

data - The DataBuffer containing the image data.

Returns:

the sample in a specified band for the specified pixel.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.

See Also:

• SampleModel.setSample(int, int, int, int, DataBuffer)

getSampleFloat

public float getSampleFloat(int x,
 int y,
 int b,
 DataBuffer data)

Returns the sample in a specified band for the pixel located at (x,y) as a float. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

getSampleFloat in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location.

y - The Y coordinate of the pixel location.

b - The band to return.

data - The DataBuffer containing the image data.

Returns:

the sample in a specified band for the specified pixel.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.

getSampleDouble

public double getSampleDouble(int x,
 int y,
 int b,
 DataBuffer data)

Returns the sample in a specified band for a pixel located at (x,y) as a double. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

getSampleDouble in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location.

y - The Y coordinate of the pixel location.

b - The band to return.

data - The DataBuffer containing the image data.

Returns:

the sample in a specified band for the specified pixel.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.

getSamples

public int[] getSamples(int x,
 int y,
 int w,
 int h,
 int b,
 int[] iArray,
 DataBuffer data)

Returns the samples for a specified band for the specified rectangle of pixels in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

getSamples in class ComponentSampleModel

Parameters:

x - The X coordinate of the upper left pixel location.

y - The Y coordinate of the upper left pixel location.

w - The width of the pixel rectangle.

h - The height of the pixel rectangle.

b - The band to return.

iArray - If non-null, returns the samples in this array.

data - The DataBuffer containing the image data.

Returns:

the samples for the specified band for the specified region of pixels.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates or band index are not in bounds, or w or h is negative, or if iArray is too small to hold the output.

See Also:

• SampleModel.setSamples(int, int, int, int, int, int[], DataBuffer)

setDataElements

public void setDataElements(int x,
 int y,
 Object obj,
 DataBuffer data)

Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType. For a BandedSampleModel, this will be the same as the data type, and samples are transferred one per array element.

The following code illustrates transferring data for one pixel from DataBuffer db1, whose storage layout is described by BandedSampleModel bsm1, to DataBuffer db2, whose storage layout is described by BandedSampleModel bsm2. The transfer will generally be more efficient than using getPixel/setPixel.

      BandedSampleModel bsm1, bsm2;
      DataBufferInt db1, db2;
      bsm2.setDataElements(x, y, bsm1.getDataElements(x, y, null, db1),
                           db2);

Using getDataElements/setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModels have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same.

obj must be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is not large enough to hold the pixel data.

Overrides:

setDataElements in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location

y - The Y coordinate of the pixel location

obj - If non-null, returns the primitive array in this object

data - The DataBuffer containing the image data

Throws:

NullPointerException - if obj or data is null.

ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if obj is too small to hold the input.

See Also:

• getDataElements(int, int, Object, DataBuffer)

setPixel

public void setPixel(int x,
 int y,
 int[] iArray,
 DataBuffer data)

Sets a pixel in the DataBuffer using an int array of samples for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

setPixel in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location.

y - The Y coordinate of the pixel location.

iArray - The input samples in an int array.

data - The DataBuffer containing the image data.

Throws:

NullPointerException - if iArray or {code data} is null.

ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if iArray is too small to hold the input.

See Also:

• SampleModel.getPixel(int, int, int[], DataBuffer)

setPixels

public void setPixels(int x,
 int y,
 int w,
 int h,
 int[] iArray,
 DataBuffer data)

Sets all samples for a rectangle of pixels from an int array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

setPixels in class ComponentSampleModel

Parameters:

x - The X coordinate of the upper left pixel location.

y - The Y coordinate of the upper left pixel location.

w - The width of the pixel rectangle.

h - The height of the pixel rectangle.

iArray - The input samples in an int array.

data - The DataBuffer containing the image data.

Throws:

NullPointerException - if iArray or data is null.

ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or w or h is negative. or if iArray is too small to hold the input.

See Also:

• SampleModel.getPixels(int, int, int, int, int[], DataBuffer)

setSample

public void setSample(int x,
 int y,
 int b,
 int s,
 DataBuffer data)

Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using an int for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

setSample in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location.

y - The Y coordinate of the pixel location.

b - The band to set.

s - The input sample as an int.

data - The DataBuffer containing the image data.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.

See Also:

• SampleModel.getSample(int, int, int, DataBuffer)

setSample

public void setSample(int x,
 int y,
 int b,
 float s,
 DataBuffer data)

Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input. The default implementation of this method casts the input float sample to an int and then calls the setSample(int, int, int, DataBuffer) method using that int value. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

setSample in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location.

y - The Y coordinate of the pixel location.

b - The band to set.

s - The input sample as a float.

data - The DataBuffer containing the image data.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.

See Also:

• SampleModel.getSample(int, int, int, DataBuffer)

setSample

public void setSample(int x,
 int y,
 int b,
 double s,
 DataBuffer data)

Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a double for input. The default implementation of this method casts the input double sample to an int and then calls the setSample(int, int, int, DataBuffer) method using that int value. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

setSample in class ComponentSampleModel

Parameters:

x - The X coordinate of the pixel location.

y - The Y coordinate of the pixel location.

b - The band to set.

s - The input sample as a double.

data - The DataBuffer containing the image data.

Throws:

NullPointerException - if data is null.

ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.

See Also:

• SampleModel.getSample(int, int, int, DataBuffer)

setSamples

public void setSamples(int x,
 int y,
 int w,
 int h,
 int b,
 int[] iArray,
 DataBuffer data)

Sets the samples in the specified band for the specified rectangle of pixels from an int array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:

setSamples in class ComponentSampleModel

Parameters:

x - The X coordinate of the upper left pixel location.

y - The Y coordinate of the upper left pixel location.

w - The width of the pixel rectangle.

h - The height of the pixel rectangle.

b - The band to set.

iArray - The input samples in an int array.

data - The DataBuffer containing the image data.

Throws:

NullPointerException - if iArray or data is null.

ArrayIndexOutOfBoundsException - if the coordinates or band index are not in bounds, or w or h is negative, or if iArray is too small to hold the input.

See Also:

• SampleModel.getSamples(int, int, int, int, int, int[], DataBuffer)