java.awt.image
Class ComponentSampleModel

java.lang.Object   
  java.awt.image.SampleModel   
      java.awt.image.ComponentSampleModel

Direct Known Subclasses:

BandedSampleModel , PixelInterleavedSampleModel

public class ComponentSampleModel
extends SampleModel   

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 ,

See Also:

PixelInterleavedSampleModel , BandedSampleModel

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

bandOffsets

protected int[] bandOffsets

Offsets for all bands in data array elements.

bankIndices

protected int[] bankIndices

Index for each bank storing a band of image data.

numBands

protected int numBands

The number of bands in this ComponentSampleModel.

numBanks

protected int numBanks

The number of banks in this ComponentSampleModel.

scanlineStride

protected int scanlineStride

Line stride (in data array elements) of the region of image data described by this ComponentSampleModel.

pixelStride

protected int pixelStride

Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.

Constructor Detail

ComponentSampleModel

public ComponentSampleModel(int dataType,
                            int w,
                            int h,
                            int pixelStride,
                            int scanlineStride,
                            int[] bandOffsets)

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.

Parameters:

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

Throws:

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

ComponentSampleModel

public ComponentSampleModel(int dataType,
                            int w,
                            int h,
                            int pixelStride,
                            int scanlineStride,
                            int[] bankIndices,
                            int[] bandOffsets)

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.

Parameters:

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

Throws:

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

Method Detail

createCompatibleSampleModel

public SampleModel    createCompatibleSampleModel(int w,
                                               int h)

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.

Specified by:

createCompatibleSampleModel in class SampleModel

Parameters:

w - the width of the resulting SampleModel

h - the height of the resulting SampleModel

Returns:

a new ComponentSampleModel with the specified size

Throws:

IllegalArgumentException - if w or h is not greater than 0

createSubsetSampleModel

public SampleModel