java.lang.Object | ||
↳ | java.awt.image.SampleModel | |
↳ | java.awt.image.ComponentSampleModel |
Known Direct Subclasses |
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
,
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
bandOffsets | Offsets for all bands in data array elements. | ||||||||||
bankIndices | Index for each bank storing a band of image data. | ||||||||||
numBands | The number of bands in this
ComponentSampleModel . |
||||||||||
numBanks | The number of banks in this
ComponentSampleModel . |
||||||||||
pixelStride | Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel. | ||||||||||
scanlineStride | Line stride (in data array elements) of the region of image data described by this ComponentSampleModel. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.image.SampleModel
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a ComponentSampleModel with the specified parameters.
| |||||||||||
Constructs a ComponentSampleModel with the specified parameters.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new
ComponentSampleModel with the specified
width and height. | |||||||||||
Creates a
DataBuffer that corresponds to this
ComponentSampleModel . | |||||||||||
Creates a new ComponentSampleModel with a subset of the bands
of this ComponentSampleModel.
| |||||||||||
Indicates whether some other object is "equal to" this one.
| |||||||||||
Returns the band offset for all bands.
| |||||||||||
Returns the bank indices for all bands.
| |||||||||||
Returns data for a single pixel in a primitive array of type
TransferType . | |||||||||||
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. | |||||||||||
Gets the offset for band b of pixel (x,y).
| |||||||||||
Gets the offset for the first band of pixel (x,y).
| |||||||||||
Returns all samples for the specified pixel in an int array,
one sample per array element.
| |||||||||||
Returns the pixel stride of this ComponentSampleModel.
| |||||||||||
Returns all samples for the specified rectangle of pixels in
an int array, one sample per array element.
| |||||||||||
Returns as int the sample in a specified band for the pixel
located at (x,y).
| |||||||||||
Returns the sample in a specified band
for a pixel located at (x,y) as a double.
| |||||||||||
Returns the sample in a specified band
for the pixel located at (x,y) as a float.
| |||||||||||
Returns the number of bits per sample for the specified band.
| |||||||||||
Returns the number of bits per sample for all bands.
| |||||||||||
Returns the samples in a specified band for the specified rectangle
of pixels in an int array, one sample per data array element.
| |||||||||||
Returns the scanline stride of this ComponentSampleModel.
| |||||||||||
Returns a hash code value for the object.
| |||||||||||
Sets the data for a single pixel in the specified
DataBuffer from a primitive array of type
TransferType . | |||||||||||
Sets a pixel in the
DataBuffer using an int array of
samples for input. | |||||||||||
Sets all samples for a rectangle of pixels from an int array containing
one sample per array element.
| |||||||||||
Sets a sample in the specified band for the pixel located at (x,y)
in the
DataBuffer using an int for input. | |||||||||||
Sets a sample in the specified band for the pixel located at (x,y)
in the
DataBuffer using a double for input. | |||||||||||
Sets a sample in the specified band for the pixel located at (x,y)
in the
DataBuffer using a float for input. | |||||||||||
Sets the samples in the specified band for the specified rectangle
of pixels from an int array containing one sample per data array element.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.image.SampleModel
| |||||||||||
From class
java.lang.Object
|
Offsets for all bands in data array elements.
Index for each bank storing a band of image data.
The number of bands in this
ComponentSampleModel
.
The number of banks in this
ComponentSampleModel
.
Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.
Line stride (in data array elements) of the region of image data described by this ComponentSampleModel.
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.
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 |
pixelStride | the pixel stride of the region of image data described |
scanlineStride | the line stride of the region of image data described |
bandOffsets | the offsets of all bands |
IllegalArgumentException | if w or
h is not greater than 0 |
---|---|
IllegalArgumentException | if pixelStride
is less than 0 |
IllegalArgumentException | if scanlineStride
is less than 0 |
IllegalArgumentException | if numBands
is less than 1 |
IllegalArgumentException | if the product of w
and h is greater than
Integer.MAX_VALUE |
IllegalArgumentException | if dataType is not
one of the supported data types
|
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.
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 |
pixelStride | the pixel stride of the region of image data described |
scanlineStride | The line stride of the region of image data described |
bankIndices | the bank indices of all bands |
bandOffsets | the band offsets of all bands |
IllegalArgumentException | if w or
h is not greater than 0 |
---|---|
IllegalArgumentException | if pixelStride
is less than 0 |
IllegalArgumentException | if scanlineStride
is less than 0 |
IllegalArgumentException | if the length of
bankIndices does not equal the length of
bankOffsets |
IllegalArgumentException | if any of the bank indices
of bandIndices is less than 0 |
IllegalArgumentException | if dataType is not
one of the supported data types
|
Creates a new ComponentSampleModel
with the specified
width and height. The new SampleModel
will have the same
number of bands, storage data type, interleaving scheme, and
pixel stride as this SampleModel
.
w | the width of the resulting SampleModel |
---|---|
h | the height of the resulting SampleModel |
ComponentSampleModel
with the specified sizeIllegalArgumentException | if w or
h is not greater than 0
|
---|
Creates a DataBuffer
that corresponds to this
ComponentSampleModel
.
The DataBuffer
object's data type, number of banks,
and size are be consistent with this ComponentSampleModel
.
DataBuffer
whose data type, number of banks
and size are consistent with this
ComponentSampleModel
.
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.
bands | a subset of bands from this
ComponentSampleModel |
---|
ComponentSampleModel
created with a subset
of bands from this ComponentSampleModel
.
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y) consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
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.
o | the reference object with which to compare. |
---|
true
if this object is the same as the obj
argument; false
otherwise.Returns the band offset for all bands.
Returns the bank indices for all bands.
Returns data for a single pixel in a primitive array of type
TransferType
. For a ComponentSampleModel
,
this is the same as the data type, and samples are returned
one per array element. Generally, obj
should
be passed in as null
, so that the Object
is 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 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 TransferType
s 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 | 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 |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if obj is too small to hold the ouput. |
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.
For a ComponentSampleModel
, this is identical to the
number of bands.
getDataElements
and
setDataElements
methods.Gets the offset for band b of pixel (x,y).
A sample of band b
can be retrieved from a
DataBuffer
data
with a ComponentSampleModel
csm
as
data.getElem(csm.getOffset(x, y, b));
x | the X location of the specified pixel |
---|---|
y | the Y location of the specified pixel |
b | the specified band |
Gets the offset for the first band of pixel (x,y).
A sample of the first band can be retrieved from a
DataBuffer
data
with a ComponentSampleModel
csm
as
data.getElem(csm.getOffset(x, y));
x | the X location of the pixel |
---|---|
y | the Y location of the pixel |
Returns all samples for the specified pixel in an int array,
one sample per array element.
An ArrayIndexOutOfBoundsException
might be thrown if
the coordinates are not in bounds.
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 |
NullPointerException | if data is null. |
---|---|
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if iArray is too small to hold the output. |
Returns the pixel stride of this ComponentSampleModel.
ComponentSampleModel
.
Returns all samples for the specified rectangle of pixels in
an int array, one sample per array element.
An ArrayIndexOutOfBoundsException
might be thrown if
the coordinates are not in bounds.
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 |
Returns as int the sample in a specified band for the pixel
located at (x,y).
An ArrayIndexOutOfBoundsException
might be thrown if
the coordinates are not in bounds.
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 |
Returns the sample in a specified band
for a pixel located at (x,y) as a double.
An ArrayIndexOutOfBoundsException
might be
thrown if the coordinates are not in bounds.
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 |
Returns the sample in a specified band
for the pixel located at (x,y) as a float.
An ArrayIndexOutOfBoundsException
might be
thrown if the coordinates are not in bounds.
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 |
Returns the number of bits per sample for the specified band.
band | the specified band |
---|
Returns the number of bits per sample for all bands.
Returns the samples in a specified band for the specified rectangle
of pixels in an int array, one sample per data array element.
An ArrayIndexOutOfBoundsException
might be thrown if
the coordinates are not in bounds.
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 |
Returns the scanline stride of this ComponentSampleModel.
ComponentSampleModel
.
Returns a hash code value for the object. This method is
supported for the benefit of hashtables such as those provided by
java.util.Hashtable
.
The general contract of hashCode
is:
hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hashtables.
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 JavaTM programming language.)
Sets the data for a single pixel in the specified
DataBuffer
from a primitive array of type
TransferType
. For a ComponentSampleModel
,
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 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 TransferType
s 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 | 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 |
Sets a pixel in the DataBuffer
using an int array of
samples for input. An ArrayIndexOutOfBoundsException
might be thrown if the coordinates are
not in bounds.
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 |
Sets all samples for a rectangle of pixels from an int array containing
one sample per array element.
An ArrayIndexOutOfBoundsException
might be thrown if the
coordinates are not in bounds.
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 |
Sets a sample in the specified band for the pixel located at (x,y)
in the DataBuffer
using an int for input.
An ArrayIndexOutOfBoundsException
might be thrown if the
coordinates are not in bounds.
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 |
Sets a sample in the specified band for the pixel located at (x,y)
in the DataBuffer
using a double for input.
An ArrayIndexOutOfBoundsException
might be thrown if
the coordinates are not in bounds.
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 a double |
data | The DataBuffer containing the image data |
Sets a sample in the specified band for the pixel located at (x,y)
in the DataBuffer
using a float for input.
An ArrayIndexOutOfBoundsException
might be thrown if
the coordinates are not in bounds.
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 a float |
data | The DataBuffer containing the image 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.
An ArrayIndexOutOfBoundsException
might be thrown if the
coordinates are not in bounds.
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 |