APIdia Launch Partner
Top Description Fields Constructors Methods
sun.awt.image

public Class IntegerInterleavedRaster

extends IntegerComponentRaster
Class Inheritance
Imports
java.awt.image.Raster, .WritableRaster, .RasterFormatException, .SampleModel, .SinglePixelPackedSampleModel, .DataBufferInt, java.awt.Rectangle, .Point

This class defines a Raster with pixels consisting of one or more 32-bit data elements stored in close proximity to each other in a integer array. The bit precision per data element is that of the data type (that is, the bit precision for this raster is 32). There is only one pixel stride and one scanline stride for all bands. For a given pixel, all samples fit in N data elements and these N data elements hold samples for only one pixel. This type of Raster can be used with a PackedColorModel.

For example, if there is only one data element per pixel, a SinglePixelPackedSampleModel can be used to represent multiple bands with a PackedColorModel (including a DirectColorModel) for color interpretation.

Field Summary

Modifier and TypeField and Description
private int
maxX

Hides sun.awt.image.IntegerComponentRaster.maxX.

A cached copy of minX + width for use in bounds checks.
private int
maxY

Hides sun.awt.image.IntegerComponentRaster.maxY.

A cached copy of minY + height for use in bounds checks.
Inherited from sun.awt.image.IntegerComponentRaster:
bandOffsetdatadataOffsetsnumDataElemspixelStridescanlineStridetypeTYPE_BYTE_BANDED_SAMPLESTYPE_BYTE_BINARY_SAMPLESTYPE_BYTE_PACKED_SAMPLESTYPE_BYTE_SAMPLESTYPE_CUSTOMTYPE_INT_8BIT_SAMPLESTYPE_INT_BANDED_SAMPLESTYPE_INT_PACKED_SAMPLESTYPE_INT_SAMPLESTYPE_USHORT_BANDED_SAMPLESTYPE_USHORT_PACKED_SAMPLESTYPE_USHORT_SAMPLES

Constructor Summary

AccessConstructor and Description
public
IntegerInterleavedRaster(SampleModel
The SampleModel that specifies the layout.
sampleModel
,
Point
The Point that specified the origin.
origin
)

Constructs a IntegerInterleavedRaster with the given SampleModel.

public
IntegerInterleavedRaster(SampleModel
The SampleModel that specifies the layout.
sampleModel
,
DataBufferInt
The DataBufferInt that contains the image data.
dataBuffer
,
Point
The Point that specifies the origin.
origin
)

Constructs a IntegerInterleavedRaster with the given SampleModel and DataBuffer.

public
IntegerInterleavedRaster(SampleModel
The SampleModel that specifies the layout.
sampleModel
,
DataBufferInt
The DataBufferInt that contains the image data.
dataBuffer
,
Rectangle
The Rectangle that specifies the image area.
aRegion
,
Point
The Point that specifies the origin.
origin
,
IntegerInterleavedRaster
The parent (if any) of this raster.
parent
)

Constructs a IntegerInterleavedRaster with the given SampleModel, DataBuffer, and parent.

Method Summary

Modifier and TypeMethod and Description
public Raster
createChild(int
X offset.
x
,
int
Y offset.
y
,
int
Width (in pixels) of the subraster.
width
,
int
Height (in pixels) of the subraster.
height
,
int
Translated X origin of the subRaster.
x0
,
int
Translated Y origin of the subRaster.
y0
,
int[]
Array of band indices.
bandList
)

Overrides sun.awt.image.IntegerComponentRaster.createChild.

Creates a subraster given a region of the raster.

public WritableRaster
createCompatibleWritableRaster(int w, int h)

Overrides sun.awt.image.IntegerComponentRaster.createCompatibleWritableRaster.

Creates a raster with the same band layout but using a different width and height, and with new zeroed data arrays.

public WritableRaster
createCompatibleWritableRaster()

Overrides sun.awt.image.IntegerComponentRaster.createCompatibleWritableRaster.

Creates a raster with the same data layout and the same width and height, and with new zeroed data arrays.

public WritableRaster
createWritableChild(int
X offset.
x
,
int
Y offset.
y
,
int
Width (in pixels) of the subraster.
width
,
int
Height (in pixels) of the subraster.
height
,
int
Translated X origin of the subraster.
x0
,
int
Translated Y origin of the subraster.
y0
,
int[]
Array of band indices.
bandList
)

Overrides sun.awt.image.IntegerComponentRaster.createWritableChild.

Creates a subraster given a region of the raster.

public Object

Returns:

