java.awt.image
Class BandedSampleModel

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.image.SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel 
      extended by java.awt.image.ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel 
          extended by java.awt.image.BandedSampleModel

public final class BandedSampleModel
extends ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel

This class represents image data which is stored in a band interleaved fashion and for which each sample of a pixel occupies one data element of the DataBuffer. It subclasses ComponentSampleModel but provides a more efficent implementation for accessing band interleaved image data than is provided by ComponentSampleModel. This class should typically be used when working with images which store sample data for each band in a different bank of the DataBuffer. Accessor methods are provided so that image data can be manipulated directly. Pixel stride is the number of data array elements between two samples for the same band on the same scanline. The pixel stride for a BandedSampleModel is one. 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. Bank indices denote the correspondence between a bank of the data buffer and a band of image data. This class supports TYPE_BYTE sample code for java.awt.image.DataBuffer.TYPE_BYTE definition code for java.awt.image.DataBuffer.TYPE_BYTE , TYPE_USHORT sample code for java.awt.image.DataBuffer.TYPE_USHORT definition code for java.awt.image.DataBuffer.TYPE_USHORT , TYPE_SHORT sample code for java.awt.image.DataBuffer.TYPE_SHORT definition code for java.awt.image.DataBuffer.TYPE_SHORT , TYPE_INT sample code for java.awt.image.DataBuffer.TYPE_INT definition code for java.awt.image.DataBuffer.TYPE_INT , TYPE_FLOAT sample code for java.awt.image.DataBuffer.TYPE_FLOAT definition code for java.awt.image.DataBuffer.TYPE_FLOAT , and TYPE_DOUBLE sample code for java.awt.image.DataBuffer.TYPE_DOUBLE definition code for java.awt.image.DataBuffer.TYPE_DOUBLE datatypes


Field Summary
 
Fields inherited from class java.awt.image.ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
bandOffsets sample code for java.awt.image.ComponentSampleModel.bandOffsets definition code for java.awt.image.ComponentSampleModel.bandOffsets , bankIndices sample code for java.awt.image.ComponentSampleModel.bankIndices definition code for java.awt.image.ComponentSampleModel.bankIndices , numBands sample code for java.awt.image.ComponentSampleModel.numBands definition code for java.awt.image.ComponentSampleModel.numBands , numBanks sample code for java.awt.image.ComponentSampleModel.numBanks definition code for java.awt.image.ComponentSampleModel.numBanks , pixelStride sample code for java.awt.image.ComponentSampleModel.pixelStride definition code for java.awt.image.ComponentSampleModel.pixelStride , scanlineStride sample code for java.awt.image.ComponentSampleModel.scanlineStride definition code for java.awt.image.ComponentSampleModel.scanlineStride
 
Fields inherited from class java.awt.image.SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
dataType sample code for java.awt.image.SampleModel.dataType definition code for java.awt.image.SampleModel.dataType , height sample code for java.awt.image.SampleModel.height definition code for java.awt.image.SampleModel.height , width sample code for java.awt.image.SampleModel.width definition code for java.awt.image.SampleModel.width
 
Constructor Summary
BandedSampleModel sample code for java.awt.image.BandedSampleModel.BandedSampleModel(int, int, int, int) definition code for java.awt.image.BandedSampleModel.BandedSampleModel(int, int, int, int) (int dataType, int w, int h, int numBands)
          Constructs a BandedSampleModel with the specified parameters.
BandedSampleModel sample code for java.awt.image.BandedSampleModel.BandedSampleModel(int, int, int, int, int[], int[]) definition code for java.awt.image.BandedSampleModel.BandedSampleModel(int, int, int, int, int[], int[]) (int dataType, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets)
          Constructs a BandedSampleModel with the specified parameters.
 
