java.awt.image
Class ComponentSampleModel

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
Direct Known Subclasses:
BandedSampleModel sample code for java.awt.image.BandedSampleModel definition code for java.awt.image.BandedSampleModel , PixelInterleavedSampleModel sample code for java.awt.image.PixelInterleavedSampleModel definition code for java.awt.image.PixelInterleavedSampleModel

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

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

See Also:
PixelInterleavedSampleModel sample code for java.awt.image.PixelInterleavedSampleModel definition code for java.awt.image.PixelInterleavedSampleModel , BandedSampleModel sample code for java.awt.image.BandedSampleModel definition code for java.awt.image.BandedSampleModel

Field Summary
protected  int[] bandOffsets sample code for java.awt.image.ComponentSampleModel.bandOffsets definition code for java.awt.image.ComponentSampleModel.bandOffsets
          Offsets for all bands in data array elements.
protected  int[] bankIndices sample code for java.awt.image.ComponentSampleModel.bankIndices definition code for java.awt.image.ComponentSampleModel.bankIndices
          Index for each bank storing a band of image data.
protected  int numBands sample code for java.awt.image.ComponentSampleModel.numBands definition code for java.awt.image.ComponentSampleModel.numBands
          The number of bands in this ComponentSampleModel.
protected  int numBanks sample code for java.awt.image.ComponentSampleModel.numBanks definition code for java.awt.image.ComponentSampleModel.numBanks
          The number of banks in this ComponentSampleModel.
protected  int pixelStride sample code for java.awt.image.ComponentSampleModel.pixelStride definition code for java.awt.image.ComponentSampleModel.pixelStride
          Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.
protected  int scanlineStride sample code for java.awt.image.ComponentSampleModel.scanlineStride definition code for java.awt.image.ComponentSampleModel.scanlineStride
          Line stride (in data array elements) of the region of image data described by this ComponentSampleModel.
 
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
ComponentSampleModel sample code for java.awt.image.ComponentSampleModel.ComponentSampleModel(int, int, int, int, int, int[]) definition code for java.awt.image.ComponentSampleModel.ComponentSampleModel(int, int, int, int, int, int[]) (int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bandOffsets)
          Constructs a ComponentSampleModel with the specified parameters.
