MultiPixelPackedSampleModel JDK 1.6)

Methods

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

Creates a new MultiPixelPackedSampleModel with the specified width and height.

Creates a new MultiPixelPackedSampleModel with the
specified width and height. The new
MultiPixelPackedSampleModel has the
same storage data type and number of bits per pixel as this
MultiPixelPackedSampleModel.
Returns: a {@link SampleModel} with the specified width and height and with the same storage data type and number of bits per pixel as this MultiPixelPackedSampleModel.
Parameters:
- w - the specified width
- h - the specified height
Throws:
- IllegalArgumentException - if w or h is not greater than 0

public DataBuffer createDataBuffer () [Specified in SampleModel]

Creates a DataBuffer that corresponds to this MultiPixelPackedSampleModel.

Creates a DataBuffer that corresponds to this
MultiPixelPackedSampleModel. The
DataBuffer object's data type and size
is consistent with this MultiPixelPackedSampleModel.
The DataBuffer has a single bank.
Returns: a DataBuffer with the same data type and size as this MultiPixelPackedSampleModel.

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

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

Creates a new MultiPixelPackedSampleModel with a
subset of the bands of this
MultiPixelPackedSampleModel. Since a
MultiPixelPackedSampleModel only has one band, the
bands argument must have a length of one and indicate the zeroth
band.
Returns: a new SampleModel with a subset of bands of this MultiPixelPackedSampleModel.
Parameters:
- bands - the specified bands
Throws:
- RasterFormatException - if the number of bands requested is not one.
- IllegalArgumentException - if w or h is not greater than 0

public boolean equals (Object o)

public int getBitOffset (int x)

Returns the offset, in bits, into the data element in which it is stored for the xth pixel of a scanline.

Returns the offset, in bits, into the data element in which it is
stored for the xth pixel of a scanline.
This offset is the same for all scanlines.
Returns: the bit offset of the specified pixel.
Parameters:
- x - the specified pixel

public int getDataBitOffset ()

Returns the data bit offset in bits.

Returns the data bit offset in bits.
Returns: the dataBitOffset of this MultiPixelPackedSampleModel.

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 MultiPixelPackedSampleModel, the array has one element, and the type is the smallest of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT that can hold a single pixel. Generally, obj should be passed in as null, so that the Object is created automatically and is the correct primitive data type.

The following code illustrates transferring data for one pixel from DataBuffer db1, whose storage layout is described by MultiPixelPackedSampleModel mppsm1, to DataBuffer db2, whose storage layout is described by MultiPixelPackedSampleModel mppsm2. The transfer is generally more efficient than using getPixel or setPixel.

             MultiPixelPackedSampleModel mppsm1, mppsm2;
             DataBufferInt db1, db2;
             mppsm2.setDataElements(x, y, mppsm1.getDataElements(x, y, null,
                              db1), db2);

Using getDataElements or 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 not null, it should be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException is 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: an Object containing data for the specified pixel.
Parameters:
- x - the X coordinate of the specified pixel
- y - the Y coordinate of the specified pixel
- obj - a primitive array in which to return the pixel data or null.
- data - the DataBuffer containing the image data.
Throws:
- ClassCastException - if obj is not a primitive array of type TransferType or is not null
- ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if obj is not null or not large enough to hold the pixel data
See Also: MultiPixelPackedSampleModel.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.

public int getNumDataElements () [Specified in SampleModel]

Returns the number of data elements needed to transfer one pixel via the MultiPixelPackedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) and MultiPixelPackedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) methods.

Returns the number of data elements needed to transfer one pixel
via the MultiPixelPackedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) and MultiPixelPackedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)
methods. For a MultiPixelPackedSampleModel, this is
one.
Returns: the number of data elements.

public int getOffset (int x, int y)

Returns the offset of pixel (x, y) in data array elements.

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 the specified single band pixel in the first element of an int array.

