Class PixelInterleavedSampleModel
java.lang.Object
java.awt.image.SampleModel
java.awt.image.ComponentSampleModel
java.awt.image.PixelInterleavedSampleModel
This class represents image data which is stored in a pixel interleaved
fashion and for
which each sample of a pixel occupies one data element of the DataBuffer.
It subclasses ComponentSampleModel but provides a more efficient
implementation for accessing pixel interleaved image data than is provided
by ComponentSampleModel. This class
stores sample data for all bands in a single bank of the
DataBuffer. Accessor methods are provided so that image data can be
manipulated directly. Pixel stride is the number of
data array elements between two samples for the same band on the same
scanline. 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. Band offsets denote the number
of data array elements from the first data array element of the bank
of the DataBuffer holding each band to the first sample of the band.
The bands are numbered from 0 to N-1.
Bank indices denote the correspondence between a bank of the data buffer
and a band of image data.
This class supports
TYPE_BYTE
,
TYPE_USHORT
,
TYPE_SHORT
,
TYPE_INT
,
TYPE_FLOAT
and
TYPE_DOUBLE
datatypes.-
Field Summary
Fields declared in class java.awt.image.ComponentSampleModel
bandOffsets, bankIndices, numBands, numBanks, pixelStride, scanlineStride
Fields declared in class java.awt.image.SampleModel
dataType, height, width
-
Constructor Summary
ConstructorDescriptionPixelInterleavedSampleModel
(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bandOffsets) Constructs a PixelInterleavedSampleModel with the specified parameters. -
Method Summary
Modifier and TypeMethodDescriptioncreateCompatibleSampleModel
(int w, int h) Creates a new PixelInterleavedSampleModel with the specified width and height.createSubsetSampleModel
(int[] bands) Creates a new PixelInterleavedSampleModel with a subset of the bands of this PixelInterleavedSampleModel.Methods declared in class java.awt.image.ComponentSampleModel
createDataBuffer, getBandOffsets, getBankIndices, getDataElements, getNumDataElements, getOffset, getOffset, getPixel, getPixels, getPixelStride, getSample, getSampleDouble, getSampleFloat, getSamples, getSampleSize, getSampleSize, getScanlineStride, setDataElements, setPixel, setPixels, setSample, setSample, setSample, setSamples
Methods declared in class java.awt.image.SampleModel
getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSamples, setSamples
-
Constructor Details
-
PixelInterleavedSampleModel
public PixelInterleavedSampleModel(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bandOffsets) Constructs a PixelInterleavedSampleModel with the specified parameters. The number of bands will be given by the length of the bandOffsets array.- 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.pixelStride
- The pixel stride of the image data.scanlineStride
- The line stride of the image data.bandOffsets
- The offsets of all bands.- Throws:
IllegalArgumentException
- ifw
orh
is not greater than 0IllegalArgumentException
- if any offset between bands is greater than the scanline strideIllegalArgumentException
- if the product ofpixelStride
andw
is greater thanscanlineStride
IllegalArgumentException
- ifpixelStride
is less than any offset between bandsIllegalArgumentException
- ifdataType
is not one of the supported data types
-
-
Method Details
-
createCompatibleSampleModel
Creates a new PixelInterleavedSampleModel with the specified width and height. The new PixelInterleavedSampleModel will have the same number of bands, storage data type, and pixel stride as this PixelInterleavedSampleModel. The band offsets may be compressed such that the minimum of all of the band offsets is zero.- Overrides:
createCompatibleSampleModel
in classComponentSampleModel
- Parameters:
w
- the width of the resultingSampleModel
h
- the height of the resultingSampleModel
- Returns:
- a new
SampleModel
with the specified width and height. - Throws:
IllegalArgumentException
- ifw
orh
is not greater than 0
-
createSubsetSampleModel
Creates a new PixelInterleavedSampleModel with a subset of the bands of this PixelInterleavedSampleModel. The new PixelInterleavedSampleModel can be used with any DataBuffer that the existing PixelInterleavedSampleModel can be used with. The new PixelInterleavedSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original PixelInterleavedSampleModel/DataBuffer combination.- Overrides:
createSubsetSampleModel
in classComponentSampleModel
- Parameters:
bands
- a subset of bands from thisComponentSampleModel
- Returns:
- a
ComponentSampleModel
created with a subset of bands from thisComponentSampleModel
.
-