Home » openjdk-7 » java » awt » image » [javadoc | source]
java.awt.image
public class: ComponentSampleModel [javadoc | source]
java.lang.Object
   java.awt.image.SampleModel
      java.awt.image.ComponentSampleModel

Direct Known Subclasses:
    BandedSampleModel, PixelInterleavedSampleModel

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 , TYPE_USHORT , TYPE_SHORT , TYPE_INT , TYPE_FLOAT , TYPE_DOUBLE ,
Field Summary
protected  int[] bandOffsets    Offsets for all bands in data array elements. 
protected  int[] bankIndices    Index for each bank storing a band of image data. 
protected  int numBands    The number of bands in this ComponentSampleModel
protected  int numBanks    The number of banks in this ComponentSampleModel
protected  int scanlineStride    Line stride (in data array elements) of the region of image data described by this ComponentSampleModel. 
protected  int pixelStride    Pixel stride (in data array elements) of the region of image data described by this ComponentSampleModel. 
Fields inherited from java.awt.image.SampleModel:
width,  height,  numBands,  dataType
Constructor:
 public ComponentSampleModel(int dataType,
    int w,
    int h,
    int pixelStride,
    int scanlineStride,
    int[] bandOffsets) 
 public ComponentSampleModel(int dataType,
    int w,
    int h,
    int pixelStride,
    int scanlineStride,
    int[] bankIndices,
    int[] bandOffsets) 
Method from java.awt.image.ComponentSampleModel Summary:
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.ComponentSampleModel Detail:
 public 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.
 public 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.
 public 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.
 public boolean equals(Object o) 
 public final int[] getBandOffsets() 
    Returns the band offset for all bands.
 public final int[] getBankIndices() 
    Returns the bank indices for all bands.
 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 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.

 public final int getNumDataElements() 
 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));
    
 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));
    
 public int[] getPixel(int x,
    int y,
    int[] iArray,
    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.
 public final int getPixelStride() 
    Returns the pixel stride of this ComponentSampleModel.
 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 array element. An ArrayIndexOutOfBoundsException might 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). An ArrayIndexOutOfBoundsException might 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. An ArrayIndexOutOfBoundsException might 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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
 public final int[] getSampleSize() 
    Returns the number of bits per sample for all bands.
 public final int getSampleSize(int band) 
    Returns the number of bits per sample for the specified band.
 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. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
 public final int getScanlineStride() 
    Returns the scanline stride of this ComponentSampleModel.
 public int hashCode() 
 int[] orderBands(int[] orig,
    int step) 
    Preserves band ordering with new step factor...
 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 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.

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