Method Summary
 SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel createCompatibleSampleModel sample code for java.awt.image.BandedSampleModel.createCompatibleSampleModel(int, int) definition code for java.awt.image.BandedSampleModel.createCompatibleSampleModel(int, int) (int w, int h)
          Creates a new BandedSampleModel with the specified width and height.
 DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer createDataBuffer sample code for java.awt.image.BandedSampleModel.createDataBuffer() definition code for java.awt.image.BandedSampleModel.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.
 SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel createSubsetSampleModel sample code for java.awt.image.BandedSampleModel.createSubsetSampleModel(int[]) definition code for java.awt.image.BandedSampleModel.createSubsetSampleModel(int[]) (int[] bands)
          Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel.
 Object sample code for java.lang.Object definition code for java.lang.Object getDataElements sample code for java.awt.image.BandedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) (int x, int y, Object sample code for java.lang.Object definition code for java.lang.Object  obj, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Returns data for a single pixel in a primitive array of type TransferType.
 int[] getPixel sample code for java.awt.image.BandedSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) (int x, int y, int[] iArray, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Returns all samples for the specified pixel in an int array.
 int[] getPixels sample code for java.awt.image.BandedSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) (int x, int y, int w, int h, int[] iArray, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Returns all samples for the specified rectangle of pixels in an int array, one sample per data array element.
 int getSample sample code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) (int x, int y, int b, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Returns as int the sample in a specified band for the pixel located at (x,y).
 double getSampleDouble sample code for java.awt.image.BandedSampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) (int x, int y, int b, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Returns the sample in a specified band for a pixel located at (x,y) as a double.
 float getSampleFloat sample code for java.awt.image.BandedSampleModel.getSampleFloat(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSampleFloat(int, int, int, java.awt.image.DataBuffer) (int x, int y, int b, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Returns the sample in a specified band for the pixel located at (x,y) as a float.
 int[] getSamples sample code for java.awt.image.BandedSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) (int x, int y, int w, int h, int b, int[] iArray, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Returns the samples in a specified band for the specified rectangle of pixels in an int array, one sample per data array element.
 int hashCode sample code for java.awt.image.BandedSampleModel.hashCode() definition code for java.awt.image.BandedSampleModel.hashCode() ()
          Returns a hash code value for the object.
 void setDataElements sample code for java.awt.image.BandedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) (int x, int y, Object sample code for java.lang.Object definition code for java.lang.Object  obj, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType.
 void setPixel sample code for java.awt.image.BandedSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) (int x, int y, int[] iArray, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Sets a pixel in the DataBuffer using an int array of samples for input.
 void setPixels sample code for java.awt.image.BandedSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) (int x, int y, int w, int h, int[] iArray, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Sets all samples for a rectangle of pixels from an int array containing one sample per array element.
 void setSample sample code for java.awt.image.BandedSampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer) (int x, int y, int b, double s, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a double for input.
 void setSample sample code for java.awt.image.BandedSampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer) (int x, int y, int b, float s, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input.
 void setSample sample code for java.awt.image.BandedSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) (int x, int y, int b, int s, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
          Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using an int for input.
 void setSamples sample code for java.awt.image.BandedSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) (int x, int y, int w, int h, int b, int[] iArray, DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  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.
 
Methods inherited from class java.awt.image.ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
equals sample code for java.awt.image.ComponentSampleModel.equals(java.lang.Object) definition code for java.awt.image.ComponentSampleModel.equals(java.lang.Object) , getBandOffsets sample code for java.awt.image.ComponentSampleModel.getBandOffsets() definition code for java.awt.image.ComponentSampleModel.getBandOffsets() , getBankIndices sample code for java.awt.image.ComponentSampleModel.getBankIndices() definition code for java.awt.image.ComponentSampleModel.getBankIndices() , getNumDataElements sample code for java.awt.image.ComponentSampleModel.getNumDataElements() definition code for java.awt.image.ComponentSampleModel.getNumDataElements() , getOffset sample code for java.awt.image.ComponentSampleModel.getOffset(int, int) definition code for java.awt.image.ComponentSampleModel.getOffset(int, int) , getOffset sample code for java.awt.image.ComponentSampleModel.getOffset(int, int, int) definition code for java.awt.image.ComponentSampleModel.getOffset(int, int, int) , getPixelStride sample code for java.awt.image.ComponentSampleModel.getPixelStride() definition code for java.awt.image.ComponentSampleModel.getPixelStride() , getSampleSize sample code for java.awt.image.ComponentSampleModel.getSampleSize() definition code for java.awt.image.ComponentSampleModel.getSampleSize() , getSampleSize sample code for java.awt.image.ComponentSampleModel.getSampleSize(int) definition code for java.awt.image.ComponentSampleModel.getSampleSize(int) , getScanlineStride sample code for java.awt.image.ComponentSampleModel.getScanlineStride() definition code for java.awt.image.ComponentSampleModel.getScanlineStride()
 
Methods inherited from class java.awt.image.SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
getDataElements sample code for java.awt.image.SampleModel.getDataElements(int, int, int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getDataElements(int, int, int, int, java.lang.Object, java.awt.image.DataBuffer) , getDataType sample code for java.awt.image.SampleModel.getDataType() definition code for java.awt.image.SampleModel.getDataType() , getHeight sample code for java.awt.image.SampleModel.getHeight() definition code for java.awt.image.SampleModel.getHeight() , getNumBands sample code for java.awt.image.SampleModel.getNumBands() definition code for java.awt.image.SampleModel.getNumBands() , getPixel sample code for java.awt.image.SampleModel.getPixel(int, int, double[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getPixel(int, int, double[], java.awt.image.DataBuffer) , getPixel sample code for java.awt.image.SampleModel.getPixel(int, int, float[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getPixel(int, int, float[], java.awt.image.DataBuffer) , getPixels sample code for java.awt.image.SampleModel.getPixels(int, int, int, int, double[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getPixels(int, int, int, int, double[], java.awt.image.DataBuffer) , getPixels sample code for java.awt.image.SampleModel.getPixels(int, int, int, int, float[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getPixels(int, int, int, int, float[], java.awt.image.DataBuffer) , getSamples sample code for java.awt.image.SampleModel.getSamples(int, int, int, int, int, double[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getSamples(int, int, int, int, int, double[], java.awt.image.DataBuffer) , getSamples sample code for java.awt.image.SampleModel.getSamples(int, int, int, int, int, float[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getSamples(int, int, int, int, int, float[], java.awt.image.DataBuffer) , getTransferType sample code for java.awt.image.SampleModel.getTransferType() definition code for java.awt.image.SampleModel.getTransferType() , getWidth sample code for java.awt.image.SampleModel.getWidth() definition code for java.awt.image.SampleModel.getWidth() , setDataElements sample code for java.awt.image.SampleModel.setDataElements(int, int, int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setDataElements(int, int, int, int, java.lang.Object, java.awt.image.DataBuffer) , setPixel sample code for java.awt.image.SampleModel.setPixel(int, int, double[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setPixel(int, int, double[], java.awt.image.DataBuffer) , setPixel sample code for java.awt.image.SampleModel.setPixel(int, int, float[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setPixel(int, int, float[], java.awt.image.DataBuffer) , setPixels sample code for java.awt.image.SampleModel.setPixels(int, int, int, int, double[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setPixels(int, int, int, int, double[], java.awt.image.DataBuffer) , setPixels sample code for java.awt.image.SampleModel.setPixels(int, int, int, int, float[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setPixels(int, int, int, int, float[], java.awt.image.DataBuffer) , setSamples sample code for java.awt.image.SampleModel.setSamples(int, int, int, int, int, double[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setSamples(int, int, int, int, int, double[], java.awt.image.DataBuffer) , setSamples sample code for java.awt.image.SampleModel.setSamples(int, int, int, int, int, float[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setSamples(int, int, int, int, int, float[], java.awt.image.DataBuffer)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

BandedSampleModel sample code for java.awt.image.BandedSampleModel(int, int, int, int) definition code for java.awt.image.BandedSampleModel(int, int, int, int)

public BandedSampleModel(int dataType,
                         int w,
                         int h,
                         int numBands)
Constructs a BandedSampleModel with the specified parameters. The pixel stride will be one data element. The scanline stride will be the same as the width. Each band will be stored in a separate bank and all band offsets will be zero.

Parameters:
dataType - The data type for storing samples.
w - The width (in pixels) of the region of image data described.
h - The height (in pixels) of the region of image data described.
numBands - The number of bands for the image data.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if dataType is not one of the supported data types

BandedSampleModel sample code for java.awt.image.BandedSampleModel(int, int, int, int, int[], int[]) definition code for java.awt.image.BandedSampleModel(int, int, int, int, int[], int[])

public BandedSampleModel(int dataType,
                         int w,
                         int h,
                         int scanlineStride,
                         int[] bankIndices,
                         int[] bandOffsets)
Constructs a BandedSampleModel with the specified parameters. The number of bands will be inferred from the lengths of the bandOffsets bankIndices arrays, which must be equal. The pixel stride will be one data element.

Parameters:
dataType - The data type for storing samples.
w - The width (in pixels) of the region of image data described.
h - The height (in pixels) of the region of image data described.
scanlineStride - The line stride of the of the image data.
bankIndices - The bank index for each band.
bandOffsets - The band offset for each band.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if dataType is not one of the supported data types
Method Detail

createCompatibleSampleModel sample code for java.awt.image.BandedSampleModel.createCompatibleSampleModel(int, int) definition code for java.awt.image.BandedSampleModel.createCompatibleSampleModel(int, int)

public SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel  createCompatibleSampleModel(int w,
                                               int h)
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.

Overrides:
createCompatibleSampleModel sample code for java.awt.image.ComponentSampleModel.createCompatibleSampleModel(int, int) definition code for java.awt.image.ComponentSampleModel.createCompatibleSampleModel(int, int) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
w - the width of the resulting BandedSampleModel
h - the height of the resulting BandedSampleModel
Returns:
a new BandedSampleModel with the specified width and height.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if w or h equals either Integer.MAX_VALUE or Integer.MIN_VALUE
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if dataType is not one of the supported data types

createSubsetSampleModel sample code for java.awt.image.BandedSampleModel.createSubsetSampleModel(int[]) definition code for java.awt.image.BandedSampleModel.createSubsetSampleModel(int[])

public SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel  createSubsetSampleModel(int[] bands)
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.

Overrides:
createSubsetSampleModel sample code for java.awt.image.ComponentSampleModel.createSubsetSampleModel(int[]) definition code for java.awt.image.ComponentSampleModel.createSubsetSampleModel(int[]) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
bands - a subset of bands from this ComponentSampleModel
Returns:
a ComponentSampleModel created with a subset of bands from this ComponentSampleModel.
Throws:
RasterFormatException sample code for java.awt.image.RasterFormatException definition code for java.awt.image.RasterFormatException - if the number of bands is greater than the number of banks in this sample model.
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if dataType is not one of the supported data types

createDataBuffer sample code for java.awt.image.BandedSampleModel.createDataBuffer() definition code for java.awt.image.BandedSampleModel.createDataBuffer()

public DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  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.

Overrides:
createDataBuffer sample code for java.awt.image.ComponentSampleModel.createDataBuffer() definition code for java.awt.image.ComponentSampleModel.createDataBuffer() in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Returns:
a DataBuffer whose data type, number of banks and size are consistent with this ComponentSampleModel.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if dataType is not one of the supported types.

getDataElements sample code for java.awt.image.BandedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)

public Object sample code for java.lang.Object definition code for java.lang.Object  getDataElements(int x,
                              int y,
                              Object sample code for java.lang.Object definition code for java.lang.Object  obj,
                              DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
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);
 
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.

Overrides:
getDataElements sample code for java.awt.image.ComponentSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
obj - If non-null, a primitive array in which to return the pixel data.
data - The DataBuffer containing the image data.
Returns:
the data for the specified pixel.
See Also:
setDataElements(int, int, Object, DataBuffer) sample code for java.awt.image.BandedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)

getPixel sample code for java.awt.image.BandedSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer)

public int[] getPixel(int x,
                      int y,
                      int[] iArray,
                      DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
Returns all samples for the specified pixel in an int array. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:
getPixel sample code for java.awt.image.ComponentSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
iArray - If non-null, returns the samples in this array
data - The DataBuffer containing the image data
Returns:
the samples for the specified pixel.
See Also:
setPixel(int, int, int[], DataBuffer) sample code for java.awt.image.BandedSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer)

getPixels sample code for java.awt.image.BandedSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer)

public int[] getPixels(int x,
                       int y,
                       int w,
                       int h,
                       int[] iArray,
                       DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
Returns all samples for the specified rectangle of pixels in an int array, one sample per data array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:
getPixels sample code for java.awt.image.ComponentSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the upper left pixel location
w - The width of the pixel rectangle
h - The height of the pixel rectangle
iArray - If non-null, returns the samples in this array
data - The DataBuffer containing the image data
Returns:
the samples for the pixels within the specified region.
See Also:
setPixels(int, int, int, int, int[], DataBuffer) sample code for java.awt.image.BandedSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer)

getSample sample code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer)

public int getSample(int x,
                     int y,
                     int b,
                     DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
Returns as int the sample in a specified band for the pixel located at (x,y). ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:
getSample sample code for java.awt.image.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
b - The band to return
data - The DataBuffer containing the image data
Returns:
the sample in the specified band for the specified pixel.
See Also:
setSample(int, int, int, int, DataBuffer) sample code for java.awt.image.BandedSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer)

getSampleFloat sample code for java.awt.image.BandedSampleModel.getSampleFloat(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSampleFloat(int, int, int, java.awt.image.DataBuffer)

public float getSampleFloat(int x,
                            int y,
                            int b,
                            DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
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.

Overrides:
getSampleFloat sample code for java.awt.image.ComponentSampleModel.getSampleFloat(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getSampleFloat(int, int, int, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - Thecoordinates of the pixel location
b - The band to return
data - The DataBuffer containing the image data
Returns:
a float value that represents the sample in the specified band for the specified pixel.

getSampleDouble sample code for java.awt.image.BandedSampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer)

public double getSampleDouble(int x,
                              int y,
                              int b,
                              DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
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.

Overrides:
getSampleDouble sample code for java.awt.image.ComponentSampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
b - The band to return
data - The DataBuffer containing the image data
Returns:
a double value that represents the sample in the specified band for the specified pixel.

getSamples sample code for java.awt.image.BandedSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer)

public int[] getSamples(int x,
                        int y,
                        int w,
                        int h,
                        int b,
                        int[] iArray,
                        DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
Returns the samples in a specified band for the specified rectangle of pixels in an int array, one sample per data array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:
getSamples sample code for java.awt.image.ComponentSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the upper left pixel location
w - The width of the pixel rectangle
h - The height of the pixel rectangle
b - The band to return
iArray - If non-null, returns the samples in this array
data - The DataBuffer containing the image data
Returns:
the samples in the specified band for the pixels within the specified region.
See Also:
setSamples(int, int, int, int, int, int[], DataBuffer) sample code for java.awt.image.BandedSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer)

setDataElements sample code for java.awt.image.BandedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)

public void setDataElements(int x,
                            int y,
                            Object sample code for java.lang.Object definition code for java.lang.Object  obj,
                            DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
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);
 
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.

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.

Overrides:
setDataElements sample code for java.awt.image.ComponentSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
obj - If non-null, returns the primitive array in this object
data - The DataBuffer containing the image data
See Also:
getDataElements(int, int, Object, DataBuffer) sample code for java.awt.image.BandedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)

setPixel sample code for java.awt.image.BandedSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer)

public void setPixel(int x,
                     int y,
                     int[] iArray,
                     DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
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.

Overrides:
setPixel sample code for java.awt.image.ComponentSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
iArray - The input samples in an int array
data - The DataBuffer containing the image data
See Also:
getPixel(int, int, int[], DataBuffer) sample code for java.awt.image.BandedSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer)

setPixels sample code for java.awt.image.BandedSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer)

public void setPixels(int x,
                      int y,
                      int w,
                      int h,
                      int[] iArray,
                      DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
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.

Overrides:
setPixels sample code for java.awt.image.ComponentSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the upper left pixel location
w - The width of the pixel rectangle
h - The height of the pixel rectangle
iArray - The input samples in an int array
data - The DataBuffer containing the image data
See Also:
getPixels(int, int, int, int, int[], DataBuffer) sample code for java.awt.image.BandedSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer)

setSample sample code for java.awt.image.BandedSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer)

public void setSample(int x,
                      int y,
                      int b,
                      int s,
                      DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
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.

Overrides:
setSample sample code for java.awt.image.ComponentSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
b - The band to set
s - The input sample as an int
data - The DataBuffer containing the image data
See Also:
getSample(int, int, int, DataBuffer) sample code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer)

setSample sample code for java.awt.image.BandedSampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer)

public void setSample(int x,
                      int y,
                      int b,
                      float s,
                      DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:
setSample sample code for java.awt.image.ComponentSampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
b - The band to set
s - The input sample as a float
data - The DataBuffer containing the image data
See Also:
getSample(int, int, int, DataBuffer) sample code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer)

setSample sample code for java.awt.image.BandedSampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer)

public void setSample(int x,
                      int y,
                      int b,
                      double s,
                      DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  data)
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a double for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:
setSample sample code for java.awt.image.ComponentSampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the pixel location
b - The band to set
s - The input sample as a double
data - The DataBuffer containing the image data
See Also:
getSample(int, int, int, DataBuffer) sample code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSample(int, int, int, java.awt.image.DataBuffer)

setSamples sample code for java.awt.image.BandedSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer)

public void setSamples(int x,
                       int y,
                       int w,
                       int h,
                       int b,
                       int[] iArray,
                       DataBuffer sample code for java.awt.image.DataBuffer definition code for java.awt.image.DataBuffer  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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.

Overrides:
setSamples sample code for java.awt.image.ComponentSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Parameters:
x, y - The coordinates of the upper left pixel location
w - The width of the pixel rectangle
h - The height of the pixel rectangle
b - The band to set
iArray - The input sample array
data - The DataBuffer containing the image data
See Also:
getSamples(int, int, int, int, int, int[], DataBuffer) sample code for java.awt.image.BandedSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.BandedSampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer)

hashCode sample code for java.awt.image.BandedSampleModel.hashCode() definition code for java.awt.image.BandedSampleModel.hashCode()

public int hashCode()
Description copied from class: Object sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode sample code for java.awt.image.ComponentSampleModel.hashCode() definition code for java.awt.image.ComponentSampleModel.hashCode() in class ComponentSampleModel sample code for java.awt.image.ComponentSampleModel definition code for java.awt.image.ComponentSampleModel
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable