ComponentSampleModel JDK 1.6)

Methods

public SampleModel createCompatibleSampleModel (int w, int h) [Specified in SampleModel]

Creates a new ComponentSampleModel with the specified width and height.

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.
Returns: a new ComponentSampleModel with the specified size
Parameters:
- w - the width of the resulting SampleModel
- h - the height of the resulting SampleModel
Throws:
- IllegalArgumentException - if w or h is not greater than 0

public DataBuffer createDataBuffer () [Specified in SampleModel]

Creates a DataBuffer that corresponds to this ComponentSampleModel.

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.
Returns: a DataBuffer whose data type, number of banks and size are consistent with this ComponentSampleModel.

public SampleModel createSubsetSampleModel (int[] bands) [Specified in SampleModel]

Creates a new ComponentSampleModel with a subset of the bands of 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.
Returns: a ComponentSampleModel created with a subset of bands from this ComponentSampleModel.
Parameters:
- bands - a subset of bands from this ComponentSampleModel

public boolean equals (Object o)

publicfinal int getBandOffsets ()

Returns the band offset for all bands.

publicfinal int getBankIndices ()

Returns the bank indices for all bands.

public Object getDataElements (int x, int y, int w, int h, Object obj, DataBuffer data) [Inherited From SampleModel]

Returns the pixel data for the specified rectangle of pixels in a primitive array of type TransferType.

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. Generally, obj should be passed in as null, so that the Object will be created automatically and will be of the right primitive data type.

The following code illustrates transferring data for a rectangular region of pixels from DataBuffer db1, whose storage layout is described by SampleModel sm1, to DataBuffer db2, whose storage layout is described by SampleModel sm2. The transfer will generally be more efficient than using getPixels/setPixels.

             SampleModel sm1, sm2;
             DataBuffer db1, db2;
             sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w,
                           h, null, db1), db2);

Using getDataElements/setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModels have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same.

If obj is non-null, it should be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is non-null and is not large enough to hold the pixel data.
Returns: the data elements for the specified region of pixels.
Parameters:
- x - The minimum X coordinate of the pixel rectangle.
- y - The minimum Y coordinate of the pixel rectangle.
- w - The width of the pixel rectangle.
- h - The height of the pixel rectangle.
- obj - If non-null, a primitive array in which to return the pixel data.
- data - The DataBuffer containing the image data.
Throws:
- NullPointerException - if data is null.
- ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if obj is too small to hold the output.
See Also: SampleModel.getNumDataElements(), SampleModel.getTransferType(), SampleModel.setDataElements(int, int, int, int, Object, DataBuffer), DataBuffer,

public Object getDataElements (int x, int y, Object obj, DataBuffer data) [Specified in SampleModel]

Returns data for a single pixel in a primitive array of type TransferType.

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 TransferTypes 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.
Returns: the data of the specified pixel
Parameters:
- 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
Throws:
- NullPointerException - if data is null.
- ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if obj is too small to hold the ouput.
See Also: ComponentSampleModel.setDataElements(int, int, Object, DataBuffer),

publicfinal int getDataType () [Inherited From SampleModel]

Returns the data type of the DataBuffer storing the pixel data.

publicfinal int getHeight () [Inherited From SampleModel]

Returns the height in pixels.

Returns the height in pixels.
Returns: the height in pixels of the region of image data that this SampleModel describes.

publicfinal int getNumBands () [Inherited From SampleModel]

Returns the total number of bands of image data.

Returns the total number of bands of image data.
Returns: the number of bands of image data that this SampleModel describes.

publicfinal int getNumDataElements () [Specified in SampleModel]

Returns the number of data elements needed to transfer a pixel
with the
ComponentSampleModel.getDataElements(int, int, Object, DataBuffer) and
ComponentSampleModel.setDataElements(int, int, Object, DataBuffer)
methods.
For a ComponentSampleModel, this is identical to the
number of bands.
Returns: the number of data elements needed to transfer a pixel with the getDataElements and setDataElements methods.
See Also: SampleModel.getNumDataElements(), SampleModel.getNumBands(),

public int getOffset (int x, int y)

Gets the offset for the first band of pixel (x,y).

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));

Returns: the offset for the first band of the specified pixel.
Parameters:
- x - the X location of the pixel
- y - the Y location of the pixel

public int getOffset (int x, int y, int b)

Gets the offset for band b of pixel (x,y).

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));

