java.lang.Object | |
↳ | java.awt.image.Raster |
Known Direct Subclasses |
Known Indirect Subclasses |
A class representing a rectangular array of pixels. A Raster encapsulates a DataBuffer that stores the sample values and a SampleModel that describes how to locate a given sample value in a DataBuffer.
A Raster defines values for pixels occupying a particular rectangular area of the plane, not necessarily including (0, 0). The rectangle, known as the Raster's bounding rectangle and available by means of the getBounds method, is defined by minX, minY, width, and height values. The minX and minY values define the coordinate of the upper left corner of the Raster. References to pixels outside of the bounding rectangle may result in an exception being thrown, or may result in references to unintended elements of the Raster's associated DataBuffer. It is the user's responsibility to avoid accessing such pixels.
A SampleModel describes how samples of a Raster are stored in the primitive array elements of a DataBuffer. Samples may be stored one per data element, as in a PixelInterleavedSampleModel or BandedSampleModel, or packed several to an element, as in a SinglePixelPackedSampleModel or MultiPixelPackedSampleModel. The SampleModel is also controls whether samples are sign extended, allowing unsigned data to be stored in signed Java data types such as byte, short, and int.
Although a Raster may live anywhere in the plane, a SampleModel makes use of a simple coordinate system that starts at (0, 0). A Raster therefore contains a translation factor that allows pixel locations to be mapped between the Raster's coordinate system and that of the SampleModel. The translation from the SampleModel coordinate system to that of the Raster may be obtained by the getSampleModelTranslateX and getSampleModelTranslateY methods.
A Raster may share a DataBuffer with another Raster either by explicit construction or by the use of the createChild and createTranslatedChild methods. Rasters created by these methods can return a reference to the Raster they were created from by means of the getParent method. For a Raster that was not constructed by means of a call to createTranslatedChild or createChild, getParent will return null.
The createTranslatedChild method returns a new Raster that shares all of the data of the current Raster, but occupies a bounding rectangle of the same width and height but with a different starting point. For example, if the parent Raster occupied the region (10, 10) to (100, 100), and the translated Raster was defined to start at (50, 50), then pixel (20, 20) of the parent and pixel (60, 60) of the child occupy the same location in the DataBuffer shared by the two Rasters. In the first case, (-10, -10) should be added to a pixel coordinate to obtain the corresponding SampleModel coordinate, and in the second case (-50, -50) should be added.
The translation between a parent and child Raster may be determined by subtracting the child's sampleModelTranslateX and sampleModelTranslateY values from those of the parent.
The createChild method may be used to create a new Raster occupying only a subset of its parent's bounding rectangle (with the same or a translated coordinate system) or with a subset of the bands of its parent.
All constructors are protected. The correct way to create a Raster is to use one of the static create methods defined in this class. These methods create instances of Raster that use the standard Interleaved, Banded, and Packed SampleModels and that may be processed more efficiently than a Raster created by combining an externally generated SampleModel and DataBuffer.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
dataBuffer | The DataBuffer that stores the image data. | ||||||||||
height | The height of this Raster. | ||||||||||
minX | The X coordinate of the upper-left pixel of this Raster. | ||||||||||
minY | The Y coordinate of the upper-left pixel of this Raster. | ||||||||||
numBands | The number of bands in the Raster. | ||||||||||
numDataElements | The number of DataBuffer data elements per pixel. | ||||||||||
parent | The parent of this Raster, or null. | ||||||||||
sampleModel | The SampleModel that describes how pixels from this Raster are stored in the DataBuffer. | ||||||||||
sampleModelTranslateX | The X translation from the coordinate space of the Raster's SampleModel to that of the Raster. | ||||||||||
sampleModelTranslateY | The Y translation from the coordinate space of the Raster's SampleModel to that of the Raster. | ||||||||||
width | The width of this Raster. |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a Raster with the given SampleModel.
| |||||||||||
Constructs a Raster with the given SampleModel and DataBuffer.
| |||||||||||
Constructs a Raster with the given SampleModel, DataBuffer, and
parent.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a Raster based on a BandedSampleModel with the
specified DataBuffer, width, height, scanline stride, bank
indices, and band offsets.
| |||||||||||
Creates a Raster based on a BandedSampleModel with the
specified data type, width, height, scanline stride, bank
indices and band offsets.
| |||||||||||
Creates a Raster based on a BandedSampleModel with the
specified data type, width, height, and number of bands.
| |||||||||||
Returns a new Raster which shares all or part of this Raster's
DataBuffer.
| |||||||||||
Create a compatible WritableRaster with location (minX, minY)
and size (width, height) specified by rect, a
new SampleModel, and a new initialized DataBuffer.
| |||||||||||
Create a compatible WritableRaster with the specified size, a new
SampleModel, and a new initialized DataBuffer.
| |||||||||||
Create a compatible WritableRaster the same size as this Raster with
the same SampleModel and a new initialized DataBuffer.
| |||||||||||
Create a compatible WritableRaster with the specified
location (minX, minY) and size (width, height), a
new SampleModel, and a new initialized DataBuffer.
| |||||||||||
Creates a Raster based on a PixelInterleavedSampleModel with the
specified data type, width, height, and number of bands.
| |||||||||||
Creates a Raster based on a PixelInterleavedSampleModel with the
specified DataBuffer, width, height, scanline stride, pixel
stride, and band offsets.
| |||||||||||
Creates a Raster based on a PixelInterleavedSampleModel with the
specified data type, width, height, scanline stride, pixel
stride, and band offsets.
| |||||||||||
Creates a Raster based on a packed SampleModel with the
specified data type, width, height, number of bands, and bits
per band.
| |||||||||||
Creates a Raster based on a MultiPixelPackedSampleModel with the
specified DataBuffer, width, height, and bits per pixel.
| |||||||||||
Creates a Raster based on a SinglePixelPackedSampleModel with
the specified DataBuffer, width, height, scanline stride, and
band masks.
| |||||||||||
Creates a Raster based on a SinglePixelPackedSampleModel with
the specified data type, width, height, and band masks.
| |||||||||||
Creates a Raster with the specified SampleModel and DataBuffer.
| |||||||||||
Create a Raster with the same size, SampleModel and DataBuffer
as this one, but with a different location.
| |||||||||||
Creates a WritableRaster with the specified SampleModel and DataBuffer.
| |||||||||||
Creates a WritableRaster with the specified SampleModel.
| |||||||||||
Returns the bounding Rectangle of this Raster.
| |||||||||||
Returns the DataBuffer associated with this Raster.
| |||||||||||
Returns the pixel data for the specified rectangle of pixels in a
primitive array of type TransferType.
| |||||||||||
Returns data for a single pixel in a primitive array of type
TransferType.
| |||||||||||
Returns the height in pixels of the Raster.
| |||||||||||
Returns the minimum valid X coordinate of the Raster.
| |||||||||||
Returns the minimum valid Y coordinate of the Raster.
| |||||||||||
Returns the number of bands (samples per pixel) in this Raster.
| |||||||||||
Returns the number of data elements needed to transfer one pixel
via the getDataElements and setDataElements methods.
| |||||||||||
Returns the parent Raster (if any) of this Raster or null.
| |||||||||||
Returns the samples in an array of int for the specified pixel.
| |||||||||||
Returns the samples in an array of float for the
specified pixel.
| |||||||||||
Returns the samples in an array of double for the specified pixel.
| |||||||||||
Returns a float array containing all samples for a rectangle of pixels,
one sample per array element.
| |||||||||||
Returns a double array containing all samples for a rectangle of pixels,
one sample per array element.
| |||||||||||
Returns an int array containing all samples for a rectangle of pixels,
one sample per array element.
| |||||||||||
Returns the sample in a specified band for the pixel located
at (x,y) as an int.
| |||||||||||
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 SampleModel that describes the layout of the image data.
| |||||||||||
Returns the X translation from the coordinate system of the
SampleModel to that of the Raster.
| |||||||||||
Returns the Y translation from the coordinate system of the
SampleModel to that of the Raster.
| |||||||||||
Returns the samples for a specified band for the specified rectangle
of pixels in an int array, one sample per array element.
| |||||||||||
Returns the samples for a specified band for the specified rectangle
of pixels in a float array, one sample per array element.
| |||||||||||
Returns the samples for a specified band for a specified rectangle
of pixels in a double array, one sample per array element.
| |||||||||||
Returns the TransferType used to transfer pixels via the
getDataElements and setDataElements methods.
| |||||||||||
Returns the width in pixels of the Raster.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
The height of this Raster.
The X coordinate of the upper-left pixel of this Raster.
The Y coordinate of the upper-left pixel of this Raster.
The number of bands in the Raster.
The number of DataBuffer data elements per pixel.
The SampleModel that describes how pixels from this Raster are stored in the DataBuffer.
The X translation from the coordinate space of the Raster's SampleModel to that of the Raster.
The Y translation from the coordinate space of the Raster's SampleModel to that of the Raster.
The width of this Raster.
Constructs a Raster with the given SampleModel. The Raster's upper left corner is origin and it is the same size as the SampleModel. A DataBuffer large enough to describe the Raster is automatically created.
sampleModel | The SampleModel that specifies the layout |
---|---|
origin | The Point that specified the origin |
RasterFormatException | if computing either
origin.x + sampleModel.getWidth() or
origin.y + sampleModel.getHeight() results in
integer overflow |
---|---|
NullPointerException | either sampleModel or
origin is null
|
Constructs a Raster with the given SampleModel and DataBuffer. The Raster's upper left corner is origin and it is the same size as the SampleModel. The DataBuffer is not initialized and must be compatible with SampleModel.
sampleModel | The SampleModel that specifies the layout |
---|---|
dataBuffer | The DataBuffer that contains the image data |
origin | The Point that specifies the origin |
RasterFormatException | if computing either
origin.x + sampleModel.getWidth() or
origin.y + sampleModel.getHeight() results in
integer overflow |
---|---|
NullPointerException | either sampleModel or
origin is null
|
Constructs a Raster with the given SampleModel, DataBuffer, and parent. aRegion specifies the bounding rectangle of the new Raster. When translated into the base Raster's coordinate system, aRegion must be contained by the base Raster. (The base Raster is the Raster's ancestor which has no parent.) sampleModelTranslate specifies the sampleModelTranslateX and sampleModelTranslateY values of the new Raster. Note that this constructor should generally be called by other constructors or create methods, it should not be used directly.
sampleModel | The SampleModel that specifies the layout |
---|---|
dataBuffer | The DataBuffer that contains the image data |
aRegion | The Rectangle that specifies the image area |
sampleModelTranslate | The Point that specifies the translation from SampleModel to Raster coordinates |
parent | The parent (if any) of this raster |
NullPointerException | if any of sampleModel ,
dataBuffer , aRegion or
sampleModelTranslate is null |
---|---|
RasterFormatException | if aRegion has width
or height less than or equal to zero, or computing either
aRegion.x + aRegion.width or
aRegion.y + aRegion.height results in integer
overflow
|
Creates a Raster based on a BandedSampleModel with the specified DataBuffer, width, height, scanline stride, bank indices, and band offsets. The number of bands is inferred from bankIndices.length and bandOffsets.length, which must be the same. The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used.
dataBuffer | the DataBuffer that contains the
image data |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
scanlineStride | the line stride of the image data |
bankIndices | the bank indices for each band |
bandOffsets | the offsets of all bands |
location | the upper-left corner of the Raster |
DataBuffer
, width, height, scanline stride,
bank indices and band offsets.RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE ,
DataBuffer.TYPE_USHORT
or DataBuffer.TYPE_INT |
NullPointerException | if dataBuffer is null
|
Creates a Raster based on a BandedSampleModel with the specified data type, width, height, scanline stride, bank indices and band offsets. The number of bands is inferred from bankIndices.length and bandOffsets.length, which must be the same.
The upper left corner of the Raster is given by the location argument. The dataType parameter should be one of the enumerated values defined in the DataBuffer class.
The only dataTypes supported currently are TYPE_BYTE, TYPE_USHORT, and TYPE_INT.
dataType | the data type for storing samples |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
scanlineStride | the line stride of the image data |
bankIndices | the bank indices for each band |
bandOffsets | the offsets of all bands |
location | the upper-left corner of the Raster |
RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE ,
DataBuffer.TYPE_USHORT
or DataBuffer.TYPE_INT |
ArrayIndexOutOfBoundsException | if bankIndices
or bandOffsets is null
|
Creates a Raster based on a BandedSampleModel with the specified data type, width, height, and number of bands.
The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used. The dataType parameter should be one of the enumerated values defined in the DataBuffer class.
The only dataTypes supported currently are TYPE_BYTE, TYPE_USHORT, and TYPE_INT.
dataType | the data type for storing samples |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
bands | the number of bands |
location | the upper-left corner of the Raster |
RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
ArrayIndexOutOfBoundsException | if bands
is less than 1
|
Returns a new Raster which shares all or part of this Raster's DataBuffer. The new Raster will possess a reference to the current Raster, accessible through its getParent() method.
The parentX, parentY, width and height parameters form a Rectangle in this Raster's coordinate space, indicating the area of pixels to be shared. An error will be thrown if this Rectangle is not contained with the bounds of the current Raster.
The new Raster may additionally be translated to a different coordinate system for the plane than that used by the current Raster. The childMinX and childMinY parameters give the new (x, y) coordinate of the upper-left pixel of the returned Raster; the coordinate (childMinX, childMinY) in the new Raster will map to the same pixel as the coordinate (parentX, parentY) in the current Raster.
The new Raster may be defined to contain only a subset of the bands of the current Raster, possibly reordered, by means of the bandList parameter. If bandList is null, it is taken to include all of the bands of the current Raster in their current order.
To create a new Raster that contains a subregion of the current Raster, but shares its coordinate system and bands, this method should be called with childMinX equal to parentX, childMinY equal to parentY, and bandList equal to null.
parentX | The X coordinate of the upper-left corner in this Raster's coordinates |
---|---|
parentY | The Y coordinate of the upper-left corner in this Raster's coordinates |
width | Width of the region starting at (parentX, parentY) |
height | Height of the region starting at (parentX, parentY). |
childMinX | The X coordinate of the upper-left corner of the returned Raster |
childMinY | The Y coordinate of the upper-left corner of the returned Raster |
bandList | Array of band indices, or null to use all bands |
Raster
.RasterFormatException | if the specified subregion is outside of the raster bounds. |
---|---|
RasterFormatException | if width or
height
is less than or equal to zero, or computing any of
parentX + width , parentY + height ,
childMinX + width , or
childMinY + height results in integer
overflow
|
Create a compatible WritableRaster with location (minX, minY) and size (width, height) specified by rect, a new SampleModel, and a new initialized DataBuffer.
rect | a Rectangle that specifies the size and
location of the WritableRaster |
---|
WritableRaster
with the specified
size and location and a new sample model and data buffer.RasterFormatException | if rect has width
or height less than or equal to zero, or computing either
rect.x + rect.width or
rect.y + rect.height results in integer
overflow |
---|---|
NullPointerException | if rect is null
|
Create a compatible WritableRaster with the specified size, a new SampleModel, and a new initialized DataBuffer.
w | the specified width of the new WritableRaster |
---|---|
h | the specified height of the new WritableRaster |
WritableRaster
with the specified
size and a new sample model and data buffer.RasterFormatException | if the width or height is less than or equal to zero. |
---|
Create a compatible WritableRaster the same size as this Raster with the same SampleModel and a new initialized DataBuffer.
WritableRaster
with the same sample
model and a new data buffer.
Create a compatible WritableRaster with the specified location (minX, minY) and size (width, height), a new SampleModel, and a new initialized DataBuffer.
x | the X coordinate of the upper-left corner of
the WritableRaster |
---|---|
y | the Y coordinate of the upper-left corner of
the WritableRaster |
w | the specified width of the WritableRaster |
h | the specified height of the WritableRaster |
WritableRaster
with the specified
size and location and a new sample model and data buffer.RasterFormatException | if w or h
is less than or equal to zero, or computing either
x + w or
y + h results in integer
overflow
|
---|
Creates a Raster based on a PixelInterleavedSampleModel with the specified data type, width, height, and number of bands.
The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used. The dataType parameter should be one of the enumerated values defined in the DataBuffer class.
Note that interleaved DataBuffer.TYPE_INT
Rasters are not supported. To create a 1-band Raster of type
DataBuffer.TYPE_INT
, use
Raster.createPackedRaster().
The only dataTypes supported currently are TYPE_BYTE and TYPE_USHORT.
dataType | the data type for storing samples |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
bands | the number of bands |
location | the upper-left corner of the Raster |
RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow
|
---|
Creates a Raster based on a PixelInterleavedSampleModel with the specified DataBuffer, width, height, scanline stride, pixel stride, and band offsets. The number of bands is inferred from bandOffsets.length. The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used.
Note that interleaved DataBuffer.TYPE_INT
Rasters are not supported. To create a 1-band Raster of type
DataBuffer.TYPE_INT
, use
Raster.createPackedRaster().
dataBuffer | the DataBuffer that contains the
image data |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
scanlineStride | the line stride of the image data |
pixelStride | the pixel stride of the image data |
bandOffsets | the offsets of all bands |
location | the upper-left corner of the Raster |
DataBuffer
, width, height, scanline stride,
pixel stride and band offsets.RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE ,
DataBuffer.TYPE_USHORT |
RasterFormatException | if dataBuffer has more
than one bank. |
NullPointerException | if dataBuffer is null
|
Creates a Raster based on a PixelInterleavedSampleModel with the specified data type, width, height, scanline stride, pixel stride, and band offsets. The number of bands is inferred from bandOffsets.length.
The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used. The dataType parameter should be one of the enumerated values defined in the DataBuffer class.
Note that interleaved DataBuffer.TYPE_INT
Rasters are not supported. To create a 1-band Raster of type
DataBuffer.TYPE_INT
, use
Raster.createPackedRaster().
The only dataTypes supported currently are TYPE_BYTE and TYPE_USHORT.
dataType | the data type for storing samples |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
scanlineStride | the line stride of the image data |
pixelStride | the pixel stride of the image data |
bandOffsets | the offsets of all bands |
location | the upper-left corner of the Raster |
RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE , or
DataBuffer.TYPE_USHORT .
|
Creates a Raster based on a packed SampleModel with the specified data type, width, height, number of bands, and bits per band. If the number of bands is one, the SampleModel will be a MultiPixelPackedSampleModel.
If the number of bands is more than one, the SampleModel will be a SinglePixelPackedSampleModel, with each band having bitsPerBand bits. In either case, the requirements on dataType and bitsPerBand imposed by the corresponding SampleModel must be met.
The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used. The dataType parameter should be one of the enumerated values defined in the DataBuffer class.
The only dataTypes supported currently are TYPE_BYTE, TYPE_USHORT, and TYPE_INT.
dataType | the data type for storing samples |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
bands | the number of bands |
bitsPerBand | the number of bits per band |
location | the upper-left corner of the Raster |
RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if the product of
bitsPerBand and bands is
greater than the number of bits held by
dataType |
IllegalArgumentException | if bitsPerBand or
bands is not greater than zero |
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE ,
DataBuffer.TYPE_USHORT
or DataBuffer.TYPE_INT
|
Creates a Raster based on a MultiPixelPackedSampleModel with the specified DataBuffer, width, height, and bits per pixel. The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used.
dataBuffer | the DataBuffer that contains the
image data |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
bitsPerPixel | the number of bits for each pixel |
location | the upper-left corner of the Raster |
DataBuffer
, width, height, and
bits per pixel.RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE ,
DataBuffer.TYPE_USHORT
or DataBuffer.TYPE_INT |
RasterFormatException | if dataBuffer has more
than one bank. |
NullPointerException | if dataBuffer is null
|
Creates a Raster based on a SinglePixelPackedSampleModel with the specified DataBuffer, width, height, scanline stride, and band masks. The number of bands is inferred from bandMasks.length. The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used.
dataBuffer | the DataBuffer that contains the
image data |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
scanlineStride | the line stride of the image data |
bandMasks | an array containing an entry for each band |
location | the upper-left corner of the Raster |
DataBuffer
, width, height, scanline stride,
and band masks.RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE ,
DataBuffer.TYPE_USHORT
or DataBuffer.TYPE_INT |
RasterFormatException | if dataBuffer has more
than one bank. |
NullPointerException | if dataBuffer is null
|
Creates a Raster based on a SinglePixelPackedSampleModel with the specified data type, width, height, and band masks. The number of bands is inferred from bandMasks.length.
The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used. The dataType parameter should be one of the enumerated values defined in the DataBuffer class.
The only dataTypes supported currently are TYPE_BYTE, TYPE_USHORT, and TYPE_INT.
dataType | the data type for storing samples |
---|---|
w | the width in pixels of the image data |
h | the height in pixels of the image data |
bandMasks | an array containing an entry for each band |
location | the upper-left corner of the Raster |
RasterFormatException | if w or h
is less than or equal to zero, or computing either
location.x + w or
location.y + h results in integer
overflow |
---|---|
IllegalArgumentException | if dataType is not
one of the supported data types, which are
DataBuffer.TYPE_BYTE ,
DataBuffer.TYPE_USHORT
or DataBuffer.TYPE_INT
|
Creates a Raster with the specified SampleModel and DataBuffer. The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used.
sm | the specified SampleModel |
---|---|
db | the specified DataBuffer |
location | the upper-left corner of the Raster |
Raster
with the specified
SampleModel
, DataBuffer
, and
location.RasterFormatException | if computing either
location.x + sm.getWidth() or
location.y + sm.getHeight() results in integer
overflow |
---|---|
RasterFormatException | if db has more
than one bank and sm is a
PixelInterleavedSampleModel, SinglePixelPackedSampleModel,
or MultiPixelPackedSampleModel. |
NullPointerException | if either SampleModel or DataBuffer is null |
Create a Raster with the same size, SampleModel and DataBuffer as this one, but with a different location. The new Raster will possess a reference to the current Raster, accessible through its getParent() method.
childMinX | the X coordinate of the upper-left
corner of the new Raster |
---|---|
childMinY | the Y coordinate of the upper-left
corner of the new Raster |
Raster
with the same size, SampleModel,
and DataBuffer as this Raster
, but with the
specified location.RasterFormatException | if computing either
childMinX + this.getWidth() or
childMinY + this.getHeight() results in integer
overflow
|
---|
Creates a WritableRaster with the specified SampleModel and DataBuffer. The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used.
sm | the specified SampleModel |
---|---|
db | the specified DataBuffer |
location | the upper-left corner of the
WritableRaster |
WritableRaster
with the specified
SampleModel
, DataBuffer
, and
location.RasterFormatException | if computing either
location.x + sm.getWidth() or
location.y + sm.getHeight() results in integer
overflow |
---|---|
RasterFormatException | if db has more
than one bank and sm is a
PixelInterleavedSampleModel, SinglePixelPackedSampleModel,
or MultiPixelPackedSampleModel. |
NullPointerException | if either SampleModel or DataBuffer is null |
Creates a WritableRaster with the specified SampleModel. The upper left corner of the Raster is given by the location argument. If location is null, (0, 0) will be used.
sm | the specified SampleModel |
---|---|
location | the upper-left corner of the
WritableRaster |
WritableRaster
with the specified
SampleModel
and location.RasterFormatException | if computing either
location.x + sm.getWidth() or
location.y + sm.getHeight() results in integer
overflow
|
---|
Returns the bounding Rectangle of this Raster. This function returns the same information as getMinX/MinY/Width/Height.
Raster
.
Returns the DataBuffer associated with this Raster.
DataBuffer
of this Raster
.
Returns the pixel data for the specified rectangle of pixels in a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data may be returned in a packed format, thus increasing efficiency for data transfers. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed. A ClassCastException will be thrown if the input object is non null and references anything other than an array of TransferType.
x | The X coordinate of the upper-left pixel location |
---|---|
y | The Y coordinate of the upper-left pixel location |
w | Width of the pixel rectangle |
h | Height of the pixel rectangle |
outData | An object reference to an array of type defined by getTransferType() and length w*h*getNumDataElements(). If null, an array of appropriate type and size will be allocated. |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if outData is too small to hold the output. |
---|
Returns data for a single pixel in a primitive array of type TransferType. For image data supported by the Java 2D(tm) API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data may be returned in a packed format, thus increasing efficiency for data transfers. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed. A ClassCastException will be thrown if the input object is non null and references anything other than an array of TransferType.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
outData | An object reference to an array of type defined by getTransferType() and length getNumDataElements(). If null, an array of appropriate type and size will be allocated |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if outData is too small to hold the output. |
---|
Returns the height in pixels of the Raster.
Raster
.
Returns the minimum valid X coordinate of the Raster.
Raster
.
Returns the minimum valid Y coordinate of the Raster.
Raster
.
Returns the number of bands (samples per pixel) in this Raster.
Raster
.
Returns the number of data elements needed to transfer one pixel via the getDataElements and setDataElements methods. When pixels are transferred via these methods, they may be transferred in a packed or unpacked format, depending on the implementation of the underlying SampleModel. Using these methods, pixels are transferred as an array of getNumDataElements() elements of a primitive type given by getTransferType(). The TransferType may or may not be the same as the storage data type of the DataBuffer.
Returns the parent Raster (if any) of this Raster or null.
null
.
Returns the samples in an array of int for the specified pixel. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
iArray | An optionally preallocated int array |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if iArray is too small to hold the output. |
---|
Returns the samples in an array of float for the specified pixel. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
fArray | An optionally preallocated float array |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if fArray is too small to hold the output. |
---|
Returns the samples in an array of double for the specified pixel. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
dArray | An optionally preallocated double array |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if dArray is too small to hold the output. |
---|
Returns a float array containing all samples for a rectangle of pixels, one sample per array element. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
w | Width of the pixel rectangle |
h | Height of the pixel rectangle |
fArray | An optionally pre-allocated float array |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if fArray is too small to hold the output. |
---|
Returns a double array containing all samples for a rectangle of pixels, one sample per array element. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the upper-left pixel location |
---|---|
y | The Y coordinate of the upper-left pixel location |
w | Width of the pixel rectangle |
h | Height of the pixel rectangle |
dArray | An optionally pre-allocated double array |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if dArray is too small to hold the output. |
---|
Returns an int array containing all samples for a rectangle of pixels, one sample per array element. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the upper-left pixel location |
---|---|
y | The Y coordinate of the upper-left pixel location |
w | Width of the pixel rectangle |
h | Height of the pixel rectangle |
iArray | An optionally pre-allocated int array |
ArrayIndexOutOfBoundsException | if the coordinates are not in bounds, or if iArray is too small to hold the output. |
---|
Returns the sample in a specified band for the pixel located at (x,y) as an int. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
b | The band to return |
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
---|
Returns the sample in a specified band for a pixel located at (x,y) as a double. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
b | The band to return |
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
---|
Returns the sample in a specified band for the pixel located at (x,y) as a float. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the pixel location |
---|---|
y | The Y coordinate of the pixel location |
b | The band to return |
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds. |
---|
Returns the SampleModel that describes the layout of the image data.
SampleModel
of this Raster
.
Returns the X translation from the coordinate system of the SampleModel to that of the Raster. To convert a pixel's X coordinate from the Raster coordinate system to the SampleModel coordinate system, this value must be subtracted.
Returns the Y translation from the coordinate system of the SampleModel to that of the Raster. To convert a pixel's Y coordinate from the Raster coordinate system to the SampleModel coordinate system, this value must be subtracted.
Returns the samples for a specified band for the specified rectangle of pixels in an int array, one sample per array element. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the upper-left pixel location |
---|---|
y | The Y coordinate of the upper-left pixel location |
w | Width of the pixel rectangle |
h | Height of the pixel rectangle |
b | The band to return |
iArray | An optionally pre-allocated int array |
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if iArray is too small to hold the output. |
---|
Returns the samples for a specified band for the specified rectangle of pixels in a float array, one sample per array element. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the upper-left pixel location |
---|---|
y | The Y coordinate of the upper-left pixel location |
w | Width of the pixel rectangle |
h | Height of the pixel rectangle |
b | The band to return |
fArray | An optionally pre-allocated float array |
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if fArray is too small to hold the output. |
---|
Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x | The X coordinate of the upper-left pixel location |
---|---|
y | The Y coordinate of the upper-left pixel location |
w | Width of the pixel rectangle |
h | Height of the pixel rectangle |
b | The band to return |
dArray | An optionally pre-allocated double array |
ArrayIndexOutOfBoundsException | if the coordinates or the band index are not in bounds, or if dArray is too small to hold the output. |
---|
Returns the TransferType used to transfer pixels via the getDataElements and setDataElements methods. When pixels are transferred via these methods, they may be transferred in a packed or unpacked format, depending on the implementation of the underlying SampleModel. Using these methods, pixels are transferred as an array of getNumDataElements() elements of a primitive type given by getTransferType(). The TransferType may or may not be the same as the storage data type of the DataBuffer. The TransferType will be one of the types defined in DataBuffer.
Returns the width in pixels of the Raster.
Raster
.