SinglePixelPackedSampleModel JDK 1.6)

Methods

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

Creates a new SinglePixelPackedSampleModel with the specified width and height.

Creates a new SinglePixelPackedSampleModel with the specified
width and height. The new SinglePixelPackedSampleModel will have the
same storage data type and bit masks as this
SinglePixelPackedSampleModel.
Returns: a SinglePixelPackedSampleModel with the specified width and height.
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 SinglePixelPackedSampleModel.

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

This creates a new SinglePixelPackedSampleModel with a subset of the bands of this SinglePixelPackedSampleModel.

public boolean equals (Object o)

public int getBitMasks ()

Returns the bit masks for all bands.

public int getBitOffsets ()

Returns the bit offsets into the data array element representing a pixel 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 SinglePixelPackedSampleModel, the array will have one element, and the type will be the same as the storage data type. 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 one pixel from DataBuffer db1, whose storage layout is described by SinglePixelPackedSampleModel sppsm1, to DataBuffer db2, whose storage layout is described by SinglePixelPackedSampleModel sppsm2. The transfer will generally be more efficient than using getPixel/setPixel.

             SinglePixelPackedSampleModel sppsm1, sppsm2;
             DataBufferInt db1, db2;
             sppsm2.setDataElements(x, y, sppsm1.getDataElements(x, y, null,
                              db1), db2);

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 getDataElements and setDataElements methods.

public int getOffset (int x, int y)

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

Returns the offset (in data array elements) of pixel (x,y).
The data element containing pixel x,y
can be retrieved from a DataBuffer data with a
SinglePixelPackedSampleModel sppsm as:


        data.getElem(sppsm.getOffset(x, y));

Returns: the offset of the specified pixel.
Parameters:
- x - the X coordinate of the specified pixel
- y - the Y coordinate of the specified pixel

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 in for the specified pixel in an int array.

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.

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

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) [Overrides 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 of this SinglePixelPackedSampleModel.

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

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

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 SinglePixelPackedSampleModel, only the first element of the array will hold valid data, and the type of the array must be the same as the storage data type of the SinglePixelPackedSampleModel.

             SinglePixelPackedSampleModel sppsm1, sppsm2;
             DataBufferInt db1, db2;
             sppsm2.setDataElements(x, y, sppsm1.getDataElements(x, y, null,
                              db1), db2);

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.

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.

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.

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 array element.