Returns: the offset for the specified band of the specified pixel.
Parameters:
- x - the X location of the specified pixel
- y - the Y location of the specified pixel
- b - the specified band

public double getPixel (int x, int y, double[] dArray, DataBuffer data) [Inherited From SampleModel]

Returns the samples for the specified pixel in an array of double.

public float getPixel (int x, int y, float[] fArray, DataBuffer data) [Inherited From SampleModel]

Returns the samples for the specified pixel in an array of float.

public int getPixel (int x, int y, int[] iArray, DataBuffer data) [Overrides SampleModel]

Returns all samples for the specified pixel in an int array, one sample per array element.

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.
Returns: the samples of the specified pixel.
Parameters:
- 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
Throws:
- NullPointerException - if data is null.
- ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if iArray is too small to hold the output.
See Also: ComponentSampleModel.setPixel(int, int, int[], DataBuffer),

public double getPixels (int x, int y, int w, int h, double[] dArray, DataBuffer data) [Inherited From SampleModel]

Returns all samples for a rectangle of pixels in a double array, one sample per array element.

public float getPixels (int x, int y, int w, int h, float[] fArray, DataBuffer data) [Inherited From SampleModel]

Returns all samples for a rectangle of pixels in a float array, one sample per array element.

public int getPixels (int x, int y, int w, int h, int[] iArray, DataBuffer data) [Overrides SampleModel]

Returns all samples for the specified rectangle of pixels in an int array, one sample per array element.

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.
Returns: the samples of the pixels within the specified region.
Parameters:
- 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
See Also: ComponentSampleModel.setPixels(int, int, int, int, int[], DataBuffer),

publicfinal int getPixelStride ()

Returns the pixel stride of this ComponentSampleModel.

Returns the pixel stride of this ComponentSampleModel.
Returns: the pixel stride of this ComponentSampleModel.

public int getSample (int x, int y, int b, DataBuffer data) [Specified in SampleModel]

Returns as int the sample in a specified band for the pixel located at (x,y).

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.
Returns: the sample in a specified band for the specified pixel
Parameters:
- 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
See Also: ComponentSampleModel.setSample(int, int, int, int, DataBuffer),

public double getSampleDouble (int x, int y, int b, DataBuffer data) [Overrides SampleModel]

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 a pixel located at (x,y) as a double.
An ArrayIndexOutOfBoundsException might be
thrown if the coordinates are not in bounds.
Returns: a double value representing the sample in the specified band for the specified pixel.
Parameters:
- 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

public float getSampleFloat (int x, int y, int b, DataBuffer data) [Overrides SampleModel]

Returns the sample in a specified band for the pixel located at (x,y) as a float.

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.
Returns: a float value representing the sample in the specified band for the specified pixel.
Parameters:
- 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

public double getSamples (int x, int y, int w, int h, int b, double[] dArray, DataBuffer data) [Inherited From SampleModel]

Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element.

public float getSamples (int x, int y, int w, int h, int b, float[] fArray, DataBuffer data) [Inherited From SampleModel]

Returns the samples for a specified band for the specified rectangle of pixels in a float array, one sample per array element.

public int getSamples (int x, int y, int w, int h, int b, int[] iArray, DataBuffer data) [Overrides SampleModel]

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 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.
Returns: the samples in the specified band of the specified pixel
Parameters:
- 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
See Also: ComponentSampleModel.setSamples(int, int, int, int, int, int[], DataBuffer),

publicfinal int getSampleSize () [Specified in SampleModel]

Returns the number of bits per sample for all bands.

publicfinal int getSampleSize (int band) [Specified in SampleModel]

Returns the number of bits per sample for the specified band.

publicfinal int getScanlineStride ()

Returns the scanline stride of this ComponentSampleModel.

Returns the scanline stride of this ComponentSampleModel.
Returns: the scanline stride of this ComponentSampleModel.

public int getTransferType () [Inherited From SampleModel]

Returns the TransferType used to transfer pixels via the getDataElements and setDataElements methods.

publicfinal int getWidth () [Inherited From SampleModel]

Returns the width in pixels.

Returns the width in pixels.
Returns: the width in pixels of the region of image data that this SampleModel describes.

public int hashCode ()

pack-private int orderBands (int[] orig, int step)

Preserves band ordering with new step factor...

