public final Class BandedSampleModel

Overrides java.awt.image.ComponentSampleModel.createCompatibleSampleModel.

Creates a new BandedSampleModel with the specified width and height. The new BandedSampleModel will have the same number of bands, storage data type, and bank indices as this BandedSampleModel. The band offsets will be compressed such that the offset between bands will be w*pixelStride and the minimum of all of the band offsets is zero.

Parameters

w:int

the width of the resulting BandedSampleModel

h:int

the height of the resulting BandedSampleModel

Returns:SampleModel

a new BandedSampleModel with the specified width and height.

Exceptions

IllegalArgumentException:

if the product of w and h is greater than Integer.MAX_VALUE or w or h is not greater than 0.

Overrides java.awt.image.ComponentSampleModel.createDataBuffer.

Creates a DataBuffer that corresponds to this BandedSampleModel, The DataBuffer's data type, number of banks, and size will be consistent with this BandedSampleModel.

Exceptions

IllegalArgumentException:

if dataType is not one of the supported types.

Overrides java.awt.image.ComponentSampleModel.createSubsetSampleModel.

Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel. The new BandedSampleModel can be used with any DataBuffer that the existing BandedSampleModel can be used with. The new BandedSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original BandedSampleModel/DataBuffer combination.

Exceptions

NullPointerException:

if bands is null

IllegalArgumentException:

if the number of bands is not greater than 0

RasterFormatException:

if the number of bands is greater than the number of banks in this sample model.

ArrayIndexOutOfBoundsException:

if any of the bank indices is out of bounds

Overrides java.awt.image.ComponentSampleModel.getDataElements.

Returns data for a single pixel in a primitive array of type TransferType. For a BandedSampleModel, this will be the same as the data type, and samples will be returned one per array element. 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 BandedSampleModel bsm1, to DataBuffer db2, whose storage layout is described by BandedSampleModel bsm2. The transfer will generally be more efficient than using getPixel/setPixel.

      BandedSampleModel bsm1, bsm2;
      DataBufferInt db1, db2;
      bsm2.setDataElements(x, y, bsm1.getDataElements(x, y, null, db1),
                           db2);

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.

Parameters

x:int

The X coordinate of the pixel location

y:int

The Y coordinate of the pixel location

obj:Object

If non-null, a primitive array in which to return the pixel data.

data:DataBuffer

The DataBuffer containing the image data.

Returns:Object

the data for the specified pixel.

Exceptions

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

setDataElements(int, int, Object, DataBuffer)

Overrides java.awt.image.ComponentSampleModel.getPixel.

Doc from java.awt.image.ComponentSampleModel.getPixel.

Returns the samples for a specified pixel in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates are not in bounds, or if iArray is too small to hold the output.

Overrides java.awt.image.ComponentSampleModel.getPixels.

Doc from java.awt.image.ComponentSampleModel.getPixels.

Returns all samples for a rectangle of pixels in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates are not in bounds, or w or h is negative. or if iArray is too small to hold the output.

Overrides java.awt.image.ComponentSampleModel.getSample.

Doc from java.awt.image.ComponentSampleModel.getSample.

Returns the sample in a specified band for the pixel located at (x,y) as an int. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or the band index are not in bounds.

Overrides java.awt.image.ComponentSampleModel.getSampleDouble.

Doc from java.awt.image.ComponentSampleModel.getSampleDouble.

Returns the sample in a specified band for a pixel located at (x,y) as a double. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or the band index are not in bounds.

Overrides java.awt.image.ComponentSampleModel.getSampleFloat.

Doc from java.awt.image.ComponentSampleModel.getSampleFloat.

Returns the sample in a specified band for the pixel located at (x,y) as a float. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or the band index are not in bounds.

Overrides java.awt.image.ComponentSampleModel.getSamples.

Doc from java.awt.image.ComponentSampleModel.getSamples.

Returns the samples for a specified band for the specified rectangle of pixels in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or band index are not in bounds, or w or h is negative, or if iArray is too small to hold the output.

Overrides java.awt.image.ComponentSampleModel.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Overrides java.awt.image.ComponentSampleModel.setDataElements.

Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType. For a BandedSampleModel, this will be 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 BandedSampleModel bsm1, to DataBuffer db2, whose storage layout is described by BandedSampleModel bsm2. The transfer will generally be more efficient than using getPixel/setPixel.

      BandedSampleModel bsm1, bsm2;
      DataBufferInt db1, db2;
      bsm2.setDataElements(x, y, bsm1.getDataElements(x, y, 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:int

The X coordinate of the pixel location

y:int

The Y coordinate of the pixel location

obj:Object

If non-null, returns the primitive array in this object

data:DataBuffer

The DataBuffer containing the image data

Exceptions

NullPointerException:

if obj or data is null.

ArrayIndexOutOfBoundsException:

if the coordinates are not in bounds, or if obj is too small to hold the input.

See Also

getDataElements(int, int, Object, DataBuffer)

Overrides java.awt.image.ComponentSampleModel.setPixel.

Doc from java.awt.image.ComponentSampleModel.setPixel.

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

Exceptions

NullPointerException:

if iArray or {code data} is null.

ArrayIndexOutOfBoundsException:

if the coordinates are not in bounds, or if iArray is too small to hold the input.

Overrides java.awt.image.ComponentSampleModel.setPixels.

Doc from java.awt.image.ComponentSampleModel.setPixels.

Sets all samples for a rectangle of pixels from an int array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if iArray or data is null.

ArrayIndexOutOfBoundsException:

if the coordinates are not in bounds, or w or h is negative. or if iArray is too small to hold the input.

Overrides java.awt.image.ComponentSampleModel.setSample.

Doc from java.awt.image.ComponentSampleModel.setSample.

Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using an int for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or the band index are not in bounds.

Overrides java.awt.image.ComponentSampleModel.setSample.

Doc from java.awt.image.ComponentSampleModel.setSample.

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.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or the band index are not in bounds.

Overrides java.awt.image.ComponentSampleModel.setSample.

Doc from java.awt.image.ComponentSampleModel.setSample.

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.

Exceptions

NullPointerException:

if data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or the band index are not in bounds.

Overrides java.awt.image.ComponentSampleModel.setSamples.

Doc from java.awt.image.ComponentSampleModel.setSamples.

Sets the samples in the specified band for the specified rectangle of pixels from an int array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Exceptions

NullPointerException:

if iArray or data is null.

ArrayIndexOutOfBoundsException:

if the coordinates or band index are not in bounds, or w or h is negative, or if iArray is too small to hold the input.