public class SinglePixelPackedSampleModel extends SampleModel
TYPE_BYTE
, TYPE_USHORT
, TYPE_INT
data types. All data array elements reside in the first bank of a DataBuffer. Accessor methods are provided so that the image data can be manipulated directly. 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. Bit masks are the masks required to extract the samples representing the bands of the pixel. Bit offsets are the offsets in bits into the data array element of the samples representing the bands of the pixel. The following code illustrates extracting the bits of the sample representing band b
for pixel x,y
from DataBuffer data
:
int sample = data.getElem(y * scanlineStride + x);
sample = (sample & bitMasks[b]) >>> bitOffsets[b];
dataType, height, numBands, width
Constructor | Description |
---|---|
SinglePixelPackedSampleModel |
Constructs a SinglePixelPackedSampleModel with bitMasks.length bands. |
SinglePixelPackedSampleModel |
Constructs a SinglePixelPackedSampleModel with bitMasks.length bands and a scanline stride equal to scanlineStride data array elements. |
Modifier and Type | Method | Description |
---|---|---|
SampleModel |
createCompatibleSampleModel |
Creates a new SinglePixelPackedSampleModel with the specified width and height. |
DataBuffer |
createDataBuffer() |
Creates a DataBuffer that corresponds to this SinglePixelPackedSampleModel. |
SampleModel |
createSubsetSampleModel |
This creates a new SinglePixelPackedSampleModel with a subset of the bands of this SinglePixelPackedSampleModel. |
int[] |
getBitMasks() |
Returns the bit masks for all bands. |
int[] |
getBitOffsets() |
Returns the bit offsets into the data array element representing a pixel for all bands. |
Object |
getDataElements |
Returns data for a single pixel in a primitive array of type TransferType. |
int |
getNumDataElements() |
Returns the number of data elements needed to transfer one pixel via the getDataElements and setDataElements methods. |
int |
getOffset |
Returns the offset (in data array elements) of pixel (x,y). |
int[] |
getPixel |
Returns all samples in for the specified pixel in an int array. |
int[] |
getPixels |
Returns all samples for the specified rectangle of pixels in an int array, one sample per array element. |
int |
getSample |
Returns as int the sample in a specified band for the pixel located at (x,y). |
int[] |
getSamples |
Returns the samples for a specified band for the specified rectangle of pixels in an int array, one sample per array element. |
int[] |
getSampleSize() |
Returns the number of bits per sample for all bands. |
int |
getSampleSize |
Returns the number of bits per sample for the specified band. |
int |
getScanlineStride() |
Returns the scanline stride of this SinglePixelPackedSampleModel. |
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 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. |
getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSampleDouble, getSampleFloat, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSample, setSample, setSamples, setSamples
public SinglePixelPackedSampleModel(int dataType, int w, int h, int[] bitMasks)
dataType
- The data type for storing samples.w
- The width (in pixels) of the region of the image data described.h
- The height (in pixels) of the region of the image data described.bitMasks
- The bit masks for all bands.IllegalArgumentException
- if dataType
is not either DataBuffer.TYPE_BYTE
, DataBuffer.TYPE_USHORT
, or DataBuffer.TYPE_INT
public SinglePixelPackedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bitMasks)
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 image data.bitMasks
- The bit masks for all bands.IllegalArgumentException
- if w
or h
is not greater than 0IllegalArgumentException
- if any mask in bitMask
is not contiguousIllegalArgumentException
- if dataType
is not either DataBuffer.TYPE_BYTE
, DataBuffer.TYPE_USHORT
, or DataBuffer.TYPE_INT
public int getNumDataElements()
getNumDataElements
in class SampleModel
public SampleModel createCompatibleSampleModel(int w, int h)
createCompatibleSampleModel
in class SampleModel
w
- the width of the resulting SampleModel
h
- the height of the resulting SampleModel
SinglePixelPackedSampleModel
with the specified width and height.IllegalArgumentException
- if w
or h
is not greater than 0public DataBuffer createDataBuffer()
createDataBuffer
in class SampleModel
DataBuffer
corresponding to this SampleModel
.public int[] getSampleSize()
getSampleSize
in class SampleModel
public int getSampleSize(int band)
getSampleSize
in class SampleModel
band
- the specified bandpublic int getOffset(int x, int y)
x,y
can be retrieved from a DataBuffer data
with a SinglePixelPackedSampleModel sppsm
as: data.getElem(sppsm.getOffset(x, y));
x
- the X coordinate of the specified pixely
- the Y coordinate of the specified pixelpublic int[] getBitOffsets()
public int[] getBitMasks()
public int getScanlineStride()
SinglePixelPackedSampleModel
.public SampleModel createSubsetSampleModel(int[] bands)
createSubsetSampleModel
in class SampleModel
bands
- the subset of bands of this SampleModel
SampleModel
with a subset of bands of this SampleModel
.RasterFormatException
- if the length of the bands argument is greater than the number of bands in the sample model.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 SinglePixelPackedSampleModel sppsm1
, to DataBuffer db2
, whose storage layout is described by SinglePixelPackedSampleModel sppsm2
. The transfer will generally be more efficient than using getPixel/setPixel.
SinglePixelPackedSampleModel sppsm1, sppsm2; DataBufferInt db1, db2; sppsm2.setDataElements(x, y, sppsm1.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.
getDataElements
in class SampleModel
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.public int[] getPixel(int x, int y, int[] iArray, DataBuffer data)
getPixel
in class SampleModel
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 arraydata
- The DataBuffer containing the image data.public int[] getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
getPixels
in class SampleModel
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.public int getSample(int x, int y, int b, DataBuffer data)
getSample
in class SampleModel
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.public int[] getSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)
getSamples
in class SampleModel
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.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 SinglePixelPackedSampleModel sppsm1
, to DataBuffer db2
, whose storage layout is described by SinglePixelPackedSampleModel sppsm2
. The transfer will generally be more efficient than using getPixel/setPixel.
SinglePixelPackedSampleModel sppsm1, sppsm2; DataBufferInt db1, db2; sppsm2.setDataElements(x, y, sppsm1.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.
setDataElements
in class SampleModel
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.public void setPixel(int x, int y, int[] iArray, DataBuffer data)
setPixel
in class SampleModel
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.public void setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
setPixels
in class SampleModel
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.public void setSample(int x, int y, int b, int s, DataBuffer data)
setSample
in class SampleModel
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.public void setSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)
setSamples
in class SampleModel
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.
© 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/SinglePixelPackedSampleModel.html