|
JavaTM 2 Platform Standard Edition |
|||||||||
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.SinglePixelPackedSampleModel
This class represents pixel data packed such that the N samples which make up a single pixel are stored in a single data array element, and each data data array element holds samples for only one pixel. All data array elements reside in the first bank of a DataBuffer. Accessor methods are provided so that the image data can be manipulated directly. 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. Bit masks are the masks required to extract the samples representing the bands of the pixel. Bit offsets are the offsets in bits into the data array element of the samples representing the bands of the pixel.
The following code illustrates extracting the bits of the sample
representing band b
for pixel x,y
from DataBuffer data
:
int sample = data.getElem(y * scanlineStride + x); sample = (sample & bitMasks[b]) >>> bitOffsets[b];
Fields inherited from class java.awt.image.SampleModel |
dataType,
height,
numBands,
width |
Constructor Summary | |
SinglePixelPackedSampleModel(int dataType,
int w,
int h,
int[] bitMasks)
Constructs a SinglePixelPackedSampleModel with bitMasks.length bands. |
|
SinglePixelPackedSampleModel(int dataType,
int w,
int h,
int scanlineStride,
int[] bitMasks)
Constructs a SinglePixelPackedSampleModel with bitMasks.length bands and a scanline stride equal to scanlineStride data array elements. |
Method Summary | |
SampleModel |
createCompatibleSampleModel(int w,
int h)
This creates a new SinglePixelPackedSampleModel with the specified width and height. |
DataBuffer |
createDataBuffer()
Creates a DataBuffer that corresponds to this SinglePixelPackedSampleModel. |
SampleModel |
createSubsetSampleModel(int[] bands)
This creates a new SinglePixelPackedSampleModel with a subset of the bands of this SinglePixelPackedSampleModel. |
int[] |
getBitMasks()
Returns the bit masks for all bands. |
int[] |
getBitOffsets()
Returns the bit offsets into the data array element representing a pixel for all bands. |
Object |
getDataElements(int x,
int y,
Object obj,
DataBuffer data)
Returns data for a single pixel in a primitive array of type TransferType. |
int |
getNumDataElements()
Returns the number of data elements needed to transfer one pixel via the getDataElements and setDataElements methods. |
int |
getOffset(int x,
int y)
Returns the offset (in data array elements) of pixel (x,y). |
int[] |
getPixel(int x,
int y,
int[] iArray,
DataBuffer data)
Returns all samples in 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 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 for a specified band for the specified rectangle of pixels in an int array, one sample per array element. |
int[] |
getSampleSize()
Returns the number of bits per sample for all bands. |
int |
getSampleSize(int band)
Returns the number of bits per sample for the specified band. |
int |
getScanlineStride()
Returns the scanline stride of this SinglePixelPackedSampleModel. |
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 array element. |
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 SinglePixelPackedSampleModel(int dataType, int w, int h, int[] bitMasks)
dataType
- The data type for storing samples.w
- The width (in pixels) of the region of the
image data described.h
- The height (in pixels) of the region of the
image data described.bitMasks
- The bit masks for all bands.public SinglePixelPackedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bitMasks)
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 image data.bitMasks
- The bit masks for all bands.bitMask
is not contiguousMethod Detail |
public int getNumDataElements()
public SampleModel createCompatibleSampleModel(int w, int h)
public DataBuffer createDataBuffer()
public int[] getSampleSize()
public int getSampleSize(int band)
public int getOffset(int x, int y)
x,y
can be retrieved from a DataBuffer data
with a
SinglePixelPackedSampleModel sppsm
as:
data.getElem(sppsm.getOffset(x, y));
public int[] getBitOffsets()
public int[] getBitMasks()
public int getScanlineStride()
public SampleModel createSubsetSampleModel(int[] bands)
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
SinglePixelPackedSampleModel sppsm1
, to
DataBuffer db2
, whose storage layout is described by
SinglePixelPackedSampleModel sppsm2
.
The transfer will generally be more efficient than using
getPixel/setPixel.
SinglePixelPackedSampleModel sppsm1, sppsm2; DataBufferInt db1, db2; sppsm2.setDataElements(x, y, sppsm1.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 arraydata
- 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
SinglePixelPackedSampleModel sppsm1
,
to DataBuffer db2
, whose storage layout is described by
SinglePixelPackedSampleModel sppsm2
.
The transfer will generally be more efficient than using
getPixel/setPixel.
SinglePixelPackedSampleModel sppsm1, sppsm2; DataBufferInt db1, db2; sppsm2.setDataElements(x, y, sppsm1.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
- A primitive array containing pixel data.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 samples in an int array.data
- The DataBuffer containing the image data.
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |