Class SinglePixelPackedSampleModel

java.lang.Object

java.awt.image.SampleModel

java.awt.image.SinglePixelPackedSampleModel

public class SinglePixelPackedSampleModel extends SampleModel

This class represents pixel data packed such that the N samples which make up a single pixel are stored in a single data array element, and each data data array element holds samples for only one pixel. This class supports 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];

Field Summary

Fields declared in class SampleModel

dataType, height, numBands, 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`	`numBands`	Number of bands of the 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
`SinglePixelPackedSampleModel(int dataType, int w, int h, int[] bitMasks)`	Constructs a SinglePixelPackedSampleModel with bitMasks.length bands.
`SinglePixelPackedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bitMasks)`	Constructs a SinglePixelPackedSampleModel with bitMasks.length bands and a scanline stride equal to scanlineStride data array elements.

Method Summary

Modifier and Type	Method	Description
`SampleModel`	`createCompatibleSampleModel(int w, int h)`	Creates a new SinglePixelPackedSampleModel with the specified width and height.
`DataBuffer`	`createDataBuffer()`	Creates a DataBuffer that corresponds to this SinglePixelPackedSampleModel.
`SampleModel`	`createSubsetSampleModel(int[] bands)`	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(int x, int y, Object obj, DataBuffer data)`	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(int x, int y)`	Returns the offset (in data array elements) of pixel (x,y).
`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.
`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.
`int[]`	`getSampleSize()`	Returns the number of bits per sample for all bands.
`int`	`getSampleSize(int band)`	Returns the number of bits per sample for the specified band.
`int`	`getScanlineStride()`	Returns the scanline stride of this SinglePixelPackedSampleModel.
`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, 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 SampleModel

getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSampleDouble, getSampleFloat, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSample, setSample, 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`	`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.
`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`	`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`	`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

SinglePixelPackedSampleModel

public SinglePixelPackedSampleModel(int dataType, int w, int h, int[] bitMasks)

Constructs a SinglePixelPackedSampleModel with bitMasks.length bands. Each sample is stored in a data array element in the position of its corresponding bit mask. Each bit mask must be contiguous and masks must not overlap. Bit masks exceeding data type capacity are truncated.

Parameters:: 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.
Throws:: IllegalArgumentException - if dataType is not either DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT

SinglePixelPackedSampleModel

public SinglePixelPackedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bitMasks)

Constructs a SinglePixelPackedSampleModel with bitMasks.length bands and a scanline stride equal to scanlineStride data array elements. Each sample is stored in a data array element in the position of its corresponding bit mask. Each bit mask must be contiguous and masks must not overlap. Bit masks exceeding data type capacity are truncated.

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 image data.; bitMasks - The bit masks for all bands.
Throws:: IllegalArgumentException - if w or h is not greater than 0; IllegalArgumentException - if any mask in bitMask is not contiguous; IllegalArgumentException - if dataType is not either DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT

Method Details

getNumDataElements

public int getNumDataElements()

Returns the number of data elements needed to transfer one pixel via the getDataElements and setDataElements methods. For a SinglePixelPackedSampleModel, this is one.

Specified by:

getNumDataElements in class SampleModel

Returns:

the number of data elements.

See Also:

createCompatibleSampleModel

public SampleModel createCompatibleSampleModel(int w, int h)

Creates a new SinglePixelPackedSampleModel with the specified width and height. The new SinglePixelPackedSampleModel will have the same storage data type and bit masks as this SinglePixelPackedSampleModel.

Specified by:: createCompatibleSampleModel in class SampleModel
Parameters:: w - the width of the resulting SampleModel; h - the height of the resulting SampleModel
Returns:: a SinglePixelPackedSampleModel with the specified width and height.
Throws:: IllegalArgumentException - if w or h is not greater than 0

createDataBuffer

public DataBuffer createDataBuffer()

Creates a DataBuffer that corresponds to this SinglePixelPackedSampleModel. The DataBuffer's data type and size will be consistent with this SinglePixelPackedSampleModel. The DataBuffer will have a single bank.

Specified by:: createDataBuffer in class SampleModel
Returns:: a DataBuffer corresponding to this SampleModel.

getSampleSize

public int[] getSampleSize()

Returns the number of bits per sample for all bands.

Specified by:: getSampleSize in class SampleModel
Returns:: the size of samples for all bands.

getSampleSize

public int getSampleSize(int band)

Returns the number of bits per sample for the specified band.

Specified by:: getSampleSize in class SampleModel
Parameters:: band - the specified band
Returns:: the size of the samples of the specified band.
Throws:: ArrayIndexOutOfBoundsException - if the band index is less than zero or greater than or equal to getNumBands()

getOffset

public int getOffset(int x, int y)

Returns the offset (in data array elements) of pixel (x,y). The data element containing pixel x,y can be retrieved from a DataBuffer data with a SinglePixelPackedSampleModel sppsm as:

        data.getElem(sppsm.getOffset(x, y));

Parameters:: x - the X coordinate of the specified pixel; y - the Y coordinate of the specified pixel
Returns:: the offset of the specified pixel.

getBitOffsets

public int[] getBitOffsets()

Returns the bit offsets into the data array element representing a pixel for all bands.

Returns:: the bit offsets representing a pixel for all bands.

getBitMasks

public int[] getBitMasks()

Returns the bit masks for all bands.

Returns:: the bit masks for all bands.

getScanlineStride

public int getScanlineStride()

Returns the scanline stride of this SinglePixelPackedSampleModel.

Returns:: the scanline stride of this SinglePixelPackedSampleModel.

createSubsetSampleModel

public SampleModel createSubsetSampleModel(int[] bands)

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

Specified by:: createSubsetSampleModel in class SampleModel
Parameters:: bands - the subset of bands of this SampleModel
Returns:: a SampleModel with a subset of bands of this SampleModel.
Throws:: NullPointerException - if bands is null; IllegalArgumentException - if the number of bands is not greater than 0; RasterFormatException - if the length of the bands argument is greater than the number of bands in the sample model.; ArrayIndexOutOfBoundsException - if any of the bank indices is out of bounds

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 SinglePixelPackedSampleModel, the array will have one element, and the type will be the same as the storage data type. 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 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.

Specified by:

getDataElements in class SampleModel

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:

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 SampleModel

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:

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 SampleModel

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:

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.

Specified by:

getSample in class SampleModel

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:

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 SampleModel

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:

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 SinglePixelPackedSampleModel, only the first element of the array will hold valid data, and the type of the array must be the same as the storage data type of the SinglePixelPackedSampleModel.

      SinglePixelPackedSampleModel sppsm1, sppsm2;
      DataBufferInt db1, db2;
      sppsm2.setDataElements(x, y, sppsm1.getDataElements(x, y, null,
                             db1), db2);

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.

Specified by:

setDataElements in class SampleModel

Parameters:

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.

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:

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 SampleModel

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:

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 SampleModel

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:

setSample

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

Description copied from class: SampleModel

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.

Specified by:

setSample in class SampleModel

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.

See Also:

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 SampleModel

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:

© 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.