- java.lang.Object
-
- java.awt.image.SampleModel
-
- java.awt.image.ComponentSampleModel
-
- Direct Known Subclasses:
BandedSampleModel,PixelInterleavedSampleModel
public class ComponentSampleModel extends SampleModel
This class represents image data which is stored such that each sample of a pixel occupies one data element of the DataBuffer. It stores the N samples which make up a pixel in N separate data array elements. Different bands may be in different banks of the DataBuffer. Accessor methods are provided so that image data can be manipulated directly. This class can support different kinds of interleaving, e.g. band interleaving, scanline interleaving, and pixel interleaving. 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. This class can represent image data for which each sample is an unsigned integral number which can be stored in 8, 16, or 32 bits (usingDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT, orDataBuffer.TYPE_INT, respectively), data for which each sample is a signed integral number which can be stored in 16 bits (usingDataBuffer.TYPE_SHORT), or data for which each sample is a signed float or double quantity (usingDataBuffer.TYPE_FLOATorDataBuffer.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 supportsTYPE_BYTE,TYPE_USHORT,TYPE_SHORT,TYPE_INT,TYPE_FLOAT,TYPE_DOUBLE,- See Also:
PixelInterleavedSampleModel,BandedSampleModel
-
-
Field Summary
Fields Modifier and Type Field Description protected int[]bandOffsetsOffsets for all bands in data array elements.protected int[]bankIndicesIndex for each bank storing a band of image data.protected intnumBandsThe number of bands in thisComponentSampleModel.protected intnumBanksThe number of banks in thisComponentSampleModel.protected intpixelStridePixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.protected intscanlineStrideLine 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
Constructors Constructor Description ComponentSampleModel(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SampleModelcreateCompatibleSampleModel(int w, int h)Creates a newComponentSampleModelwith the specified width and height.DataBuffercreateDataBuffer()Creates aDataBufferthat corresponds to thisComponentSampleModel.SampleModelcreateSubsetSampleModel(int[] bands)Creates a new ComponentSampleModel with a subset of the bands of this ComponentSampleModel.int[]getBandOffsets()Returns the band offset for all bands.int[]getBankIndices()Returns the bank indices for all bands.ObjectgetDataElements(int x, int y, Object obj, DataBuffer data)Returns data for a single pixel in a primitive array of typeTransferType.intgetNumDataElements()Returns the number of data elements needed to transfer a pixel with thegetDataElements(int, int, Object, DataBuffer)andsetDataElements(int, int, Object, DataBuffer)methods.intgetOffset(int x, int y)Gets the offset for the first band of pixel (x,y).intgetOffset(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.intgetPixelStride()Returns the pixel stride of this ComponentSampleModel.intgetSample(int x, int y, int b, DataBuffer data)Returns as int the sample in a specified band for the pixel located at (x,y).doublegetSampleDouble(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.floatgetSampleFloat(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.int[]getSampleSize()Returns the number of bits per sample for all bands.intgetSampleSize(int band)Returns the number of bits per sample for the specified band.intgetScanlineStride()Returns the scanline stride of this ComponentSampleModel.voidsetDataElements(int x, int y, Object obj, DataBuffer data)Sets the data for a single pixel in the specifiedDataBufferfrom a primitive array of typeTransferType.voidsetPixel(int x, int y, int[] iArray, DataBuffer data)Sets a pixel in theDataBufferusing an int array of samples for input.voidsetPixels(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.voidsetSample(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 theDataBufferusing a double for input.voidsetSample(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 theDataBufferusing a float for input.voidsetSample(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 theDataBufferusing an int for input.voidsetSamples(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 Detail
-
bandOffsets
protected int[] bandOffsets
Offsets for all bands in data array elements.
-
bankIndices
protected int[] bankIndices
Index for each bank storing a band of image data.
-
numBands
protected int numBands
The number of bands in thisComponentSampleModel.
-
numBanks
protected int numBanks
The number of banks in thisComponentSampleModel.
-
scanlineStride
protected int scanlineStride
Line stride (in data array elements) of the region of image data described by this ComponentSampleModel.
-
pixelStride
protected int pixelStride
Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.
-
-
Constructor Detail
-
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- ifworhis not greater than 0IllegalArgumentException- ifpixelStrideis less than 0IllegalArgumentException- ifscanlineStrideis less than 0IllegalArgumentException- ifnumBandsis less than 1IllegalArgumentException- if the product ofwandhis greater thanInteger.MAX_VALUEIllegalArgumentException- ifdataTypeis not one of the supported data types
-
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- ifworhis not greater than 0IllegalArgumentException- ifpixelStrideis less than 0IllegalArgumentException- ifscanlineStrideis less than 0IllegalArgumentException- if the length ofbankIndicesdoes not equal the length ofbankOffsetsIllegalArgumentException- if any of the bank indices ofbandIndicesis less than 0IllegalArgumentException- ifdataTypeis not one of the supported data types
-
-
Method Detail
-
createCompatibleSampleModel
public SampleModel createCompatibleSampleModel(int w, int h)
Creates a newComponentSampleModelwith the specified width and height. The newSampleModelwill have the same number of bands, storage data type, interleaving scheme, and pixel stride as thisSampleModel.- Specified by:
createCompatibleSampleModelin classSampleModel- Parameters:
w- the width of the resultingSampleModelh- the height of the resultingSampleModel- Returns:
- a new
ComponentSampleModelwith the specified size - Throws:
IllegalArgumentException- ifworhis not greater than 0
-
createSubsetSampleModel
public SampleModel createSubsetSampleModel(int[] bands)
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:
createSubsetSampleModelin classSampleModel- Parameters:
bands- a subset of bands from thisComponentSampleModel- Returns:
- a
ComponentSampleModelcreated with a subset of bands from thisComponentSampleModel.
-
createDataBuffer
public DataBuffer createDataBuffer()
Creates aDataBufferthat corresponds to thisComponentSampleModel. TheDataBufferobject's data type, number of banks, and size are be consistent with thisComponentSampleModel.- Specified by:
createDataBufferin classSampleModel- Returns:
- a
DataBufferwhose 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 aDataBufferdatawith aComponentSampleModelcsmasdata.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 bandbcan be retrieved from aDataBuffer datawith aComponentSampleModel csmasdata.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:
getSampleSizein 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:
getSampleSizein 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:
getNumDataElementsin classSampleModel- Returns:
- the number of data elements needed to transfer a pixel with
the
getDataElementsandsetDataElementsmethods. - See Also:
SampleModel.getNumDataElements(),SampleModel.getNumBands()
-
getDataElements
public Object getDataElements(int x, int y, Object obj, DataBuffer data)
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,objshould be passed in asnull, so that theObjectis 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 usinggetPixelandsetPixel.ComponentSampleModel csm1, csm2; DataBufferInt db1, db2; csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1), db2);UsinggetDataElementsandsetDataElementsto transfer between twoDataBuffer/SampleModelpairs is legitimate if theSampleModelobjects have the same number of bands, corresponding bands have the same number of bits per sample, and theTransferTypes are the same.If
objis notnull, it should be a primitive array of typeTransferType. Otherwise, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds, or ifobjis notnulland is not large enough to hold the pixel data.- Specified by:
getDataElementsin 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- theDataBuffercontaining 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:
setDataElements(int, int, Object, DataBuffer)
-
getPixel
public 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. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
getPixelin 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:
setPixel(int, int, int[], DataBuffer)
-
getPixels
public 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. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
getPixelsin 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:
setPixels(int, int, int, int, int[], DataBuffer)
-
getSample
public 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). AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Specified by:
getSamplein classSampleModel- Parameters:
x- the X coordinate of the pixel locationy- the Y coordinate of the pixel locationb- the band to returndata- theDataBuffercontaining the image data- Returns:
- the sample in a specified band for the specified pixel
- See Also:
setSample(int, int, int, int, DataBuffer)
-
getSampleFloat
public 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. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
getSampleFloatin 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
public 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. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
getSampleDoublein 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
public 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. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
getSamplesin 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- theDataBuffercontaining the image data- Returns:
- the samples in the specified band of the specified pixel
- See Also:
setSamples(int, int, int, int, int, int[], DataBuffer)
-
setDataElements
public void setDataElements(int x, int y, Object obj, DataBuffer data)Sets the data for a single pixel in the specifiedDataBufferfrom 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 usinggetPixelandsetPixel.ComponentSampleModel csm1, csm2; DataBufferInt db1, db2; csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1), db2);UsinggetDataElementsandsetDataElementsto transfer between twoDataBuffer/SampleModelpairs is legitimate if theSampleModelobjects have the same number of bands, corresponding bands have the same number of bits per sample, and theTransferTypes are the same.A
ClassCastExceptionis thrown ifobjis not a primitive array of typeTransferType. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds, or ifobjis not large enough to hold the pixel data.- Specified by:
setDataElementsin 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:
getDataElements(int, int, Object, DataBuffer)
-
setPixel
public void setPixel(int x, int y, int[] iArray, DataBuffer data)Sets a pixel in theDataBufferusing an int array of samples for input. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
setPixelin 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:
getPixel(int, int, int[], DataBuffer)
-
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. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
setPixelsin 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:
getPixels(int, int, int, int, int[], DataBuffer)
-
setSample
public 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 theDataBufferusing an int for input. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Specified by:
setSamplein 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:
getSample(int, int, int, DataBuffer)
-
setSample
public 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 theDataBufferusing a float for input. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
setSamplein 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:
getSample(int, int, int, DataBuffer)
-
setSample
public 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 theDataBufferusing a double for input. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
setSamplein 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:
getSample(int, int, int, DataBuffer)
-
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 data array element. AnArrayIndexOutOfBoundsExceptionmight be thrown if the coordinates are not in bounds.- Overrides:
setSamplesin 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:
getSamples(int, int, int, int, int, int[], DataBuffer)
-
-