ComponentSampleModel sample code for java.awt.image.ComponentSampleModel.ComponentSampleModel(int, int, int, int, int, int[], int[]) definition code for java.awt.image.ComponentSampleModel.ComponentSampleModel(int, int, int, int, int, int[], int[]) (int dataType, int w, int h, int pixelStride, int scanlineStride, int[] bankIndices, int[] bandOffsets)
          Constructs a ComponentSampleModel 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.ComponentSampleModel.createCompatibleSampleModel(int, int) definition code for java.awt.image.ComponentSampleModel.createCompatibleSampleModel(int, int) (int w, int h)
          Creates a new ComponentSampleModel 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.ComponentSampleModel.createDataBuffer() definition code for java.awt.image.ComponentSampleModel.createDataBuffer() ()
          Creates a DataBuffer that corresponds to this ComponentSampleModel.
 SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel createSubsetSampleModel sample code for java.awt.image.ComponentSampleModel.createSubsetSampleModel(int[]) definition code for java.awt.image.ComponentSampleModel.createSubsetSampleModel(int[]) (int[] bands)
          Creates a new ComponentSampleModel with a subset of the bands of this ComponentSampleModel.
 boolean equals sample code for java.awt.image.ComponentSampleModel.equals(java.lang.Object) definition code for java.awt.image.ComponentSampleModel.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  o)
          Indicates whether some other object is "equal to" this one.
 int[] getBandOffsets sample code for java.awt.image.ComponentSampleModel.getBandOffsets() definition code for java.awt.image.ComponentSampleModel.getBandOffsets() ()
          Returns the band offset for all bands.
 int[] getBankIndices sample code for java.awt.image.ComponentSampleModel.getBankIndices() definition code for java.awt.image.ComponentSampleModel.getBankIndices() ()
          Returns the bank indices for all bands.
 Object sample code for java.lang.Object definition code for java.lang.Object 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) (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 getNumDataElements sample code for java.awt.image.ComponentSampleModel.getNumDataElements() definition code for java.awt.image.ComponentSampleModel.getNumDataElements() ()
          Returns the number of data elements needed to transfer a pixel with the getDataElements(int, int, Object, DataBuffer) 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) and setDataElements(int, int, Object, DataBuffer) 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) methods.
 int getOffset sample code for java.awt.image.ComponentSampleModel.getOffset(int, int) definition code for java.awt.image.ComponentSampleModel.getOffset(int, int) (int x, int y)
          Gets the offset for the first band of pixel (x,y).
 int getOffset sample code for java.awt.image.ComponentSampleModel.getOffset(int, int, int) definition code for java.awt.image.ComponentSampleModel.getOffset(int, int, int) (int x, int y, int b)
          Gets the offset for band b of pixel (x,y).
 int[] 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) (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, one sample per array element.
 int[] 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) (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 array element.
 int getPixelStride sample code for java.awt.image.ComponentSampleModel.getPixelStride() definition code for java.awt.image.ComponentSampleModel.getPixelStride() ()
          Returns the pixel stride of this ComponentSampleModel.
 int 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) (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.ComponentSampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.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.ComponentSampleModel.getSampleFloat(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.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.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) (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[] getSampleSize sample code for java.awt.image.ComponentSampleModel.getSampleSize() definition code for java.awt.image.ComponentSampleModel.getSampleSize() ()
          Returns the number of bits per sample for all bands.
 int getSampleSize sample code for java.awt.image.ComponentSampleModel.getSampleSize(int) definition code for java.awt.image.ComponentSampleModel.getSampleSize(int) (int band)
          Returns the number of bits per sample for the specified band.
 int getScanlineStride sample code for java.awt.image.ComponentSampleModel.getScanlineStride() definition code for java.awt.image.ComponentSampleModel.getScanlineStride() ()
          Returns the scanline stride of this ComponentSampleModel.
 int hashCode sample code for java.awt.image.ComponentSampleModel.hashCode() definition code for java.awt.image.ComponentSampleModel.hashCode() ()
          Returns a hash code value for the object.
 void 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) (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.ComponentSampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.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.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) (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.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) (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.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) (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.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) (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.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) (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.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)
 

Field Detail

bandOffsets sample code for java.awt.image.ComponentSampleModel.bandOffsets

protected int[] bandOffsets
Offsets for all bands in data array elements.


bankIndices sample code for java.awt.image.ComponentSampleModel.bankIndices

protected int[] bankIndices
Index for each bank storing a band of image data.


numBands sample code for java.awt.image.ComponentSampleModel.numBands

protected int numBands
The number of bands in this ComponentSampleModel.


numBanks sample code for java.awt.image.ComponentSampleModel.numBanks

protected int numBanks
The number of banks in this ComponentSampleModel.


scanlineStride sample code for java.awt.image.ComponentSampleModel.scanlineStride

protected int scanlineStride
Line stride (in data array elements) of the region of image data described by this ComponentSampleModel.


pixelStride sample code for java.awt.image.ComponentSampleModel.pixelStride

protected int pixelStride
Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel.

Constructor Detail

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

public ComponentSampleModel(int dataType,
                            int w,
                            int h,
                            int pixelStride,
                            int scanlineStride,
                            int[] bandOffsets)
Constructs a ComponentSampleModel with the specified parameters. The number of bands will be given by the length of the bandOffsets array. All bands will be stored in the first bank of the DataBuffer.

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
pixelStride - the pixel stride of the region of image data described
scanlineStride - the line stride of the region of image data described
bandOffsets - the offsets of all bands
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if w or h is not greater than 0
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if pixelStride is less than 0
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if scanlineStride is less than 0
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if numBands is less than 1
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the product of w and h is greater than Integer.MAX_VALUE
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if dataType is not one of the supported data types

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

public ComponentSampleModel(int dataType,
                            int w,
                            int h,
                            int pixelStride,
                            int scanlineStride,
                            int[] bankIndices,
                            int[] bandOffsets)
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.

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
pixelStride - the pixel stride of the region of image data described
scanlineStride - The line stride of the region of image data described
bankIndices - the bank indices of all bands
bandOffsets - the band offsets of all bands
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if w or h is not greater than 0
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if pixelStride is less than 0
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if scanlineStride is less than 0
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the length of bankIndices does not equal the length of bankOffsets
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if any of the bank indices of bandIndices is less than 0
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.ComponentSampleModel.createCompatibleSampleModel(int, int) definition code for java.awt.image.ComponentSampleModel.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 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.

Specified by:
createCompatibleSampleModel sample code for java.awt.image.SampleModel.createCompatibleSampleModel(int, int) definition code for java.awt.image.SampleModel.createCompatibleSampleModel(int, int) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
Parameters:
w - the width of the resulting SampleModel
h - the height of the resulting SampleModel
Returns:
a new ComponentSampleModel with the specified size
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if w or h is not greater than 0

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

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

Specified by:
createSubsetSampleModel sample code for java.awt.image.SampleModel.createSubsetSampleModel(int[]) definition code for java.awt.image.SampleModel.createSubsetSampleModel(int[]) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
Parameters:
bands - a subset of bands from this ComponentSampleModel
Returns:
a ComponentSampleModel created with a subset of bands from this ComponentSampleModel.

createDataBuffer sample code for java.awt.image.ComponentSampleModel.createDataBuffer() definition code for java.awt.image.ComponentSampleModel.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 ComponentSampleModel. The DataBuffer object's data type, number of banks, and size are be consistent with this ComponentSampleModel.

Specified by:
createDataBuffer sample code for java.awt.image.SampleModel.createDataBuffer() definition code for java.awt.image.SampleModel.createDataBuffer() in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
Returns:
a DataBuffer whose data type, number of banks and size are consistent with this ComponentSampleModel.

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

public int getOffset(int x,
                     int y)
Gets the offset for the first band of pixel (x,y). A sample of the first band can be retrieved from a DataBuffer data with a ComponentSampleModel csm as
        data.getElem(csm.getOffset(x, y));
 

Parameters:
x, y - the location of the pixel
Returns:
the offset for the first band of the specified pixel.

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

public int getOffset(int x,
                     int y,
                     int 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));
 