public void setDataElements (int x, int y, int w, int h, Object obj, DataBuffer data) [Inherited From SampleModel]

Sets the data for a rectangle of pixels in the specified DataBuffer from a primitive array of type TransferType.

Sets the data for a rectangle of pixels in the specified DataBuffer from 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 in the array may be in a packed format, thus increasing efficiency for data transfers.

             SampleModel sm1, sm2;
             DataBuffer db1, db2;
             sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w, h,
                           null, db1), db2);

obj must be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is not large enough to hold the pixel data.
Parameters:
- x - The minimum X coordinate of the pixel rectangle.
- y - The minimum Y coordinate of the pixel rectangle.
- w - The width of the pixel rectangle.
- h - The height of the pixel rectangle.
- obj - A primitive array containing pixel data.
- data - The DataBuffer containing the image data.
Throws:
- NullPointerException - if data is null.
- ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if obj is too small to hold the input.
See Also: SampleModel.getNumDataElements(), SampleModel.getTransferType(), SampleModel.getDataElements(int, int, int, int, Object, DataBuffer), DataBuffer,

public void setDataElements (int x, int y, Object obj, DataBuffer data) [Specified in SampleModel]

Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType.

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.

             ComponentSampleModel csm1, csm2;
             DataBufferInt db1, db2;
             csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1),
                            db2);

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.
Parameters:
- 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
See Also: ComponentSampleModel.getDataElements(int, int, Object, DataBuffer),

public void setPixel (int x, int y, double[] dArray, DataBuffer data) [Inherited From SampleModel]

Sets a pixel in the DataBuffer using a double array of samples for input.

public void setPixel (int x, int y, float[] fArray, DataBuffer data) [Inherited From SampleModel]

Sets a pixel in the DataBuffer using a float array of samples for input.

public void setPixel (int x, int y, int[] iArray, DataBuffer data) [Overrides SampleModel]

Sets a pixel in the DataBuffer using an int array of samples for input.

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.
Parameters:
- 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
See Also: ComponentSampleModel.getPixel(int, int, int[], DataBuffer),

public void setPixels (int x, int y, int w, int h, double[] dArray, DataBuffer data) [Inherited From SampleModel]

Sets all samples for a rectangle of pixels from a double array containing one sample per array element.

public void setPixels (int x, int y, int w, int h, float[] fArray, DataBuffer data) [Inherited From SampleModel]

Sets all samples for a rectangle of pixels from a float array containing one sample per array element.

public void setPixels (int x, int y, int w, int h, int[] iArray, DataBuffer data) [Overrides SampleModel]

Sets all samples for a rectangle of pixels from an int array containing one sample per array element.

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.
Parameters:
- 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
See Also: ComponentSampleModel.getPixels(int, int, int, int, int[], DataBuffer),

public void setSample (int x, int y, int b, double s, DataBuffer data) [Overrides SampleModel]

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 double for input.
An ArrayIndexOutOfBoundsException might be thrown if
the coordinates are not in bounds.
Parameters:
- 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
See Also: ComponentSampleModel.getSample(int, int, int, DataBuffer),

public void setSample (int x, int y, int b, float s, DataBuffer data) [Overrides SampleModel]

Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input.

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.
Parameters:
- 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
See Also: ComponentSampleModel.getSample(int, int, int, DataBuffer),

public void setSample (int x, int y, int b, int s, DataBuffer data) [Specified in SampleModel]

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 an int for input.
An ArrayIndexOutOfBoundsException might be thrown if the
coordinates are not in bounds.
Parameters:
- 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
See Also: ComponentSampleModel.getSample(int, int, int, DataBuffer),

public void setSamples (int x, int y, int w, int h, int b, double[] dArray, DataBuffer data) [Inherited From SampleModel]

Sets the samples in the specified band for the specified rectangle of pixels from a double array containing one sample per array element.

public void setSamples (int x, int y, int w, int h, int b, float[] fArray, DataBuffer data) [Inherited From SampleModel]

Sets the samples in the specified band for the specified rectangle of pixels from a float array containing one sample per array element.

public void setSamples (int x, int y, int w, int h, int b, int[] iArray, DataBuffer data) [Overrides SampleModel]

Sets the samples in the specified band for the specified rectangle of pixels from an int array containing one sample per data array element.

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.
Parameters:
- 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
See Also: ComponentSampleModel.getSamples(int, int, int, int, int, int[], DataBuffer),