Returns the specified single band pixel in the first element
of an int array.
ArrayIndexOutOfBoundsException is thrown if the
coordinates are not in bounds.
Returns: an array containing the specified pixel.
Parameters:
- x - the X coordinate of the specified pixel
- y - the Y coordinate of the specified pixel
- iArray - the array containing the pixel to be returned or null
- data - the DataBuffer where image data is stored
Throws:
- ArrayIndexOutOfBoundsException - if the coordinates are not in bounds
See Also: MultiPixelPackedSampleModel.setPixel(int, int, int[], DataBuffer),

public int getPixelBitStride ()

Returns the pixel bit stride in bits.

Returns the pixel bit stride in bits. This value is the same as
the number of bits per pixel.
Returns: the pixelBitStride of this MultiPixelPackedSampleModel.

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) [Inherited From SampleModel]

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

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 is thrown if the
coordinates are not in bounds.
Returns: the specified band containing the sample of the specified pixel.
Parameters:
- x - the X coordinate of the specified pixel
- y - the Y coordinate of the specified pixel
- b - the band to return, which is assumed to be 0
- data - the DataBuffer containing the image data
Throws:
- ArrayIndexOutOfBoundException - if the specified coordinates are not in bounds.
See Also: MultiPixelPackedSampleModel.setSample(int, int, int, int, DataBuffer),

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

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

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

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

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) [Inherited From SampleModel]

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

public int getSampleSize () [Specified in SampleModel]

Returns the number of bits per sample for all bands.

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

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

public int getScanlineStride ()

Returns the scanline stride.

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

public int getTransferType () [Overrides SampleModel]

Returns the TransferType used to transfer pixels by way of the getDataElements and setDataElements methods.

Returns the TransferType used to transfer pixels by way of the
getDataElements and setDataElements
methods. The TransferType might or might not be the same as the
storage DataType. The TransferType is one of
DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT,
or DataBuffer.TYPE_INT.
Returns: the transfertype.

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

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 MultiPixelPackedSampleModel, only the first element of the array holds valid data, and the type must be the smallest of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT that can hold a single pixel.

             MultiPixelPackedSampleModel mppsm1, mppsm2;
             DataBufferInt db1, db2;
             mppsm2.setDataElements(x, y, mppsm1.getDataElements(x, y, null,
                              db1), db2);

Using getDataElements or 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.

obj must be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException is 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: MultiPixelPackedSampleModel.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 for input.

Sets a pixel in the DataBuffer using an
int array for input.
ArrayIndexOutOfBoundsException is 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 pixel in an int array
- data - the DataBuffer containing the image data
See Also: MultiPixelPackedSampleModel.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) [Inherited From SampleModel]

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

public void setSample (int x, int y, int b, double s, DataBuffer data) [Inherited From 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.
The default implementation of this method casts the input
double sample to an int and then calls the
setSample(int, int, int, DataBuffer) method using
that int value.
ArrayIndexOutOfBoundsException may 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.
Throws:
- NullPointerException - if data is null.
- ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.
See Also: SampleModel.getSample(int, int, int, DataBuffer),

public void setSample (int x, int y, int b, float s, DataBuffer data) [Inherited From 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.
The default implementation of this method casts the input
float sample to an int and then calls the
setSample(int, int, int, DataBuffer) method using
that int value.
ArrayIndexOutOfBoundsException may 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.
Throws:
- NullPointerException - if data is null.
- ArrayIndexOutOfBoundsException - if the coordinates or the band index are not in bounds.
See Also: SampleModel.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 is thrown if the
coordinates are not in bounds.
Parameters:
- x - the X coordinate of the specified pixel
- y - the Y coordinate of the specified pixel
- b - the band to return, which is assumed to be 0
- s - the input sample as an int
- data - the DataBuffer where image data is stored
Throws:
- ArrayIndexOutOfBoundsException - if the coordinates are not in bounds.
See Also: MultiPixelPackedSampleModel.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) [Inherited From SampleModel]

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