jdk.awt.image.MultiPixelPackedSampleModel — clojure-interop/java.awt 1.0.5

The MultiPixelPackedSampleModel class represents one-banded images and can pack multiple one-sample pixels into one data element. Pixels are not allowed to span data elements. The data type can be DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT. Each pixel must be a power of 2 number of bits and a power of 2 number of pixels must fit exactly in one data element. Pixel bit stride is equal to the number of bits per pixel. Scanline stride is in data elements and the last several data elements might be padded with unused pixels. Data bit offset is the offset in bits from the beginning of the DataBuffer to the first pixel and must be a multiple of pixel bit stride.

The following code illustrates extracting the bits for pixel x, y from DataBuffer data and storing the pixel data in data elements of type dataType:

 int dataElementSize = DataBuffer.getDataTypeSize(dataType);
 int bitnum = dataBitOffset  x*pixelBitStride;
 int element = data.getElem(y*scanlineStride  bitnum/dataElementSize);
 int shift = dataElementSize - (bitnum & (dataElementSize-1))
             - pixelBitStride;
 int pixel = (element >> shift) & ((1 << pixelBitStride) - 1);

->multi-pixel-packed-sample-model clj

(->multi-pixel-packed-sample-model data-type w h number-of-bits)

(->multi-pixel-packed-sample-model data-type
                                   w
                                   h
                                   number-of-bits
                                   scanline-stride
                                   data-bit-offset)

Constructor.

Constructs a MultiPixelPackedSampleModel with specified data type, width, height, number of bits per pixel, scanline stride and data bit offset.

data-type - the data type for storing samples - int w - the width, in pixels, of the region of image data described - int h - the height, in pixels, of the region of image data described - int number-of-bits - the number of bits per pixel - int scanline-stride - the line stride of the image data - int data-bit-offset - the data bit offset for the region of image data described - int

throws: java.awt.image.RasterFormatException - if the number of bits per pixel is not a power of 2 or if a power of 2 number of pixels do not fit in one data element.

create-compatible-sample-model clj

(create-compatible-sample-model this w h)

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.

w - the specified width - int h - the specified height - int

returns: a SampleModel with the specified width and height and with the same storage data type and number of bits per pixel as this MultiPixelPackedSampleModel. - java.awt.image.SampleModel

throws: java.lang.IllegalArgumentException - if w or h is not greater than 0

create-data-buffer clj

(create-data-buffer this)

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. - java.awt.image.DataBuffer

create-subset-sample-model clj

(create-subset-sample-model this bands)

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.

bands - the specified bands - int[]

returns: a new SampleModel with a subset of bands of this MultiPixelPackedSampleModel. - java.awt.image.SampleModel

throws: java.awt.image.RasterFormatException - if the number of bands requested is not one.

equals clj

(equals this o)

Description copied from class: Object

o - the reference object with which to compare. - java.lang.Object

returns: true if this object is the same as the obj argument; false otherwise. - boolean

get-bit-offset clj

(get-bit-offset this x)

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.

x - the specified pixel - int

returns: the bit offset of the specified pixel. - int

get-data-bit-offset clj

(get-data-bit-offset this)

Returns the data bit offset in bits.

returns: the dataBitOffset of this MultiPixelPackedSampleModel. - int

get-data-elements clj

(get-data-elements this x y obj data)

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.

x - the X coordinate of the specified pixel - int y - the Y coordinate of the specified pixel - int obj - a primitive array in which to return the pixel data or null. - java.lang.Object data - the DataBuffer containing the image data. - java.awt.image.DataBuffer

returns: an Object containing data for the specified pixel. - java.lang.Object

throws: java.lang.ClassCastException - if obj is not a primitive array of type TransferType or is not null

get-num-data-elements clj

(get-num-data-elements this)

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

returns: the number of data elements. - int

get-offset clj

(get-offset this x y)

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

x - the X coordinate of the specified pixel - int y - the Y coordinate of the specified pixel - int

returns: the offset of the specified pixel. - int

get-pixel clj

(get-pixel this x y i-array data)

Returns the specified single band pixel in the first element of an int array. ArrayIndexOutOfBoundsException is thrown if the coordinates are not in bounds.

x - the X coordinate of the specified pixel - int y - the Y coordinate of the specified pixel - int i-array - the array containing the pixel to be returned or null - int[] data - the DataBuffer where image data is stored - java.awt.image.DataBuffer

returns: an array containing the specified pixel. - int[]

throws: java.lang.ArrayIndexOutOfBoundsException - if the coordinates are not in bounds

get-pixel-bit-stride clj

(get-pixel-bit-stride this)

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

get-sample clj

(get-sample this x y b data)

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.

x - the X coordinate of the specified pixel - int y - the Y coordinate of the specified pixel - int b - the band to return, which is assumed to be 0 - int data - the DataBuffer containing the image data - java.awt.image.DataBuffer

returns: the specified band containing the sample of the specified pixel. - int

throws: java.lang.ArrayIndexOutOfBoundsException - if the specified coordinates are not in bounds.

get-sample-size clj

(get-sample-size this)

(get-sample-size this band)

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

band - the specified band - int

returns: the number of bits per sample for the specified band. - int

get-scanline-stride clj

(get-scanline-stride this)

Returns the scanline stride.

returns: the scanline stride of this MultiPixelPackedSampleModel. - int

get-transfer-type clj

(get-transfer-type this)

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

hash-code clj

(hash-code this)

Description copied from class: Object

returns: a hash code value for this object. - int

set-data-elements clj

(set-data-elements this x y obj data)

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.

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

x - the X coordinate of the pixel location - int y - the Y coordinate of the pixel location - int obj - a primitive array containing pixel data - java.lang.Object data - the DataBuffer containing the image data - java.awt.image.DataBuffer

set-pixel clj

(set-pixel this x y i-array data)

Sets a pixel in the DataBuffer using an int array for input. ArrayIndexOutOfBoundsException is thrown if the coordinates are not in bounds.

x - the X coordinate of the pixel location - int y - the Y coordinate of the pixel location - int i-array - the input pixel in an int array - int[] data - the DataBuffer containing the image data - java.awt.image.DataBuffer

set-sample clj

(set-sample this x y b s data)

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.

x - the X coordinate of the specified pixel - int y - the Y coordinate of the specified pixel - int b - the band to return, which is assumed to be 0 - int s - the input sample as an int - int data - the DataBuffer where image data is stored - java.awt.image.DataBuffer

throws: java.lang.ArrayIndexOutOfBoundsException - if the coordinates are not in bounds.