An object reference to an array of type defined by getTransferType() with the request pixel data.
getDataElements
(int
The X coordinate of the pixel location.
x
,
int
The Y coordinate of the pixel location.
y
,
Object
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.
obj
)

Overrides sun.awt.image.IntegerComponentRaster.getDataElements.

Returns the data elements for all bands at the specified location.

public Object

Returns:

An object reference to an array of type defined by getTransferType() with the request pixel data.
getDataElements
(int
The X coordinate of the upper left pixel location.
x
,
int
The Y coordinate of the upper left pixel location.
y
,
int
Width of the pixel rectangle.
w
,
int
Height of the pixel rectangle.
h
,
Object
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.
obj
)

Overrides sun.awt.image.IntegerComponentRaster.getDataElements.

Returns an array of data elements from the specified rectangular region.

public int
getDataOffset(int band)

Overrides sun.awt.image.IntegerComponentRaster.getDataOffset.

Returns data offset for the specified band.

public int[]
getDataOffsets()

Overrides sun.awt.image.IntegerComponentRaster.getDataOffsets.

Returns a copy of the data offsets array.

public int[]
getDataStorage()

Overrides sun.awt.image.IntegerComponentRaster.getDataStorage.

Returns a reference to the data array.

public int
getPixelStride()

Overrides sun.awt.image.IntegerComponentRaster.getPixelStride.

Returns pixel stride -- the number of data array elements between two samples for the same band on the same scanline.

public int
getScanlineStride()

Overrides sun.awt.image.IntegerComponentRaster.getScanlineStride.

Returns the scanline stride -- the number of data array elements between a given sample and the sample in the same column of the next row.

public void
setDataElements(int
The X coordinate of the pixel location.
x
,
int
The Y coordinate of the pixel location.
y
,
Object
An object reference to an array of type defined by getTransferType() and length getNumDataElements() containing the pixel data to place at x,y.
obj
)

Overrides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores the data elements for all bands at the specified location.

public void
setDataElements(int
The X coordinate of the pixel location.
x
,
int
The Y coordinate of the pixel location.
y
,
Raster
Raster of data to place at x,y location.
inRaster
)

Overrides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores the Raster data at the specified location.

private void
setDataElements(int
The absolute X coordinate of the destination pixel that will receive a copy of the upper-left pixel of the inRaster
dstX
,
int
The absolute Y coordinate of the destination pixel that will receive a copy of the upper-left pixel of the inRaster
dstY
,
int
The number of pixels to store horizontally
width
,
int
The number of pixels to store vertically
height
,
Raster
Raster of data to place at x,y location.
inRaster
)

Hides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores the Raster data at the specified location.

public void
setDataElements(int
The X coordinate of the upper left pixel location.
x
,
int
The Y coordinate of the upper left pixel location.
y
,
int
Width of the pixel rectangle.
w
,
int
Height of the pixel rectangle.
h
,
Object
An object reference to an array of type defined by getTransferType() and length w*h*getNumDataElements() containing the pixel data to place between x,y and x+h, y+h.
obj
)

Overrides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores an array of data elements into the specified rectangular region.

public String
toString()

Overrides sun.awt.image.IntegerComponentRaster.toString.

Returns a string representation of the object.

Inherited from sun.awt.image.IntegerComponentRaster:
verify

Field Detail

maxXback to summary
private int maxX

Hides sun.awt.image.IntegerComponentRaster.maxX.

A cached copy of minX + width for use in bounds checks.

maxYback to summary
private int maxY

Hides sun.awt.image.IntegerComponentRaster.maxY.

A cached copy of minY + height for use in bounds checks.

Constructor Detail

IntegerInterleavedRasterback to summary
public IntegerInterleavedRaster(SampleModel sampleModel, Point origin)

Constructs a IntegerInterleavedRaster 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 must be of type SinglePixelPackedSampleModel.

Parameters
sampleModel:SampleModel

The SampleModel that specifies the layout.

origin:Point

The Point that specified the origin.

IntegerInterleavedRasterback to summary
public IntegerInterleavedRaster(SampleModel sampleModel, DataBufferInt dataBuffer, Point origin)

Constructs a IntegerInterleavedRaster with the given SampleModel and DataBuffer. The Raster's upper left corner is origin and it is the same sizes the SampleModel. The DataBuffer is not initialized and must be a DataBufferInt compatible with SampleModel. SampleModel must be of type SinglePixelPackedSampleModel.

Parameters
sampleModel:SampleModel

The SampleModel that specifies the layout.

