Class ComponentSampleModel
- Direct Known Subclasses:
BandedSampleModel
,PixelInterleavedSampleModel
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
,- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected int[]
Offsets for all bands in data array elements.protected int[]
Index for each bank storing a band of image data.protected int
The number of bands in thisComponentSampleModel
.protected int
The number of banks in thisComponentSampleModel
.protected int
Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.protected int
Line stride (in data array elements) of the region of image data described by this ComponentSampleModel.Fields declared in class java.awt.image.SampleModel
dataType, height, width
-
Constructor Summary
ConstructorDescriptionComponentSampleModel
(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bandOffsets) Constructs a ComponentSampleModel with the specified parameters.ComponentSampleModel
(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bankIndices, int[] bandOffsets) Constructs a ComponentSampleModel with the specified parameters. -
Method Summary
Modifier and TypeMethodDescriptioncreateCompatibleSampleModel
(int w, int h) Creates a newComponentSampleModel
with the specified width and height.Creates aDataBuffer
that corresponds to thisComponentSampleModel
.createSubsetSampleModel
(int[] bands) Creates a new ComponentSampleModel with a subset of the bands of this ComponentSampleModel.final int[]
Returns the band offset for all bands.final int[]
Returns the bank indices for all bands.getDataElements
(int x, int y, Object obj, DataBuffer data) Returns data for a single pixel in a primitive array of typeTransferType
.final int
Returns the number of data elements needed to transfer a pixel with thegetDataElements(int, int, Object, DataBuffer)
andsetDataElements(int, int, Object, DataBuffer)
methods.int
getOffset
(int x, int y) Gets the offset for the first band of pixel (x,y).int
getOffset
(int x, int y, int b) Gets the offset for band b of pixel (x,y).int[]
getPixel
(int x, int y, int[] iArray, DataBuffer data) Returns all samples for the 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 the specified rectangle of pixels in an int array, one sample per array element.final int
Returns the pixel stride of this ComponentSampleModel.int
getSample
(int x, int y, int b, DataBuffer data) Returns as int the sample in a specified band for the pixel located at (x,y).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.int[]
getSamples
(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data) 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[]
Returns the number of bits per sample for all bands.final int
getSampleSize
(int band) Returns the number of bits per sample for the specified band.final int
Returns the scanline stride of this ComponentSampleModel.void
setDataElements
(int x, int y, Object obj, DataBuffer data) Sets the data for a single pixel in the specifiedDataBuffer
from a primitive array of typeTransferType
.void
setPixel
(int x, int y, int[] iArray, DataBuffer data) Sets a pixel in theDataBuffer
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, double s, DataBuffer data) Sets a sample in the specified band for the pixel located at (x,y) in theDataBuffer
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 theDataBuffer
using a float for input.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 theDataBuffer
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 data array element.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
-
Field Details
-
bandOffsets
protected int[] bandOffsetsOffsets for all bands in data array elements. -
bankIndices
protected int[] bankIndicesIndex for each bank storing a band of image data. -
numBands
protected int numBandsThe number of bands in thisComponentSampleModel
. -
numBanks
protected int numBanksThe number of banks in thisComponentSampleModel
. -
scanlineStride
protected int scanlineStrideLine stride (in data array elements) of the region of image data described by this ComponentSampleModel. -
pixelStride
protected int pixelStridePixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.
-
-
Constructor Details
-
ComponentSampleModel
public ComponentSampleModel(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bandOffsets) Constructs a ComponentSampleModel with the specified parameters. The number of bands will be given by the length of the bandOffsets array. All bands will be stored in the first bank of the DataBuffer.- Parameters:
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 bands- Throws:
IllegalArgumentException
- ifw
andh
are not both greater than 0IllegalArgumentException
- if the product ofw
andh
is greater thanInteger.MAX_VALUE
IllegalArgumentException
- ifpixelStride
is less than 0IllegalArgumentException
- ifscanlineStride
is less than 0NullPointerException
- ifbandOffsets
isnull
IllegalArgumentException
- ifbandOffsets.length
is 0IllegalArgumentException
- ifdataType
is not one of the supported data types for this sample model.
-
ComponentSampleModel
public ComponentSampleModel(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bankIndices, int[] bandOffsets) Constructs a ComponentSampleModel with the specified parameters. The number of bands will be given by the length of the bandOffsets array. Different bands may be stored in different banks of the DataBuffer.- Parameters:
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 bands- Throws:
IllegalArgumentException
- ifw
andh
are not both greater than 0IllegalArgumentException
- if the product ofw
andh
is greater thanInteger.MAX_VALUE
IllegalArgumentException
- ifpixelStride
is less than 0IllegalArgumentException
- ifscanlineStride
is less than 0NullPointerException
- ifbankIndices
isnull
NullPointerException
- ifbandOffsets
isnull
IllegalArgumentException
- ifbandOffsets.length
is 0IllegalArgumentException
- if the length ofbankIndices
does not equal the length ofbandOffsets
IllegalArgumentException
- if any of the bank indices ofbandIndices
is less than 0IllegalArgumentException
- ifdataType
is not one of the supported data types for this sample model
-
-
Method Details
-
createCompatibleSampleModel
Creates a newComponentSampleModel
with the specified width and height. The newSampleModel
will have the same number of bands, storage data type, interleaving scheme, and pixel stride as thisSampleModel
.- Specified by:
createCompatibleSampleModel
in classSampleModel
- Parameters:
w
- the width of the resultingSampleModel
h
- the height of the resultingSampleModel
- Returns:
- a new
ComponentSampleModel
with the specified size - Throws:
IllegalArgumentException
- ifw
orh
is not greater than 0
-
createSubsetSampleModel
Creates a new ComponentSampleModel with a subset of the bands of this ComponentSampleModel. The new ComponentSampleModel can be used with any DataBuffer that the existing ComponentSampleModel can be used with. The new ComponentSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original ComponentSampleModel/DataBuffer combination.- Specified by:
createSubsetSampleModel
in classSampleModel
- Parameters:
bands
- a subset of bands from thisComponentSampleModel
- Returns:
- a
ComponentSampleModel
created with a subset of bands from thisComponentSampleModel
.
-
createDataBuffer
Creates aDataBuffer
that corresponds to thisComponentSampleModel
. TheDataBuffer
object's data type, number of banks, and size are be consistent with thisComponentSampleModel
.- Specified by:
createDataBuffer
in classSampleModel
- Returns:
- a
DataBuffer
whose data type, number of banks and size are consistent with thisComponentSampleModel
.
-
getOffset
public int getOffset(int x, int y) Gets the offset for the first band of pixel (x,y). A sample of the first band can be retrieved from aDataBuffer
data
with aComponentSampleModel
csm
asdata.getElem(csm.getOffset(x, y));
- Parameters:
x
- the X location of the pixely
- the Y location of the pixel- Returns:
- the offset for the first band of the specified pixel.
-
getOffset
public int getOffset(int x, int y, int b) Gets the offset for band b of pixel (x,y). A sample of bandb
can be retrieved from aDataBuffer data
with aComponentSampleModel csm
asdata.getElem(csm.getOffset(x, y, b));
- Parameters:
x
- the X location of the specified pixely
- the Y location of the specified pixelb
- the specified band- Returns:
- the offset for the specified band of the specified pixel.
-
getSampleSize
public final int[] getSampleSize()Returns the number of bits per sample for all bands.- Specified by:
getSampleSize
in classSampleModel
- Returns:
- an array containing the number of bits per sample for all bands, where each element in the array represents a band.
-
getSampleSize
public final int getSampleSize(int band) Returns the number of bits per sample for the specified band.- Specified by:
getSampleSize
in classSampleModel
- Parameters:
band
- the specified band- Returns:
- the number of bits per sample for the specified band.
-
getBankIndices
public final int[] getBankIndices()Returns the bank indices for all bands.- Returns:
- the bank indices for all bands.
-
getBandOffsets
public final int[] getBandOffsets()Returns the band offset for all bands.- Returns:
- the band offsets for all bands.
-
getScanlineStride
public final int getScanlineStride()Returns the scanline stride of this ComponentSampleModel.- Returns:
- the scanline stride of this
ComponentSampleModel
.
-
getPixelStride
public final int getPixelStride()Returns the pixel stride of this ComponentSampleModel.- Returns:
- the pixel stride of this
ComponentSampleModel
.
-
getNumDataElements
public final int getNumDataElements()Returns the number of data elements needed to transfer a pixel with thegetDataElements(int, int, Object, DataBuffer)
andsetDataElements(int, int, Object, DataBuffer)
methods. For aComponentSampleModel
, this is identical to the number of bands.- Specified by:
getNumDataElements
in classSampleModel
- Returns:
- the number of data elements needed to transfer a pixel with
the
getDataElements
andsetDataElements
methods. - See Also:
-
getDataElements
Returns data for a single pixel in a primitive array of typeTransferType
. For aComponentSampleModel
, this is the same as the data type, and samples are returned one per array element. Generally,obj
should be passed in asnull
, so that theObject
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 byComponentSampleModel csm1
, toDataBuffer db2
, whose storage layout is described byComponentSampleModel csm2
. The transfer is usually more efficient than usinggetPixel
andsetPixel
.ComponentSampleModel csm1, csm2; DataBufferInt db1, db2; csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1), db2);
UsinggetDataElements
andsetDataElements
to transfer between twoDataBuffer/SampleModel
pairs is legitimate if theSampleModel
objects have the same number of bands, corresponding bands have the same number of bits per sample, and theTransferType
s are the same.If
obj
is notnull
, it should be a primitive array of typeTransferType
. Otherwise, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds, or ifobj
is notnull
and is not large enough to hold the pixel data.- Specified by:
getDataElements
in classSampleModel
- Parameters:
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
- theDataBuffer
containing the image data- Returns:
- the data of 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
Returns all samples for the specified pixel in an int array, one sample per array element. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
getPixel
in classSampleModel
- Parameters:
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 data- Returns:
- the samples of 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
Returns all samples for the specified rectangle of pixels in an int array, one sample per array element. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
getPixels
in classSampleModel
- Parameters:
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 data- Returns:
- the samples of the pixels within the specified region.
- See Also:
-
getSample
Returns as int the sample in a specified band for the pixel located at (x,y). AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Specified by:
getSample
in classSampleModel
- Parameters:
x
- the X coordinate of the pixel locationy
- the Y coordinate of the pixel locationb
- the band to returndata
- theDataBuffer
containing the image data- Returns:
- the sample in a specified band for the specified pixel
- See Also:
-
getSampleFloat
Returns the sample in a specified band for the pixel located at (x,y) as a float. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
getSampleFloat
in classSampleModel
- Parameters:
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to returndata
- The DataBuffer containing the image data- Returns:
- a float value representing the sample in the specified band for the specified pixel.
-
getSampleDouble
Returns the sample in a specified band for a pixel located at (x,y) as a double. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
getSampleDouble
in classSampleModel
- Parameters:
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to returndata
- The DataBuffer containing the image data- Returns:
- a double value representing the sample in the specified band for the specified pixel.
-
getSamples
Returns the samples in a specified band for the specified rectangle of pixels in an int array, one sample per data array element. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
getSamples
in classSampleModel
- Parameters:
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
- theDataBuffer
containing the image data- Returns:
- the samples in the specified band of the specified pixel
- See Also:
-
setDataElements
Sets the data for a single pixel in the specifiedDataBuffer
from a primitive array of typeTransferType
. For aComponentSampleModel
, 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 byComponentSampleModel csm1
, toDataBuffer db2
, whose storage layout is described byComponentSampleModel csm2
. The transfer is usually more efficient than usinggetPixel
andsetPixel
.ComponentSampleModel csm1, csm2; DataBufferInt db1, db2; csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1), db2);
UsinggetDataElements
andsetDataElements
to transfer between twoDataBuffer/SampleModel
pairs is legitimate if theSampleModel
objects have the same number of bands, corresponding bands have the same number of bits per sample, and theTransferType
s are the same.A
ClassCastException
is thrown ifobj
is not a primitive array of typeTransferType
. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds, or ifobj
is not large enough to hold the pixel data.- Specified by:
setDataElements
in classSampleModel
- Parameters:
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 data- See Also:
-
setPixel
Sets a pixel in theDataBuffer
using an int array of samples for input. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
setPixel
in classSampleModel
- Parameters:
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 data- See Also:
-
setPixels
Sets all samples for a rectangle of pixels from an int array containing one sample per array element. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
setPixels
in classSampleModel
- Parameters:
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 data- See Also:
-
setSample
Sets a sample in the specified band for the pixel located at (x,y) in theDataBuffer
using an int for input. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Specified by:
setSample
in classSampleModel
- Parameters:
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 data- See Also:
-
setSample
Sets a sample in the specified band for the pixel located at (x,y) in theDataBuffer
using a float for input. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
setSample
in classSampleModel
- Parameters:
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 data- See Also:
-
setSample
Sets a sample in the specified band for the pixel located at (x,y) in theDataBuffer
using a double for input. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
setSample
in classSampleModel
- Parameters:
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 data- See Also:
-
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. AnArrayIndexOutOfBoundsException
might be thrown if the coordinates are not in bounds.- Overrides:
setSamples
in classSampleModel
- Parameters:
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- See Also:
-