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

public Class PixelInterleavedSampleModel

extends ComponentSampleModel
Class Inheritance
This class represents image data which is stored in a pixel interleaved fashion and for which each sample of a pixel occupies one data element of the DataBuffer. It subclasses ComponentSampleModel but provides a more efficient implementation for accessing pixel interleaved image data than is provided by ComponentSampleModel. This class stores sample data for all bands in a single bank of the DataBuffer. Accessor methods are provided so that image data can be manipulated directly. 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. Bank indices denote the correspondence between a bank of the data buffer and a band of image data. This class supports TYPE_BYTE, TYPE_USHORT, TYPE_SHORT, TYPE_INT, TYPE_FLOAT and TYPE_DOUBLE datatypes.

Field Summary

Inherited from java.awt.image.ComponentSampleModel:
bandOffsetsbankIndicesnumBandsnumBankspixelStridescanlineStride

Constructor Summary

AccessConstructor and Description
public
PixelInterleavedSampleModel(int
The data type for storing samples.
dataType, int
The width (in pixels) of the region of image data described.
w, int
The height (in pixels) of the region of image data described.
h, int
The pixel stride of the image data.
pixelStride, int
The line stride of the image data.
scanlineStride, int[]
The offsets of all bands.
bandOffsets)

Constructs a PixelInterleavedSampleModel with the specified parameters.

Method Summary

Modifier and TypeMethod and Description
public SampleModel

Returns:

a new SampleModel with the specified width and height.
createCompatibleSampleModel(int
the width of the resulting SampleModel
w, int
the height of the resulting SampleModel
h)

Overrides java.awt.image.ComponentSampleModel.createCompatibleSampleModel.

Creates a new PixelInterleavedSampleModel with the specified width and height.

public SampleModel
createSubsetSampleModel(int[] bands)

Overrides java.awt.image.ComponentSampleModel.createSubsetSampleModel.

Creates a new PixelInterleavedSampleModel with a subset of the bands of this PixelInterleavedSampleModel.

public int
hashCode()

Overrides java.awt.image.ComponentSampleModel.hashCode.

Returns a hash code value for this object.

Inherited from java.awt.image.ComponentSampleModel:
createDataBufferequalsgetBandOffsetsgetBankIndicesgetDataElementsgetNumDataElementsgetOffsetgetOffsetgetPixelgetPixelsgetPixelStridegetSamplegetSampleDoublegetSampleFloatgetSamplesgetSampleSizegetSampleSizegetScanlineStrideorderBandssetDataElementssetPixelsetPixelssetSamplesetSamplesetSamplesetSamples

Constructor Detail

PixelInterleavedSampleModelback to summary
public PixelInterleavedSampleModel(int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bandOffsets)

Constructs a PixelInterleavedSampleModel with the specified parameters. The number of bands will be given by the length of the bandOffsets array.

Parameters
dataType:int

The data type for storing samples.

w:int

The width (in pixels) of the region of image data described.

h:int

The height (in pixels) of the region of image data described.

pixelStride:int

The pixel stride of the image data.

scanlineStride:int

The line stride of the image data.

bandOffsets:int[]

The offsets of all bands.

Exceptions
IllegalArgumentException:
  • if w or h is not greater than 0
  • if any offset between bands is greater than the scanline stride
  • if the product of pixelStride and w is greater than scanlineStride
  • if pixelStride is less than any offset between bands
  • if dataType is not one of the supported data types
  • if bandOffsets.length is 0
NullPointerException:
if bandOffsets is null

Method Detail

createCompatibleSampleModelback to summary
public SampleModel createCompatibleSampleModel(int w, int h)

Overrides java.awt.image.ComponentSampleModel.createCompatibleSampleModel.

Creates a new PixelInterleavedSampleModel with the specified width and height. The new PixelInterleavedSampleModel will have the same number of bands, storage data type, and pixel stride as this PixelInterleavedSampleModel. The band offsets may be compressed such that the minimum of all of the band offsets is zero.

Parameters
w:int

the width of the resulting SampleModel

h:int

the height of the resulting SampleModel

Returns:SampleModel

a new SampleModel with the specified width and height.

Exceptions
IllegalArgumentException:
if w or h is not greater than 0
createSubsetSampleModelback to summary
public SampleModel createSubsetSampleModel(int[] bands)

Overrides java.awt.image.ComponentSampleModel.createSubsetSampleModel.

Creates a new PixelInterleavedSampleModel with a subset of the bands of this PixelInterleavedSampleModel. The new PixelInterleavedSampleModel can be used with any DataBuffer that the existing PixelInterleavedSampleModel can be used with. The new PixelInterleavedSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original PixelInterleavedSampleModel/DataBuffer combination.

Exceptions
NullPointerException:
if bands is null
IllegalArgumentException:
if the number of bands is not greater than 0
RasterFormatException:
if the number of bands is greater than the number of bands in this sample model.
ArrayIndexOutOfBoundsException:
if any of the band indices is out of bounds
hashCodeback to summary
public int hashCode()

Overrides java.awt.image.ComponentSampleModel.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals 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 hash tables.