Class BandedSampleModel
public final class BandedSampleModel extends ComponentSampleModel
TYPE_BYTE, TYPE_USHORT, TYPE_SHORT, TYPE_INT, TYPE_FLOAT, and TYPE_DOUBLE datatypesField 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
| Constructor | Description |
|---|---|
BandedSampleModel |
Constructs a BandedSampleModel with the specified parameters. |
BandedSampleModel |
Constructs a BandedSampleModel with the specified parameters. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
SampleModel |
createCompatibleSampleModel |
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 |
Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel. |
Object |
getDataElements |
Returns data for a single pixel in a primitive array of type TransferType. |
int[] |
getPixel |
Returns the samples for a specified pixel in an int array, one sample per array element. |
int[] |
getPixels |
Returns all samples for a rectangle of pixels in an int array, one sample per array element. |
int |
getSample |
Returns the sample in a specified band for the pixel located at (x,y) as an int. |
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 for a specified band for the specified rectangle of pixels in an int array, one sample per array element. |
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 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 |
Gets the offset for the first band of pixel (x,y). |
int |
getOffset |
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 |
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 |
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 |
Returns the samples for the specified pixel in an array of double. |
float[] |
getPixel |
Returns the samples for the specified pixel in an array of float. |
double[] |
getPixels |
Returns all samples for a rectangle of pixels in a double array, one sample per array element. |
float[] |
getPixels |
Returns all samples for a rectangle of pixels in a float array, one sample per array element. |
double[] |
getSamples |
Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element. |
float[] |
getSamples |
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 |
Sets the data for a rectangle of pixels in the specified DataBuffer from a primitive array of type TransferType. |
void |
setPixel |
Sets a pixel in the DataBuffer using a double array of samples for input. |
void |
setPixel |
Sets a pixel in the DataBuffer using a float array of samples for input. |
void |
setPixels |
Sets all samples for a rectangle of pixels from a double array containing one sample per array element. |
void |
setPixels |
Sets all samples for a rectangle of pixels from a float array containing one sample per array element. |
void |
setSamples |
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 |
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 |
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 |
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 |
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)
- 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- ifwandhare not both greater than 0 -
IllegalArgumentException- if the product ofwandhis greater thanInteger.MAX_VALUE -
IllegalArgumentException- ifnumBandsis not > 0 -
IllegalArgumentException- ifdataTypeis 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)
- 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- ifwandhare not both greater than 0 -
IllegalArgumentException- if the product ofwandhis greater thanInteger.MAX_VALUE -
IllegalArgumentException- ifscanlineStrideis less than 0 -
NullPointerException- ifbankIndicesisnull -
NullPointerException- ifbandOffsetsisnull -
IllegalArgumentException- ifbandOffsets.lengthis 0 -
IllegalArgumentException- if the length ofbankIndicesdoes not equal the length ofbandOffsets -
IllegalArgumentException- if any of the bank indices ofbandIndicesis less than 0 -
IllegalArgumentException- ifdataTypeis not one of the supported data types for this sample model
Method Details
createCompatibleSampleModel
public SampleModel createCompatibleSampleModel(int w, int h)
- Overrides:
-
createCompatibleSampleModelin classComponentSampleModel - Parameters:
-
w- the width of the resultingBandedSampleModel -
h- the height of the resultingBandedSampleModel - Returns:
- a new
BandedSampleModelwith the specified width and height. - Throws:
-
IllegalArgumentException- if the product ofwandhis greater thanInteger.MAX_VALUEorworhis not greater than 0.
createSubsetSampleModel
public SampleModel createSubsetSampleModel(int[] bands)
- Overrides:
-
createSubsetSampleModelin classComponentSampleModel - Parameters:
-
bands- a subset of bands from thisComponentSampleModel - Returns:
- a
ComponentSampleModelcreated with a subset of bands from thisComponentSampleModel. - Throws:
-
NullPointerException- ifbandsisnull -
IllegalArgumentException- if the number of bands is not greater than 0 -
RasterFormatException- if the number of bands is greater than the number of banks in this sample model. -
ArrayIndexOutOfBoundsException- if any of the bank indices is out of bounds
createDataBuffer
public DataBuffer createDataBuffer()
- Overrides:
-
createDataBufferin classComponentSampleModel - Returns:
- a
DataBufferwhose data type, number of banks and size are consistent with thisComponentSampleModel. - Throws:
-
IllegalArgumentException- ifdataTypeis not one of the supported types.
getDataElements
public Object getDataElements(int x, int y, Object obj, DataBuffer data)
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:
-
getDataElementsin classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates are not in bounds, or ifobjis too small to hold the output. - See Also:
getPixel
public int[] getPixel(int x, int y, int[] iArray, DataBuffer data)
- Overrides:
-
getPixelin classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates are not in bounds, or ifiArrayis too small to hold the output. - See Also:
getPixels
public int[] getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
- Overrides:
-
getPixelsin classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates are not in bounds, orworhis negative. or ifiArrayis too small to hold the output. - See Also:
getSample
public int getSample(int x, int y, int b, DataBuffer data)
- Overrides:
-
getSamplein classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates or the band index are not in bounds. - See Also:
getSampleFloat
public float getSampleFloat(int x, int y, int b, DataBuffer data)
- Overrides:
-
getSampleFloatin classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates or the band index are not in bounds.
getSampleDouble
public double getSampleDouble(int x, int y, int b, DataBuffer data)
- Overrides:
-
getSampleDoublein classComponentSampleModel - 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- ifdataisnull. -
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)
- Overrides:
-
getSamplesin classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates or band index are not in bounds, orworhis negative, or ifiArrayis too small to hold the output. - See Also:
setDataElements
public void setDataElements(int x, int y, Object obj, DataBuffer data)
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:
-
setDataElementsin classComponentSampleModel - 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- ifobjordataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates are not in bounds, or ifobjis too small to hold the input. - See Also:
setPixel
public void setPixel(int x, int y, int[] iArray, DataBuffer data)
- Overrides:
-
setPixelin classComponentSampleModel - 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- ifiArrayor {code data} isnull. -
ArrayIndexOutOfBoundsException- if the coordinates are not in bounds, or ifiArrayis too small to hold the input. - See Also:
setPixels
public void setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
- Overrides:
-
setPixelsin classComponentSampleModel - 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- ifiArrayordataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates are not in bounds, orworhis negative. or ifiArrayis too small to hold the input. - See Also:
setSample
public void setSample(int x, int y, int b, int s, DataBuffer data)
- Overrides:
-
setSamplein classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates or the band index are not in bounds. - See Also:
setSample
public void setSample(int x, int y, int b, float s, DataBuffer data)
setSample(int, int, int, DataBuffer) method using that int value. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
-
setSamplein classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates or the band index are not in bounds. - See Also:
setSample
public void setSample(int x, int y, int b, double s, DataBuffer data)
setSample(int, int, int, DataBuffer) method using that int value. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
-
setSamplein classComponentSampleModel - 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- ifdataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates or the band index are not in bounds. - See Also:
setSamples
public void setSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)
- Overrides:
-
setSamplesin classComponentSampleModel - 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- ifiArrayordataisnull. -
ArrayIndexOutOfBoundsException- if the coordinates or band index are not in bounds, orworhis negative, or ifiArrayis too small to hold the input. - See Also:
© 1993, 2025, 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.