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

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,

->component-sample-model clj

(->component-sample-model data-type
                          w
                          h
                          pixel-stride
                          scanline-stride
                          band-offsets)

(->component-sample-model data-type
                          w
                          h
                          pixel-stride
                          scanline-stride
                          bank-indices
                          band-offsets)

Constructor.

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.

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 pixel-stride - the pixel stride of the region of image data described - int scanline-stride - The line stride of the region of image data described - int bank-indices - the bank indices of all bands - int[] band-offsets - the band offsets of all bands - int[]

throws: java.lang.IllegalArgumentException - if dataType is not one of the supported data types

create-compatible-sample-model clj

(create-compatible-sample-model this w 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.

w - the width of the resulting SampleModel - int h - the height of the resulting SampleModel - int

returns: a new ComponentSampleModel with the specified size - 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 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. - java.awt.image.DataBuffer

create-subset-sample-model clj

(create-subset-sample-model this bands)

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.

bands - a subset of bands from this ComponentSampleModel - int[]

returns: a ComponentSampleModel created with a subset of bands from this ComponentSampleModel. - java.awt.image.SampleModel

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-band-offsets clj

(get-band-offsets this)

Returns the band offset for all bands.

returns: the band offsets for all bands. - int[]

get-bank-indices clj

(get-bank-indices this)

Returns the bank indices for all bands.

returns: the bank indices for all bands. - 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 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.

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

returns: the data of the specified pixel - java.lang.Object

throws: java.lang.NullPointerException - if data is null.

get-num-data-elements clj

(get-num-data-elements this)

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

get-offset clj

(get-offset this x y)

(get-offset this x y b)

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

x - the X location of the specified pixel - int y - the Y location of the specified pixel - int b - the specified band - int

returns: the offset for the specified band of the specified pixel. - int

get-pixel clj

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

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.

x - the X coordinate of the pixel location - int y - the Y coordinate of the pixel location - int i-array - If non-null, returns the samples in this array - int[] data - The DataBuffer containing the image data - java.awt.image.DataBuffer

returns: the samples of the specified pixel. - int[]

throws: java.lang.NullPointerException - if data is null.

get-pixel-stride clj

(get-pixel-stride this)

Returns the pixel stride of this ComponentSampleModel.

returns: the pixel stride of this ComponentSampleModel. - int

get-pixels clj

(get-pixels this x y w h i-array data)

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.

x - The X coordinate of the upper left pixel location - int y - The Y coordinate of the upper left pixel location - int w - The width of the pixel rectangle - int h - The height of the pixel rectangle - int i-array - If non-null, returns the samples in this array - int[] data - The DataBuffer containing the image data - java.awt.image.DataBuffer

returns: the samples of the pixels within the specified region. - 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 might be 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 b - the band to return - int data - the DataBuffer containing the image data - java.awt.image.DataBuffer

returns: the sample in a specified band for the specified pixel - int

get-sample-double clj

(get-sample-double this x y b data)

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.

x - The X coordinate of the pixel location - int y - The Y coordinate of the pixel location - int b - The band to return - int data - The DataBuffer containing the image data - java.awt.image.DataBuffer

returns: a double value representing the sample in the specified band for the specified pixel. - double

get-sample-float clj

(get-sample-float this x y b data)

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.

x - The X coordinate of the pixel location - int y - The Y coordinate of the pixel location - int b - The band to return - int data - The DataBuffer containing the image data - java.awt.image.DataBuffer

returns: a float value representing the sample in the specified band for the specified pixel. - float

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-samples clj

(get-samples this x y w h b i-array data)

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.

x - The X coordinate of the upper left pixel location - int y - The Y coordinate of the upper left pixel location - int w - the width of the pixel rectangle - int h - the height of the pixel rectangle - int b - the band to return - int i-array - if non-null, returns the samples in this array - int[] data - the DataBuffer containing the image data - java.awt.image.DataBuffer

returns: the samples in the specified band of the specified pixel - int[]

get-scanline-stride clj

(get-scanline-stride this)

Returns the scanline stride of this ComponentSampleModel.

returns: the scanline stride of this ComponentSampleModel. - 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 ComponentSampleModel, this is the same as the data type, and samples are transferred one per array element.

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.

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.

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 of samples for input. An ArrayIndexOutOfBoundsException might be 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 samples in an int array - int[] data - The DataBuffer containing the image data - java.awt.image.DataBuffer

set-pixels clj

(set-pixels this x y w h i-array data)

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.

x - The X coordinate of the upper left pixel location - int y - The Y coordinate of the upper left pixel location - int w - The width of the pixel rectangle - int h - The height of the pixel rectangle - int i-array - The input samples 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 might be 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 b - the band to set - int s - the input sample as an int - int data - the DataBuffer containing the image data - java.awt.image.DataBuffer

set-samples clj

(set-samples this x y w h b i-array 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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

x - The X coordinate of the upper left pixel location - int y - The Y coordinate of the upper left pixel location - int w - The width of the pixel rectangle - int h - The height of the pixel rectangle - int b - The band to set - int i-array - The input samples in an int array - int[] data - The DataBuffer containing the image data - java.awt.image.DataBuffer