Class BandedSampleModel
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, scanlineStrideFields declared in class java.awt.image.SampleModel
dataType, height, width -
Constructor Summary
ConstructorsConstructorDescriptionBandedSampleModel(int dataType, int w, int h, int numBands) Constructs a BandedSampleModel with the specified parameters.BandedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets) Constructs a BandedSampleModel with the specified parameters. -
Method Summary
Modifier and TypeMethodDescriptioncreateCompatibleSampleModel(int w, int h) Creates a new BandedSampleModel with the specified width and height.Creates a DataBuffer that corresponds to this BandedSampleModel, The DataBuffer's data type, number of banks, and size will be consistent with this BandedSampleModel.createSubsetSampleModel(int[] bands) Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel.getDataElements(int x, int y, Object obj, DataBuffer data) Returns data for a single pixel in a primitive array of type TransferType.int[]getPixel(int x, int y, int[] iArray, DataBuffer data) Returns all samples for the specified pixel in an int array.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 data array element.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.voidsetDataElements(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.voidsetPixel(int x, int y, int[] iArray, DataBuffer data) Sets a pixel in the DataBuffer using 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 the DataBuffer using 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 the DataBuffer using 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 the DataBuffer using 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.ComponentSampleModel
getBandOffsets, getBankIndices, getNumDataElements, getOffset, getOffset, getPixelStride, getSampleSize, getSampleSize, getScanlineStrideMethods 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
-
BandedSampleModel
public BandedSampleModel(int dataType, int w, int h, int numBands) Constructs a BandedSampleModel with the specified parameters. The pixel stride will be one data element. The scanline stride will be the same as the width. Each band will be stored in a separate bank and all band offsets will be zero.- 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.numBands- The number of bands for the image data.- Throws:
IllegalArgumentException- ifwandhare not both greater than 0IllegalArgumentException- if the product ofwandhis greater thanInteger.MAX_VALUEIllegalArgumentException- ifnumBandsis not > 0IllegalArgumentException- ifdataTypeis not one of the supported data types for this sample model.
-
BandedSampleModel
public BandedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets) Constructs a BandedSampleModel with the specified parameters. The number of bands will be inferred from the lengths of the bandOffsets bankIndices arrays, which must be equal. The pixel stride will be one data element.- 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 of the image data.bankIndices- The bank index for each band.bandOffsets- The band offset for each band.- Throws:
IllegalArgumentException- ifwandhare not both greater than 0IllegalArgumentException- if the product ofwandhis greater thanInteger.MAX_VALUEIllegalArgumentException- ifscanlineStrideis less than 0NullPointerException- ifbankIndicesisnullNullPointerException- ifbandOffsetsisnullIllegalArgumentException- ifbandOffsets.lengthis 0IllegalArgumentException- if the length ofbankIndicesdoes not equal the length ofbandOffsetsIllegalArgumentException- if any of the bank indices ofbandIndicesis less than 0IllegalArgumentException- ifdataTypeis not one of the supported data types for this sample model
-
-
Method Details
-
createCompatibleSampleModel
Creates a new BandedSampleModel with the specified width and height. The new BandedSampleModel will have the same number of bands, storage data type, and bank indices as this BandedSampleModel. The band offsets will be compressed such that the offset between bands will be w*pixelStride and the minimum of all of the band offsets is zero.- Overrides:
createCompatibleSampleModelin classComponentSampleModel- Parameters:
w- the width of the resultingBandedSampleModelh- the height of the resultingBandedSampleModel- Returns:
- a new
BandedSampleModelwith the specified width and height. - Throws:
IllegalArgumentException- ifworhequals eitherInteger.MAX_VALUEorInteger.MIN_VALUEIllegalArgumentException- ifdataTypeis not one of the supported data types
-
createSubsetSampleModel
Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel. The new BandedSampleModel can be used with any DataBuffer that the existing BandedSampleModel can be used with. The new BandedSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original BandedSampleModel/DataBuffer combination.- Overrides:
createSubsetSampleModelin classComponentSampleModel- Parameters:
bands- a subset of bands from thisComponentSampleModel- Returns:
- a
ComponentSampleModelcreated with a subset of bands from thisComponentSampleModel. - Throws:
RasterFormatException- if the number of bands is greater than the number of banks in this sample model.IllegalArgumentException- ifdataTypeis not one of the supported data types
-
createDataBuffer
Creates a DataBuffer that corresponds to this BandedSampleModel, The DataBuffer's data type, number of banks, and size will be consistent with this BandedSampleModel.- Overrides:
createDataBufferin classComponentSampleModel- Returns:
- a
DataBufferwhose data type, number of banks and size are consistent with thisComponentSampleModel. - Throws:
IllegalArgumentException- ifdataTypeis not one of the supported types.
-
getDataElements
Returns data for a single pixel in a primitive array of type TransferType. For a BandedSampleModel, this will be the same as the data type, and samples will be returned one per array element. 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 BandedSampleModelbsm1, to DataBufferdb2, whose storage layout is described by BandedSampleModelbsm2. The transfer will generally be more efficient than using getPixel/setPixel.BandedSampleModel bsm1, bsm2; DataBufferInt db1, db2; bsm2.setDataElements(x, y, bsm1.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.
- Overrides:
getDataElementsin classComponentSampleModel- 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 data.data- The DataBuffer containing the image data.- Returns:
- the data for the specified pixel.
- See Also:
-
getPixel
Returns all samples for the specified pixel in an int array. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
getPixelin classComponentSampleModel- 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 for the specified pixel.
- See Also:
-
getPixels
Returns all samples for the specified rectangle of pixels in an int array, one sample per data array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
getPixelsin classComponentSampleModel- 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 for 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). ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
getSamplein classComponentSampleModel- 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:
- the sample in the 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
getSampleFloatin classComponentSampleModel- 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 that represents 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
getSampleDoublein classComponentSampleModel- 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 that represents 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
getSamplesin classComponentSampleModel- 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- The DataBuffer containing the image data- Returns:
- the samples in the specified band for the pixels within the specified region.
- See Also:
-
setDataElements
Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType. For a BandedSampleModel, this will be 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 by BandedSampleModelbsm1, to DataBufferdb2, whose storage layout is described by BandedSampleModelbsm2. The transfer will generally be more efficient than using getPixel/setPixel.BandedSampleModel bsm1, bsm2; DataBufferInt db1, db2; bsm2.setDataElements(x, y, bsm1.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.
- Overrides:
setDataElementsin classComponentSampleModel- Parameters:
x- The X coordinate of the pixel locationy- The Y coordinate of the pixel locationobj- If non-null, returns the primitive array in this objectdata- The DataBuffer containing the image data- See Also:
-
setPixel
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:
setPixelin classComponentSampleModel- 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
setPixelsin classComponentSampleModel- 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 the DataBuffer using an int for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
setSamplein classComponentSampleModel- 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 the DataBuffer using a float for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
setSamplein classComponentSampleModel- 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 the DataBuffer using a double for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
setSamplein classComponentSampleModel- 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Overrides:
setSamplesin classComponentSampleModel- 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 sample arraydata- The DataBuffer containing the image data- See Also:
-