Parameters:
x, y - the location of the specified pixel
b - the specified band
Returns:
the offset for the specified band of the specified pixel.

getSampleSize sample code for java.awt.image.ComponentSampleModel.getSampleSize() definition code for java.awt.image.ComponentSampleModel.getSampleSize()

public final int[] getSampleSize()
Returns the number of bits per sample for all bands.

Specified by:
getSampleSize sample code for java.awt.image.SampleModel.getSampleSize() definition code for java.awt.image.SampleModel.getSampleSize() in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
Returns:
an array containing the number of bits per sample for all bands, where each element in the array represents a band.

getSampleSize sample code for java.awt.image.ComponentSampleModel.getSampleSize(int) definition code for java.awt.image.ComponentSampleModel.getSampleSize(int)

public final int getSampleSize(int band)
Returns the number of bits per sample for the specified band.

Specified by:
getSampleSize sample code for java.awt.image.SampleModel.getSampleSize(int) definition code for java.awt.image.SampleModel.getSampleSize(int) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
Parameters:
band - the specified band
Returns:
the number of bits per sample for the specified band.

getBankIndices sample code for java.awt.image.ComponentSampleModel.getBankIndices() definition code for java.awt.image.ComponentSampleModel.getBankIndices()

public final int[] getBankIndices()
Returns the bank indices for all bands.

Returns:
the bank indices for all bands.

getBandOffsets sample code for java.awt.image.ComponentSampleModel.getBandOffsets() definition code for java.awt.image.ComponentSampleModel.getBandOffsets()

public final int[] getBandOffsets()
Returns the band offset for all bands.

Returns:
the band offsets for all bands.

getScanlineStride sample code for java.awt.image.ComponentSampleModel.getScanlineStride() definition code for java.awt.image.ComponentSampleModel.getScanlineStride()

public final int getScanlineStride()
Returns the scanline stride of this ComponentSampleModel.

Returns:
the scanline stride of this ComponentSampleModel.

getPixelStride sample code for java.awt.image.ComponentSampleModel.getPixelStride() definition code for java.awt.image.ComponentSampleModel.getPixelStride()

public final int getPixelStride()
Returns the pixel stride of this ComponentSampleModel.

Returns:
the pixel stride of this ComponentSampleModel.

getNumDataElements sample code for java.awt.image.ComponentSampleModel.getNumDataElements() definition code for java.awt.image.ComponentSampleModel.getNumDataElements()

