BandedSampleModel
, PixelInterleavedSampleModel
public class ComponentSampleModel extends SampleModel
DataBuffer.TYPE_BYTE
, DataBuffer.TYPE_USHORT
, or DataBuffer.TYPE_INT
, respectively), data for which each sample is a signed integral number which can be stored in 16 bits (using DataBuffer.TYPE_SHORT
), or data for which each sample is a signed float or double quantity (using DataBuffer.TYPE_FLOAT
or DataBuffer.TYPE_DOUBLE
, respectively). All samples of a given ComponentSampleModel are stored with the same precision. All strides and offsets must be non-negative. This class supports TYPE_BYTE
, TYPE_USHORT
, TYPE_SHORT
, TYPE_INT
, TYPE_FLOAT
, TYPE_DOUBLE
,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. |
dataType, height, width
Constructor | Description |
---|---|
ComponentSampleModel |
Constructs a ComponentSampleModel with the specified parameters. |
ComponentSampleModel |
Constructs a ComponentSampleModel with the specified parameters. |
Modifier and Type | Method | Description |
---|---|---|
SampleModel |
createCompatibleSampleModel |
Creates a new ComponentSampleModel with the specified width and height. |
DataBuffer |
createDataBuffer() |
Creates a DataBuffer that corresponds to this ComponentSampleModel . |
SampleModel |
createSubsetSampleModel |
Creates a new ComponentSampleModel with a subset of the bands of this ComponentSampleModel. |
final int[] |
getBandOffsets() |
Returns the band offset for all bands. |
final int[] |
getBankIndices() |
Returns the bank indices for all bands. |
Object |
getDataElements |
Returns data for a single pixel in a primitive array of type TransferType . |
final int |
getNumDataElements() |
Returns the number of data elements needed to transfer a pixel with the getDataElements(int, int, Object, DataBuffer) and setDataElements(int, int, Object, DataBuffer) methods. |
int |
getOffset |
Gets the offset for the first band of pixel (x,y). |
int |
getOffset |
Gets the offset for band b of pixel (x,y). |
int[] |
getPixel |
Returns all samples for the specified pixel in an int array, one sample per array element. |
int[] |
getPixels |
Returns all samples for the specified rectangle of pixels in an int array, one sample per array element. |
final int |
getPixelStride() |
Returns the pixel stride of this ComponentSampleModel. |
int |
getSample |
Returns as int the sample in a specified band for the pixel located at (x,y). |
double |
getSampleDouble |
Returns the sample in a specified band for a pixel located at (x,y) as a double. |
float |
getSampleFloat |
Returns the sample in a specified band for the pixel located at (x,y) as a float. |
int[] |
getSamples |
Returns the samples in a specified band for the specified rectangle of pixels in an int array, one sample per data array element. |
final int[] |
getSampleSize() |
Returns the number of bits per sample for all bands. |
final int |
getSampleSize |
Returns the number of bits per sample for the specified band. |
final int |
getScanlineStride() |
Returns the scanline stride of this ComponentSampleModel. |
void |
setDataElements |
Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType . |
void |
setPixel |
Sets a pixel in the DataBuffer using an int array of samples for input. |
void |
setPixels |
Sets all samples for a rectangle of pixels from an int array containing one sample per array element. |
void |
setSample |
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a double for input. |
void |
setSample |
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input. |
void |
setSample |
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using an int for input. |
void |
setSamples |
Sets the samples in the specified band for the specified rectangle of pixels from an int array containing one sample per data array element. |
getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSamples, setSamples
protected int[] bandOffsets
protected int[] bankIndices
protected int numBands
ComponentSampleModel
.protected int numBanks
ComponentSampleModel
.protected int scanlineStride
protected int pixelStride
public ComponentSampleModel(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bandOffsets)
dataType
- the data type for storing samplesw
- the width (in pixels) of the region of image data describedh
- the height (in pixels) of the region of image data describedpixelStride
- the pixel stride of the region of image data describedscanlineStride
- the line stride of the region of image data describedbandOffsets
- the offsets of all bandsIllegalArgumentException
- if w
and h
are not both greater than 0IllegalArgumentException
- if the product of w
and h
is greater than Integer.MAX_VALUE
IllegalArgumentException
- if pixelStride
is less than 0IllegalArgumentException
- if scanlineStride
is less than 0NullPointerException
- if bandOffsets
is null
IllegalArgumentException
- if bandOffsets.length
is 0IllegalArgumentException
- if dataType
is not one of the supported data types for this sample model.public ComponentSampleModel(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bankIndices, int[] bandOffsets)
dataType
- the data type for storing samplesw
- the width (in pixels) of the region of image data describedh
- the height (in pixels) of the region of image data describedpixelStride
- the pixel stride of the region of image data describedscanlineStride
- The line stride of the region of image data describedbankIndices
- the bank indices of all bandsbandOffsets
- the band offsets of all bandsIllegalArgumentException
- if w
and h
are not both greater than 0IllegalArgumentException
- if the product of w
and h
is greater than Integer.MAX_VALUE
IllegalArgumentException
- if pixelStride
is less than 0IllegalArgumentException
- if scanlineStride
is less than 0NullPointerException
- if bankIndices
is null
NullPointerException
- if bandOffsets
is null
IllegalArgumentException
- if bandOffsets.length
is 0IllegalArgumentException
- if the length of bankIndices
does not equal the length of bandOffsets
IllegalArgumentException
- if any of the bank indices of bandIndices
is less than 0IllegalArgumentException
- if dataType
is not one of the supported data types for this sample modelpublic SampleModel createCompatibleSampleModel(int w, int h)
ComponentSampleModel
with the specified width and height. The new SampleModel
will have the same number of bands, storage data type, interleaving scheme, and pixel stride as this SampleModel
.createCompatibleSampleModel
in class SampleModel
w
- the width of the resulting SampleModel
h
- the height of the resulting SampleModel
ComponentSampleModel
with the specified sizeIllegalArgumentException
- if w
or h
is not greater than 0public SampleModel createSubsetSampleModel(int[] bands)
createSubsetSampleModel
in class SampleModel
bands
- a subset of bands from this ComponentSampleModel
ComponentSampleModel
created with a subset of bands from this ComponentSampleModel
.public DataBuffer createDataBuffer()
DataBuffer
that corresponds to this ComponentSampleModel
. The DataBuffer
object's data type, number of banks, and size are be consistent with this ComponentSampleModel
.createDataBuffer
in class SampleModel
DataBuffer
whose data type, number of banks and size are consistent with this ComponentSampleModel
.public int getOffset(int x, int y)
DataBuffer
data
with a ComponentSampleModel
csm
as data.getElem(csm.getOffset(x, y));
x
- the X location of the pixely
- the Y location of the pixelpublic int getOffset(int x, int y, int b)
b
can be retrieved from a DataBuffer data
with a ComponentSampleModel csm
as data.getElem(csm.getOffset(x, y, b));
x
- the X location of the specified pixely
- the Y location of the specified pixelb
- the specified bandpublic final int[] getSampleSize()
getSampleSize
in class SampleModel
public final int getSampleSize(int band)
getSampleSize
in class SampleModel
band
- the specified bandpublic final int[] getBankIndices()
public final int[] getBandOffsets()
public final int getScanlineStride()
ComponentSampleModel
.public final int getPixelStride()
ComponentSampleModel
.public final int getNumDataElements()
getDataElements(int, int, Object, DataBuffer)
and setDataElements(int, int, Object, DataBuffer)
methods. For a ComponentSampleModel
, this is identical to the number of bands.getNumDataElements
in class SampleModel
getDataElements
and setDataElements
methods.public Object getDataElements(int x, int y, Object obj, DataBuffer data)
TransferType
. For a ComponentSampleModel
, this is the same as the data type, and samples are returned one per array element. Generally, obj
should be passed in as null
, so that the Object
is created automatically and is the right primitive data type. The following code illustrates transferring data for one pixel from DataBuffer db1
, whose storage layout is described by ComponentSampleModel csm1
, to DataBuffer db2
, whose storage layout is described by ComponentSampleModel csm2
. The transfer is usually more efficient than using getPixel
and setPixel
.
ComponentSampleModel csm1, csm2; DataBufferInt db1, db2; csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1), db2);Using
getDataElements
and setDataElements
to transfer between two DataBuffer/SampleModel
pairs is legitimate if the SampleModel
objects have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferType
s are the same. If obj
is not null
, it should be a primitive array of type TransferType
. Otherwise, a ClassCastException
is thrown. An ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds, or if obj
is not null
and is not large enough to hold the pixel data.
getDataElements
in class SampleModel
x
- the X coordinate of the pixel locationy
- the Y coordinate of the pixel locationobj
- if non-null
, a primitive array in which to return the pixel datadata
- the DataBuffer
containing the image dataNullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if obj is too small to hold the output.public int[] getPixel(int x, int y, int[] iArray, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.getPixel
in class SampleModel
x
- the X coordinate of the pixel locationy
- the Y coordinate of the pixel locationiArray
- If non-null, returns the samples in this arraydata
- The DataBuffer containing the image dataNullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if iArray is too small to hold the output.public int[] getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.getPixels
in class SampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- The width of the pixel rectangleh
- The height of the pixel rectangleiArray
- If non-null, returns the samples in this arraydata
- The DataBuffer containing the image datapublic int getSample(int x, int y, int b, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.getSample
in class SampleModel
x
- the X coordinate of the pixel locationy
- the Y coordinate of the pixel locationb
- the band to returndata
- the DataBuffer
containing the image datapublic float getSampleFloat(int x, int y, int b, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.getSampleFloat
in class SampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to returndata
- The DataBuffer containing the image datapublic double getSampleDouble(int x, int y, int b, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.getSampleDouble
in class SampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to returndata
- The DataBuffer containing the image datapublic int[] getSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.getSamples
in class SampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- the width of the pixel rectangleh
- the height of the pixel rectangleb
- the band to returniArray
- if non-null
, returns the samples in this arraydata
- the DataBuffer
containing the image datapublic void setDataElements(int x, int y, Object obj, DataBuffer data)
DataBuffer
from a primitive array of type TransferType
. For a ComponentSampleModel
, this is 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 ComponentSampleModel csm1
, to DataBuffer db2
, whose storage layout is described by ComponentSampleModel csm2
. The transfer is usually more efficient than using getPixel
and setPixel
.
ComponentSampleModel csm1, csm2; DataBufferInt db1, db2; csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1), db2);Using
getDataElements
and setDataElements
to transfer between two DataBuffer/SampleModel
pairs is legitimate if the SampleModel
objects have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferType
s are the same. A ClassCastException
is thrown if obj
is not a primitive array of type TransferType
. An ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds, or if obj
is not large enough to hold the pixel data.
setDataElements
in class SampleModel
x
- the X coordinate of the pixel locationy
- the Y coordinate of the pixel locationobj
- a primitive array containing pixel datadata
- the DataBuffer containing the image datapublic void setPixel(int x, int y, int[] iArray, DataBuffer data)
DataBuffer
using an int array of samples for input. An ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.setPixel
in class SampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationiArray
- The input samples in an int arraydata
- The DataBuffer containing the image datapublic void setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.setPixels
in class SampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- The width of the pixel rectangleh
- The height of the pixel rectangleiArray
- The input samples in an int arraydata
- The DataBuffer containing the image datapublic void setSample(int x, int y, int b, int s, DataBuffer data)
DataBuffer
using an int for input. An ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.setSample
in class SampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- the band to sets
- the input sample as an intdata
- the DataBuffer containing the image datapublic void setSample(int x, int y, int b, float s, DataBuffer data)
DataBuffer
using a float for input. An ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.setSample
in class SampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to sets
- The input sample as a floatdata
- The DataBuffer containing the image datapublic void setSample(int x, int y, int b, double s, DataBuffer data)
DataBuffer
using a double for input. An ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.setSample
in class SampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to sets
- The input sample as a doubledata
- The DataBuffer containing the image datapublic void setSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)
ArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.setSamples
in class SampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- The width of the pixel rectangleh
- The height of the pixel rectangleb
- The band to setiArray
- The input samples in an int arraydata
- The DataBuffer containing the image data
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/image/ComponentSampleModel.html