java.lang.Object | |
↳ | java.awt.image.SampleModel |
Known Direct Subclasses |
Known Indirect Subclasses |
This abstract class defines an interface for extracting samples of pixels in an image. All image data is expressed as a collection of pixels. Each pixel consists of a number of samples. A sample is a datum for one band of an image and a band consists of all samples of a particular type in an image. For example, a pixel might contain three samples representing its red, green and blue components. There are three bands in the image containing this pixel. One band consists of all the red samples from all pixels in the image. The second band consists of all the green samples and the remaining band consists of all of the blue samples. The pixel can be stored in various formats. For example, all samples from a particular band can be stored contiguously or all samples from a single pixel can be stored contiguously.
Subclasses of SampleModel specify the types of samples they can represent (e.g. unsigned 8-bit byte, signed 16-bit short, etc.) and may specify how the samples are organized in memory. In the Java 2D(tm) API, built-in image processing operators may not operate on all possible sample types, but generally will work for unsigned integral samples of 16 bits or less. Some operators support a wider variety of sample types.
A collection of pixels is represented as a Raster, which consists of a DataBuffer and a SampleModel. The SampleModel allows access to samples in the DataBuffer and may provide low-level information that a programmer can use to directly manipulate samples and pixels in the DataBuffer.
This class is generally a fall back method for dealing with images. More efficient code will cast the SampleModel to the appropriate subclass and extract the information needed to directly manipulate pixels in the DataBuffer.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
dataType | Data type of the DataBuffer storing the pixel data. | ||||||||||
height | Height in pixels of the region of image data that this SampleModel describes. | ||||||||||
numBands | Number of bands of the image data that this SampleModel describes. | ||||||||||
width | Width in pixels of the region of image data that this SampleModel describes. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a SampleModel with the specified parameters.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a SampleModel which describes data in this SampleModel's
format, but with a different width and height.
| |||||||||||
Creates a DataBuffer that corresponds to this SampleModel.
| |||||||||||
Creates a new SampleModel
with a subset of the bands of this
SampleModel.
| |||||||||||
Returns data for a single pixel in a primitive array of type
TransferType.
| |||||||||||
Returns the pixel data for the specified rectangle of pixels in a
primitive array of type TransferType.
| |||||||||||
Returns the data type of the DataBuffer storing the pixel data.
| |||||||||||
Returns the height in pixels.
| |||||||||||
Returns the total number of bands of image data.
| |||||||||||
Returns the number of data elements needed to transfer a pixel
via the getDataElements and setDataElements methods.
| |||||||||||
Returns the samples for the specified pixel in an array of float.
| |||||||||||
Returns the samples for the specified pixel in an array of double.
| |||||||||||
Returns the samples for a specified pixel in an int array,
one sample per array element.
| |||||||||||
Returns all samples for a rectangle of pixels in an
int array, one sample per array element.
| |||||||||||
Returns all samples for a rectangle of pixels in a float
array, one sample per array element.
| |||||||||||
Returns all samples for a rectangle of pixels in a double
array, one sample per array element.
| |||||||||||
Returns the sample in a specified band for the pixel located
at (x,y) as an int.
| |||||||||||
Returns the sample in a specified band
for a pixel located at (x,y) as a double.
| |||||||||||
Returns the sample in a specified band
for the pixel located at (x,y) as a float.
| |||||||||||
Returns the size in bits of samples for the specified band.
| |||||||||||
Returns the size in bits of samples for all bands.
| |||||||||||
Returns the samples for a specified band for a specified rectangle
of pixels in a double array, one sample per array element.
| |||||||||||
Returns the samples for a specified band for the specified rectangle
of pixels in a float array, one sample per array element.
| |||||||||||
Returns the samples for a specified band for the specified rectangle
of pixels in an int array, one sample per array element.
| |||||||||||
Returns the TransferType used to transfer pixels via the
getDataElements and setDataElements methods.
| |||||||||||
Returns the width in pixels.
| |||||||||||
Sets the data for a single pixel in the specified DataBuffer from a
primitive array of type TransferType.
| |||||||||||
Sets the data for a rectangle of pixels in the specified DataBuffer
from a primitive array of type TransferType.
| |||||||||||
Sets a pixel in the DataBuffer using an int array of samples for input.
| |||||||||||
Sets a pixel in the DataBuffer using a float array of samples for input.
| |||||||||||
Sets a pixel in the DataBuffer using a double array of samples
for input.
| |||||||||||
Sets all samples for a rectangle of pixels from a float array containing
one sample per array element.
| |||||||||||
Sets all samples for a rectangle of pixels from an int array containing
one sample per array element.
| |||||||||||
Sets all samples for a rectangle of pixels from a double array
containing one sample per array element.
| |||||||||||
Sets a sample in the specified band for the pixel located at (x,y)
in the DataBuffer using an int for input.
| |||||||||||
Sets a sample in the specified band for the pixel located at (x,y)
in the DataBuffer using a double for input.
| |||||||||||
Sets a sample in the specified band for the pixel located at (x,y)
in the DataBuffer using a float for input.
| |||||||||||
Sets the samples in the specified band for the specified rectangle
of pixels from an int array containing one sample per array element.
| |||||||||||
Sets the samples in the specified band for the specified rectangle
of pixels from a double array containing one sample per array element.
| |||||||||||
Sets the samples in the specified band for the specified rectangle
of pixels from a float array containing one sample per array element.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Height in pixels of the region of image data that this SampleModel describes.
Number of bands of the image data that this SampleModel describes.
Width in pixels of the region of image data that this SampleModel describes.
Constructs a SampleModel with the specified parameters.
dataType | The data type of the DataBuffer storing the pixel data. |
---|---|
w | The width (in pixels) of the region of image data. |
h | The height (in pixels) of the region of image data. |
numBands | The number of bands of the image data. |
IllegalArgumentException | if w or h
is not greater than 0 |
---|---|
IllegalArgumentException | if the product of w
and h is greater than
Integer.MAX_VALUE |
IllegalArgumentException | if dataType is not
one of the supported data types
|
Creates a SampleModel which describes data in this SampleModel's format, but with a different width and height.
w | the width of the image data |
---|---|
h | the height of the image data |
SampleModel
describing the same image
data as this SampleModel
, but with a
different size.
Creates a DataBuffer that corresponds to this SampleModel. The DataBuffer's width and height will match this SampleModel's.
DataBuffer
corresponding to this
SampleModel
.
Creates a new SampleModel with a subset of the bands of this SampleModel.
bands | the subset of bands of this SampleModel |
---|
SampleModel
with a subset of bands of this
SampleModel
.
Returns data for a single pixel in a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data may be returned in a packed format, thus increasing efficiency for data transfers. 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
SampleModel sm1
, to DataBuffer db2
, whose
storage layout is described by SampleModel sm2
.
The transfer will generally be more efficient than using
getPixel/setPixel.
SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, sm1.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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if obj is too small to hold the output. |
Returns the pixel data for the specified rectangle of pixels in a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data may be returned in a packed format, thus increasing efficiency for data transfers. 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 a rectangular
region of pixels from
DataBuffer db1
, whose storage layout is described by
SampleModel sm1
, to DataBuffer db2
, whose
storage layout is described by SampleModel sm2
.
The transfer will generally be more efficient than using
getPixels/setPixels.
SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w, h, 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.
x | The minimum X coordinate of the pixel rectangle. |
---|---|
y | The minimum Y coordinate of the pixel rectangle. |
w | The width of the pixel rectangle. |
h | The height of the pixel rectangle. |
obj | If non-null, a primitive array in which to return the pixel data. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if obj is too small to hold the output. |
Returns the data type of the DataBuffer storing the pixel data.
Returns the height in pixels.
SampleModel
describes.
Returns the total number of bands of image data.
SampleModel
describes.
Returns the number of data elements needed to transfer a pixel via the getDataElements and setDataElements methods. When pixels are transferred via these methods, they may be transferred in a packed or unpacked format, depending on the implementation of the SampleModel. Using these methods, pixels are transferred as an array of getNumDataElements() elements of a primitive type given by getTransferType(). The TransferType may or may not be the same as the storage DataType.
Returns the samples for the specified pixel in an array of float. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
x | The X coordinate of the pixel location. |
---|---|
y | The Y coordinate of the pixel location. |
fArray | If non-null, returns the samples in this array. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if fArray is too small to hold the output. |
Returns the samples for the specified pixel in an array of double. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
x | The X coordinate of the pixel location. |
---|---|
y | The Y coordinate of the pixel location. |
dArray | If non-null, returns the samples in this array. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if dArray is too small to hold the output. |
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.
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 |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if iArray is too small to hold the output. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if iArray is too small to hold the output. |
Returns all samples for a rectangle of pixels in a float array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
fArray | If non-null, returns the samples in this array. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if fArray is too small to hold the output. |
Returns all samples for a rectangle of pixels in a double array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
dArray | If non-null, returns the samples in this array. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if dArray is too small to hold the output. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
Returns the size in bits of samples for the specified band.
band | the specified band |
---|
Returns the size in bits of samples for all bands.
Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
dArray | If non-null, returns the samples in this array. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if dArray is too small to hold the output. |
Returns the samples for a specified band for the specified rectangle of pixels in a float array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
fArray | If non-null, returns the samples in this array. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if fArray is too small to hold the output. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if iArray is too small to hold the output. |
Returns the TransferType used to transfer pixels via the getDataElements and setDataElements methods. When pixels are transferred via these methods, they may be transferred in a packed or unpacked format, depending on the implementation of the SampleModel. Using these methods, pixels are transferred as an array of getNumDataElements() elements of a primitive type given by getTransferType(). The TransferType may or may not be the same as the storage DataType. The TransferType will be one of the types defined in DataBuffer.
Returns the width in pixels.
SampleModel
describes.
Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data in the array may be in a packed format, thus increasing efficiency for data transfers.
The following code illustrates transferring data for one pixel from
DataBuffer db1
, whose storage layout is described by
SampleModel sm1
, to DataBuffer db2
, whose
storage layout is described by SampleModel sm2
.
The transfer will generally be more efficient than using
getPixel/setPixel.
SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, sm1.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.
x | The X coordinate of the pixel location. |
---|---|
y | The Y coordinate of the pixel location. |
obj | A primitive array containing pixel data. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if obj is too small to hold the input. |
Sets the data for a rectangle of pixels in the specified DataBuffer from a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data in the array may be in a packed format, thus increasing efficiency for data transfers.
The following code illustrates transferring data for a rectangular
region of pixels from
DataBuffer db1
, whose storage layout is described by
SampleModel sm1
, to DataBuffer db2
, whose
storage layout is described by SampleModel sm2
.
The transfer will generally be more efficient than using
getPixels/setPixels.
SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w, h, 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.
x | The minimum X coordinate of the pixel rectangle. |
---|---|
y | The minimum Y coordinate of the pixel rectangle. |
w | The width of the pixel rectangle. |
h | The height of the pixel rectangle. |
obj | A primitive array containing pixel data. |
data | The DataBuffer containing the image data. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if obj is too small to hold the input. |
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.
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. |
NullPointerException | if iArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if iArray is too small to hold the input. |
Sets a pixel in the DataBuffer using a float array of samples for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
x | The X coordinate of the pixel location. |
---|---|
y | The Y coordinate of the pixel location. |
fArray | The input samples in a float array. |
data | The DataBuffer containing the image data. |
NullPointerException | if fArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if fArray is too small to hold the input. |
Sets a pixel in the DataBuffer using a double array of samples for input.
x | The X coordinate of the pixel location. |
---|---|
y | The Y coordinate of the pixel location. |
dArray | The input samples in a double array. |
data | The DataBuffer containing the image data. |
NullPointerException | if dArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if fArray is too small to hold the input. |
Sets all samples for a rectangle of pixels from a float array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
fArray | The input samples in a float array. |
data | The DataBuffer containing the image data. |
NullPointerException | if fArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if fArray is too small to hold the input. |
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.
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. |
NullPointerException | if iArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if iArray is too small to hold the input. |
Sets all samples for a rectangle of pixels from a double array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
dArray | The input samples in a double array. |
data | The DataBuffer containing the image data. |
NullPointerException | if dArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if dArray is too small to hold the input. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
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.
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. |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
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.
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. |
NullPointerException | if iArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if iArray is too small to hold the input. |
Sets the samples in the specified band for the specified rectangle of pixels from a double array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
dArray | The input samples in a double array. |
data | The DataBuffer containing the image data. |
NullPointerException | if dArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if dArray is too small to hold the input. |
Sets the samples in the specified band for the specified rectangle of pixels from a float array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
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. |
fArray | The input samples in a float array. |
data | The DataBuffer containing the image data. |
NullPointerException | if fArray or data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if fArray is too small to hold the input. |