public final int getNumDataElements()
Returns the number of data elements needed to transfer a pixel with the getDataElements(int, int, Object, DataBuffer) 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) and setDataElements(int, int, Object, DataBuffer) 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) methods. For a ComponentSampleModel, this is identical to the number of bands.

Specified by:
getNumDataElements sample code for java.awt.image.SampleModel.getNumDataElements() definition code for java.awt.image.SampleModel.getNumDataElements() in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
Returns:
the number of data elements needed to transfer a pixel with the getDataElements and setDataElements methods.
See Also:
SampleModel.getNumDataElements() sample code for java.awt.image.SampleModel.getNumDataElements() definition code for java.awt.image.SampleModel.getNumDataElements() , SampleModel.getNumBands() sample code for java.awt.image.SampleModel.getNumBands() definition code for java.awt.image.SampleModel.getNumBands()

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)

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

Specified by:
getDataElements sample code for java.awt.image.SampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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 of the specified pixel
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if data is null.
ArrayIndexOutOfBoundsException sample code for java.lang.ArrayIndexOutOfBoundsException definition code for java.lang.ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if obj is too small to hold the ouput.
See Also:
setDataElements(int, int, Object, DataBuffer) 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)

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)

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, one sample per array element. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
getPixel sample code for java.awt.image.SampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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 of the specified pixel.
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if data is null.
ArrayIndexOutOfBoundsException sample code for java.lang.ArrayIndexOutOfBoundsException definition code for java.lang.ArrayIndexOutOfBoundsException - if the coordinates are not in bounds, or if iArray is too small to hold the output.
See Also:
setPixel(int, int, int[], DataBuffer) 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)

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)

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 array element. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
getPixels sample code for java.awt.image.SampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getPixels(int, int, int, int, int[], java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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 of the pixels within the specified region.
See Also:
setPixels(int, int, int, int, int[], DataBuffer) 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)

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)

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). An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Specified by:
getSample sample code for java.awt.image.SampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getSample(int, int, int, java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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 a specified band for the specified pixel
See Also:
setSample(int, int, int, int, DataBuffer) 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)

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

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

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
getSampleDouble sample code for java.awt.image.SampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getSampleDouble(int, int, int, java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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 representing the sample in the specified band for the specified pixel.

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
getSamples sample code for java.awt.image.SampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.getSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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 of the specified pixel
See Also:
setSamples(int, int, int, int, int, int[], DataBuffer) 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)

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)

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

Specified by:
setDataElements sample code for java.awt.image.SampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
Parameters:
x, y - the coordinates of the pixel location
obj - a primitive array containing pixel data
data - the DataBuffer containing the image data
See Also:
getDataElements(int, int, Object, DataBuffer) 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)

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
setPixel sample code for java.awt.image.SampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setPixel(int, int, int[], java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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.ComponentSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getPixel(int, int, int[], java.awt.image.DataBuffer)

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
setPixels sample code for java.awt.image.SampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setPixels(int, int, int, int, int[], java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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.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)

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Specified by:
setSample sample code for java.awt.image.SampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setSample(int, int, int, int, java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer)

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
setSample sample code for java.awt.image.SampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setSample(int, int, int, float, java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer)

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
setSample sample code for java.awt.image.SampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setSample(int, int, int, double, java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer) definition code for java.awt.image.ComponentSampleModel.getSample(int, int, int, java.awt.image.DataBuffer)

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)

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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.

Overrides:
setSamples sample code for java.awt.image.SampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) definition code for java.awt.image.SampleModel.setSamples(int, int, int, int, int, int[], java.awt.image.DataBuffer) in class SampleModel sample code for java.awt.image.SampleModel definition code for java.awt.image.SampleModel
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 samples in an int array
data - The DataBuffer containing the image data
See Also:
getSamples(int, int, int, int, int, int[], DataBuffer) 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)

equals sample code for java.awt.image.ComponentSampleModel.equals(java.lang.Object) definition code for java.awt.image.ComponentSampleModel.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  o)
Description copied from class: Object sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object)
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
o - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for java.awt.image.ComponentSampleModel.hashCode() definition code for java.awt.image.ComponentSampleModel.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.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
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