Home » openjdk-7 » java » awt » image » [javadoc | source]
java.awt.image
public final class: BandedSampleModel [javadoc | source]
java.lang.Object
   java.awt.image.SampleModel
      java.awt.image.ComponentSampleModel
         java.awt.image.BandedSampleModel
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
Fields inherited from java.awt.image.ComponentSampleModel:
bandOffsets,  bankIndices,  numBands,  numBanks,  scanlineStride,  pixelStride
Fields inherited from java.awt.image.SampleModel:
width,  height,  numBands,  dataType
Constructor:
 public BandedSampleModel(int dataType,
    int w,
    int h,
    int numBands) 
 public BandedSampleModel(int dataType,
    int w,
    int h,
    int scanlineStride,
    int[] bankIndices,
    int[] bandOffsets) 
Method from java.awt.image.BandedSampleModel Summary:
createCompatibleSampleModel,   createDataBuffer,   createSubsetSampleModel,   getDataElements,   getPixel,   getPixels,   getSample,   getSampleDouble,   getSampleFloat,   getSamples,   hashCode,   setDataElements,   setPixel,   setPixels,   setSample,   setSample,   setSample,   setSamples
Methods from java.awt.image.ComponentSampleModel:
createCompatibleSampleModel,   createDataBuffer,   createSubsetSampleModel,   equals,   getBandOffsets,   getBankIndices,   getDataElements,   getNumDataElements,   getOffset,   getOffset,   getPixel,   getPixelStride,   getPixels,   getSample,   getSampleDouble,   getSampleFloat,   getSampleSize,   getSampleSize,   getSamples,   getScanlineStride,   hashCode,   orderBands,   setDataElements,   setPixel,   setPixels,   setSample,   setSample,   setSample,   setSamples
Methods from java.awt.image.SampleModel:
createCompatibleSampleModel,   createDataBuffer,   createSubsetSampleModel,   getDataElements,   getDataElements,   getDataType,   getHeight,   getNumBands,   getNumDataElements,   getPixel,   getPixel,   getPixel,   getPixels,   getPixels,   getPixels,   getSample,   getSampleDouble,   getSampleFloat,   getSampleSize,   getSampleSize,   getSamples,   getSamples,   getSamples,   getTransferType,   getWidth,   setDataElements,   setDataElements,   setPixel,   setPixel,   setPixel,   setPixels,   setPixels,   setPixels,   setSample,   setSample,   setSample,   setSamples,   setSamples,   setSamples
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.image.BandedSampleModel Detail:
 public 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.
 public 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.
 public 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.
 public Object getDataElements(int x,
    int y,
    Object obj,
    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.

 public int[] getPixel(int x,
    int y,
    int[] iArray,
    DataBuffer data) 
    Returns all samples for the specified pixel in an int array. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public 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). ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public 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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public int hashCode() 
 public  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. 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.

 public  void setPixel(int x,
    int y,
    int[] iArray,
    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.
 public  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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public  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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public  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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public  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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public  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. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.