|
Java Platform 1.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--java.awt.image.SampleModel
|
+--java.awt.image.ComponentSampleModel
|
+--java.awt.image.BandedSampleModel
This class represents image data which is stored in a band interleaved fashion and for which each sample of a pixel occupies one data element of the DataBuffer. It subclasses ComponentSampleModel but provides a more efficent implementation for accessing band interleaved image data than is provided by ComponentSampleModel. This class should typically be used when working with images which store sample data for each band in a different 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.
| Fields inherited from class java.awt.image.ComponentSampleModel |
bandOffsets,
bankIndices,
numBands,
numBanks,
pixelStride,
scanlineStride |
| Fields inherited from class java.awt.image.SampleModel |
dataType,
height,
numBands,
width |
| Constructor Summary | |
BandedSampleModel(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 | |
SampleModel |
createCompatibleSampleModel(int w,
int h)
Creates a new BandedSampleModel with the specified width and height. |
DataBuffer |
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. |
SampleModel |
createSubsetSampleModel(int[] bands)
Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel. |
Object |
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. |
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). |
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. |
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 data array element. |
| Methods inherited from class java.awt.image.ComponentSampleModel |
getBandOffsets,
getBankIndices,
getNumDataElements,
getOffset,
getOffset,
getPixelStride,
getSampleSize,
getSampleSize,
getScanlineStride |
| Methods inherited from class java.awt.image.SampleModel |
getDataElements,
getDataType,
getHeight,
getNumBands,
getPixel,
getPixel,
getPixels,
getPixels,
getSampleDouble,
getSampleFloat,
getSamples,
getSamples,
getTransferType,
getWidth,
setDataElements,
setPixel,
setPixel,
setPixels,
setPixels,
setSample,
setSample,
setSamples,
setSamples |
| Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
| Constructor Detail |
public BandedSampleModel(int dataType,
int w,
int h,
int numBands)
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.
public BandedSampleModel(int dataType,
int w,
int h,
int scanlineStride,
int[] bankIndices,
int[] bandOffsets)
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.scanlineStride - The line stride of the of the image data.bankIndices - The bank index for each band.bandOffsets - The band offset for each band.| Method Detail |
public SampleModel createCompatibleSampleModel(int w,
int h)
public SampleModel createSubsetSampleModel(int[] bands)
public DataBuffer createDataBuffer()
public Object getDataElements(int x,
int y,
Object obj,
DataBuffer data)
The following code illustrates transferring data for one pixel from
DataBuffer db1, whose storage layout is described by
BandedSampleModel bsm1, to DataBuffer db2,
whose storage layout is described by
BandedSampleModel bsm2.
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.
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.
public int[] getPixel(int x,
int y,
int[] iArray,
DataBuffer data)
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.
public int[] getPixels(int x,
int y,
int w,
int h,
int[] iArray,
DataBuffer data)
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.
public int getSample(int x,
int y,
int b,
DataBuffer data)
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.
public int[] getSamples(int x,
int y,
int w,
int h,
int b,
int[] iArray,
DataBuffer data)
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.
public void setDataElements(int x,
int y,
Object obj,
DataBuffer data)
The following code illustrates transferring data for one pixel from
DataBuffer db1, whose storage layout is described by
BandedSampleModel bsm1, to DataBuffer db2,
whose storage layout is described by
BandedSampleModel bsm2.
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.
x - The X coordinate of the pixel location.y - The Y coordinate of the pixel location.obj - If non-null, returns the primitive array in this object.data - The DataBuffer containing the image data.
public void setPixel(int x,
int y,
int[] iArray,
DataBuffer data)
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.
public void setPixels(int x,
int y,
int w,
int h,
int[] iArray,
DataBuffer data)
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.
public void setSample(int x,
int y,
int b,
int s,
DataBuffer data)
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.
public void setSamples(int x,
int y,
int w,
int h,
int b,
int[] iArray,
DataBuffer data)
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 sample array.data - The DataBuffer containing the image data.
|
Java Platform 1.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||