java.awt.image.SampleModel
java.awt.image.ComponentSampleModel
is new.
java.lang.Object
public class ComponentSampleModel
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 (using 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 ,
| Field Summary | |
|---|---|
| protected int[] |
bandOffsets
Offsets for all bands in data array elements. |
| protected int[] |
bankIndices
Index for each bank storing a band of image data. |
| protected int |
numBands
The number of bands in this ComponentSampleModel. |
| protected int |
numBanks
The number of banks in this ComponentSampleModel. |
| protected int |
pixelStride
Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel. |
| protected int |
scanlineStride
Line stride (in data array elements) of the region of image data described by this ComponentSampleModel. |
| Fields inherited from class java.awt.image. SampleModel |
|---|
| dataType , height , width |
| Constructor Summary | |
|---|---|
|
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 | |
|---|---|
| SampleModel |
createCompatibleSampleModel
(int w, int h) Creates a new ComponentSampleModel with the specified width and height. |
| DataBuffer |
createDataBuffer
() Creates a DataBuffer that corresponds to this ComponentSampleModel. |
| SampleModel |
createSubsetSampleModel
(int[] bands) Creates a new ComponentSampleModel with a subset of the bands of this ComponentSampleModel. |
| boolean |
equals
(
Object
o) Indicates whether some other object is "equal to" this one. |
| int[] |
getBandOffsets
() Returns the band offset for all bands. |
| int[] |
getBankIndices
() Returns the bank indices 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 a pixel with the getDataElements(int, int, Object, DataBuffer) and setDataElements(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. |
| int |
getPixelStride
() 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. |
| 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 ComponentSampleModel. |
| int |
hashCode
() Returns a hash code value for the object. |
| 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, 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. |
| 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 the DataBuffer 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 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. SampleModel |
|---|
| getDataElements , getDataType , getHeight , getNumBands , getPixel , getPixel , getPixels , getPixels , getSamples , getSamples , getTransferType , getWidth , setDataElements , setPixel , setPixel , setPixels , setPixels , setSamples , setSamples |
| Methods inherited from class java.lang. Object |
|---|
| clone , finalize , getClass , notify , notifyAll , toString , wait , wait , wait |
| Field Detail |
|---|
protected int[] bandOffsets
protected int[] bankIndices
protected int numBands
protected int numBanks
protected int scanlineStride
protected int pixelStride
| Constructor Detail |
|---|
public ComponentSampleModel(int dataType,
int w,
int h,
int pixelStride,
int scanlineStride,
int[] bandOffsets)
public ComponentSampleModel(int dataType,
int w,
int h,
int pixelStride,
int scanlineStride,
int[] bankIndices,
int[] bandOffsets)
| Method Detail |
|---|
public SampleModel createCompatibleSampleModel(int w,
int h)
public SampleModel createSubsetSampleModel(int[] bands)
public DataBuffer createDataBuffer()
public int getOffset(int x,
int y)
data.getElem(csm.getOffset(x, y));
x
X
location of the pixel
y - the Y location of the pixel
public int getOffset(int x,
int y,
int b)
data.getElem(csm.getOffset(x, y, b));
x
X
location of the specified pixel
y - the Y location of the specified pixel
public final int[] getSampleSize()
public final int getSampleSize(int band)
public final int[] getBankIndices()
public final int[] getBandOffsets()
public final int getScanlineStride()
public final int getPixelStride()
public final int getNumDataElements()
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 ComponentSampleModel csm1, to DataBuffer db2, whose storage layout is described by ComponentSampleModel csm2. The transfer is usually more efficient than using getPixel and setPixel.
ComponentSampleModel csm1, csm2;
DataBufferInt db1, db2;
csm2.setDataElements(x, y,
csm1.getDataElements(x, y, null, db1), db2);
Using getDataElements and setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModel objects 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 not null, it should be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds, or if obj is not null and is not large enough to hold the pixel data.
x
X coordinate
y - the Y coordinate of the pixel location
public int[] getPixel(int x,
int y,
int[] iArray,
DataBuffer data)
x
the X coordinate
y - the Y coordinate of the pixel location
public int[] getPixels(int x,
int y,
int w,
int h,
int[] iArray,
DataBuffer data)
x
The X coordinate
y - The Y coordinate of the upper left pixel location
public int getSample(int x,
int y,
int b,
DataBuffer data)
x
X coordinate
y - the Y coordinate of the pixel location
public float getSampleFloat(int x,
int y,
int b,
DataBuffer data)
x
X coordinate
y - The Y coordinate of the pixel location
public double getSampleDouble(int x,
int y,
int b,
DataBuffer data)
x
X coordinate
y - The Y coordinate of the pixel location
public int[] getSamples(int x,
int y,
int w,
int h,
int b,
int[] iArray,
DataBuffer data)
x
The X coordinate
y - The Y coordinate of the upper left pixel location
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 ComponentSampleModel csm1, to DataBuffer db2, whose storage layout is described by ComponentSampleModel csm2. The transfer is usually more efficient than using getPixel and setPixel.
ComponentSampleModel csm1, csm2;
DataBufferInt db1, db2;
csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1),
db2);
Using getDataElements and setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModel objects have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same. A ClassCastException is thrown if obj is not a primitive array of type TransferType. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds, or if obj is not large enough to hold the pixel data.
x
X coordinate
y - the Y coordinate of the pixel location
public void setPixel(int x,
int y,
int[] iArray,
DataBuffer data)
x
X coordinate
y - The Y coordinate of the pixel location
public void setPixels(int x,
int y,
int w,
int h,
int[] iArray,
DataBuffer data)
x
X coordinate
y - The Y coordinate of the upper left pixel location
public void setSample(int x,
int y,
int b,
int s,
DataBuffer data)
x
The X coordinate
y - The Y coordinate of the pixel location
public void setSample(int x,
int y,
int b,
float s,
DataBuffer data)
x
X coordinate
y - The Y coordinate of the pixel location
public void setSample(int x,
int y,
int b,
double s,
DataBuffer data)
x
X coordinate
y - The Y coordinate of the pixel location
public void setSamples(int x,
int y,
int w,
int h,
int b,
int[] iArray,
DataBuffer data)
x
X coordinate
y - The Y coordinate of the upper left pixel location
public boolean equals(Object o)
The equals method implements an equivalence relation on non-null object references:
The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
public int hashCode()
The general contract of hashCode is:
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java TM programming language.)