dataBuffer:DataBufferInt

The DataBufferInt that contains the image data.

origin:Point

The Point that specifies the origin.

IntegerInterleavedRasterback to summary
public IntegerInterleavedRaster(SampleModel sampleModel, DataBufferInt dataBuffer, Rectangle aRegion, Point origin, IntegerInterleavedRaster parent)

Constructs a IntegerInterleavedRaster with the given SampleModel, DataBuffer, and parent. DataBuffer must be a DataBufferInt and SampleModel must be of type SinglePixelPackedSampleModel. When translated into the base Raster's coordinate system, aRegion must be contained by the base Raster. Origin is the coordinate in the new Raster's coordinate system of the origin of the base Raster. (The base Raster is the Raster's ancestor which has no parent.) Note that this constructor should generally be called by other constructors or create methods, it should not be used directly.

Parameters
sampleModel:SampleModel

The SampleModel that specifies the layout.

dataBuffer:DataBufferInt

The DataBufferInt that contains the image data.

aRegion:Rectangle

The Rectangle that specifies the image area.

origin:Point

The Point that specifies the origin.

parent:IntegerInterleavedRaster

The parent (if any) of this raster.

Method Detail

createChildback to summary
public Raster createChild(int x, int y, int width, int height, int x0, int y0, int[] bandList)

Overrides sun.awt.image.IntegerComponentRaster.createChild.

Creates a subraster given a region of the raster. The x and y coordinates specify the horizontal and vertical offsets from the upper-left corner of this raster to the upper-left corner of the subraster. A subset of the bands of the parent raster may be specified. If this is null, then all the bands are present in the subRaster. Note that the subraster will reference the same DataBuffer as the parent raster, but using different offsets.

Parameters
x:int

X offset.

y:int

Y offset.

width:int

Width (in pixels) of the subraster.

height:int

Height (in pixels) of the subraster.

x0:int

Translated X origin of the subRaster.

y0:int

Translated Y origin of the subRaster.

bandList:int[]

Array of band indices.

Exceptions
RasterFormatException:
if the specified bounding box is outside of the parent raster.
createCompatibleWritableRasterback to summary
public WritableRaster createCompatibleWritableRaster(int w, int h)

Overrides sun.awt.image.IntegerComponentRaster.createCompatibleWritableRaster.

Creates a raster with the same band layout but using a different width and height, and with new zeroed data arrays.

createCompatibleWritableRasterback to summary
public WritableRaster createCompatibleWritableRaster()

Overrides sun.awt.image.IntegerComponentRaster.createCompatibleWritableRaster.

Creates a raster with the same data layout and the same width and height, and with new zeroed data arrays. If the raster is a subraster, this will call createCompatibleRaster(width, height).

createWritableChildback to summary
public WritableRaster createWritableChild(int x, int y, int width, int height, int x0, int y0, int[] bandList)

Overrides sun.awt.image.IntegerComponentRaster.createWritableChild.

Creates a subraster given a region of the raster. The x and y coordinates specify the horizontal and vertical offsets from the upper-left corner of this raster to the upper-left corner of the subraster. A subset of the bands of the parent Raster may be specified. If this is null, then all the bands are present in the subRaster. A translation to the subRaster may also be specified. Note that the subraster will reference the same DataBuffer as the parent raster, but using different offsets.

Parameters
x:int

X offset.

y:int

Y offset.

width:int

Width (in pixels) of the subraster.

height:int

Height (in pixels) of the subraster.

x0:int

Translated X origin of the subraster.

y0:int

Translated Y origin of the subraster.

bandList:int[]

Array of band indices.

Exceptions
RasterFormatException:
if the specified bounding box is outside of the parent raster.
getDataElementsback to summary
public Object getDataElements(int x, int y, Object obj)

Overrides sun.awt.image.IntegerComponentRaster.getDataElements.

Returns the data elements for all bands at the specified location. An ArrayIndexOutOfBounds exception will be thrown at runtime if the pixel coordinate is out of bounds. A ClassCastException will be thrown if the input object is non null and references anything other than an array of transferType.

Parameters
x:int

The X coordinate of the pixel location.

y:int

The Y coordinate of the pixel location.

obj:Object

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.

Returns:Object

An object reference to an array of type defined by getTransferType() with the request pixel data.

getDataElementsback to summary
public Object getDataElements(int x, int y, int w, int h, Object obj)

Overrides sun.awt.image.IntegerComponentRaster.getDataElements.

Returns an array of data elements from the specified rectangular region. An ArrayIndexOutOfBounds exception will be thrown at runtime if the pixel coordinates are out of bounds. A ClassCastException will be thrown if the input object is non null and references anything other than an array of transferType.

      int[] bandData = (int[])raster.getDataElements(x, y, w, h, null);
      int numDataElements = raster.getNumDataElements();
      int[] pixel = new int[numDataElements];
      // To find a data element at location (x2, y2)
      System.arraycopy(bandData, ((y2-y)*w + (x2-x))*numDataElements,
                       pixel, 0, numDataElements);
Parameters
x:int

The X coordinate of the upper left pixel location.

y:int

The Y coordinate of the upper left pixel location.

w:int

Width of the pixel rectangle.

h:int

Height of the pixel rectangle.

obj:Object

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.

Returns:Object

An object reference to an array of type defined by getTransferType() with the request pixel data.

getDataOffsetback to summary
public int getDataOffset(int band)

Overrides sun.awt.image.IntegerComponentRaster.getDataOffset.

Returns data offset for the specified band. The data offset is the index into the data array in which the first sample of the first scanline is stored.

getDataOffsetsback to summary
public int[] getDataOffsets()

Overrides sun.awt.image.IntegerComponentRaster.getDataOffsets.

Returns a copy of the data offsets array. For each band the data offset is the index into the band's data array, of the first sample of the band.

getDataStorageback to summary
public int[] getDataStorage()

Overrides sun.awt.image.IntegerComponentRaster.getDataStorage.

Returns a reference to the data array.

getPixelStrideback to summary
public int getPixelStride()

Overrides sun.awt.image.IntegerComponentRaster.getPixelStride.

Returns pixel stride -- the number of data array elements between two samples for the same band on the same scanline.

getScanlineStrideback to summary
public int getScanlineStride()

Overrides sun.awt.image.IntegerComponentRaster.getScanlineStride.

Returns the scanline stride -- the number of data array elements between a given sample and the sample in the same column of the next row.

setDataElementsback to summary
public void setDataElements(int x, int y, Object obj)

Overrides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores the data elements for all bands at the specified location. An ArrayIndexOutOfBounds exception will be thrown at runtime if the pixel coordinate is out of bounds. A ClassCastException will be thrown if the input object is non null and references anything other than an array of transferType.

Parameters
x:int

The X coordinate of the pixel location.

y:int

The Y coordinate of the pixel location.

obj:Object

An object reference to an array of type defined by getTransferType() and length getNumDataElements() containing the pixel data to place at x,y.

setDataElementsback to summary
public void setDataElements(int x, int y, Raster inRaster)

Overrides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores the Raster data at the specified location. The transferType of the inputRaster must match this raster. An ArrayIndexOutOfBoundsException will be thrown at runtime if the pixel coordinates are out of bounds.

Parameters
x:int

The X coordinate of the pixel location.

y:int

The Y coordinate of the pixel location.

inRaster:Raster

Raster of data to place at x,y location.

setDataElementsback to summary
private void setDataElements(int dstX, int dstY, int width, int height, Raster inRaster)

Hides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores the Raster data at the specified location.

Parameters
dstX:int

The absolute X coordinate of the destination pixel that will receive a copy of the upper-left pixel of the inRaster

dstY:int

The absolute Y coordinate of the destination pixel that will receive a copy of the upper-left pixel of the inRaster

width:int

The number of pixels to store horizontally

height:int

The number of pixels to store vertically

inRaster:Raster

Raster of data to place at x,y location.

setDataElementsback to summary
public void setDataElements(int x, int y, int w, int h, Object obj)

Overrides sun.awt.image.IntegerComponentRaster.setDataElements.

Stores an array of data elements into the specified rectangular region. An ArrayIndexOutOfBounds exception will be thrown at runtime if the pixel coordinates are out of bounds. A ClassCastException will be thrown if the input object is non null and references anything other than an array of transferType. The data elements in the data array are assumed to be packed. That is, a data element for the nth band at location (x2, y2) would be found at:

     inData[((y2-y)*w + (x2-x))*numDataElements + n]
Parameters
x:int

The X coordinate of the upper left pixel location.

y:int

The Y coordinate of the upper left pixel location.

w:int

Width of the pixel rectangle.

h:int

Height of the pixel rectangle.

obj:Object

An object reference to an array of type defined by getTransferType() and length w*h*getNumDataElements() containing the pixel data to place between x,y and x+h, y+h.

toStringback to summary
public String toString()

Overrides sun.awt.image.IntegerComponentRaster.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.