java.awt.image
Class BandedSampleModel

java.lang.Object
  |
  +--java.awt.image.SampleModel
        |
        +--java.awt.image.ComponentSampleModel
              |
              +--java.awt.image.BandedSampleModel
public final class BandedSampleModel
extends 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, TYPE_USHORT, TYPE_SHORT, TYPE_INT, TYPE_FLOAT, and TYPE_DOUBLE datatypes

 

Field Summary

 
Fields inherited from class java.awt.image.ComponentSampleModel
bandOffsets, bankIndices, numBands, numBanks, pixelStride, scanlineStride
 
Fields inherited from class java.awt.image.SampleModel
dataType, height, width
 

 

Constructor Summary

BandedSampleModel(int dataType, int w, int h, int numBands)
    Constructs a BandedSampleModel with the specified parameters.
BandedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets)
    Constructs a BandedSampleModel with the specified parameters.
 

 

Method Summary

 SampleModel createCompatibleSampleModel(int w, int h)
    Creates a new BandedSampleModel with the specified width and height.
 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.
 SampleModel createSubsetSampleModel(int[] bands)
    Creates a new BandedSampleModel with a subset of the bands of this BandedSampleModel.
 Object getDataElements(int x, int y, Object obj, DataBuffer data)
    Returns data for a single pixel in a primitive array of type TransferType.
 int[] getPixel(int x, int y, int[] iArray, DataBuffer data)
    Returns all samples for the specified pixel in an int array.
 int[] getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
    Returns all samples for the specified rectangle of pixels in an int array, one sample per data array element.
 int getSample(int x, int y, int b, DataBuffer data)
    Returns as int the sample in a specified band for the pixel located at (x,y).
 double getSampleDouble(int x, int y, int b, DataBuffer data)
    Returns the sample in a specified band for a pixel located at (x,y) as a double.
 float getSampleFloat(int x, int y, int b, DataBuffer data)
    Returns the sample in a specified band for the pixel located at (x,y) as a float.
 int[] getSamples(int x, int y, int w, int h, int b, int[] iArray, 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()
    Returns a hash code value for the object.
 void setDataElements(int x, int y, Object obj, DataBuffer data)
    Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType.
 void setPixel(int x, int y, int[] iArray, DataBuffer data)
    Sets a pixel in the DataBuffer using an int array of samples for input.
 void setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
    Sets all samples for a rectangle of pixels from an int array containing one sample per array element.
 void setSample(int x, int y, int b, double s, 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(int x, int y, int b, float s, 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(int x, int y, int b, int s, 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(int x, int y, int w, int h, int b, int[] iArray, 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
equals, getBandOffsets, getBankIndices, getNumDataElements, getOffset, getOffset, getPixelStride, getSampleSize, getSampleSize, getScanlineStride
 
Methods inherited from class java.awt.image.SampleModel
getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSamples, getSamples, getTransferType, getWidth,