Home » openjdk-7 » java » awt » image » [javadoc | source]
java.awt.image
public class: SinglePixelPackedSampleModel [javadoc | source]
java.lang.Object
   java.awt.image.SampleModel
      java.awt.image.SinglePixelPackedSampleModel
This class represents pixel data packed such that the N samples which make up a single pixel are stored in a single data array element, and each data data array element holds samples for only one pixel. This class supports TYPE_BYTE , TYPE_USHORT , TYPE_INT data types. All data array elements reside in the first bank of a DataBuffer. Accessor methods are provided so that the image data can be manipulated directly. 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. Bit masks are the masks required to extract the samples representing the bands of the pixel. Bit offsets are the offsets in bits into the data array element of the samples representing the bands of the pixel.

The following code illustrates extracting the bits of the sample representing band b for pixel x,y from DataBuffer data:

     int sample = data.getElem(y * scanlineStride + x);
     sample = (sample & bitMasks[b]) >>> bitOffsets[b];
Fields inherited from java.awt.image.SampleModel:
width,  height,  numBands,  dataType
Constructor:
 public SinglePixelPackedSampleModel(int dataType,
    int w,
    int h,
    int[] bitMasks) 
 public SinglePixelPackedSampleModel(int dataType,
    int w,
    int h,
    int scanlineStride,
    int[] bitMasks) 
Method from java.awt.image.SinglePixelPackedSampleModel Summary:
createCompatibleSampleModel,   createDataBuffer,   createSubsetSampleModel,   equals,   getBitMasks,   getBitOffsets,   getDataElements,   getNumDataElements,   getOffset,   getPixel,   getPixels,   getSample,   getSampleSize,   getSampleSize,   getSamples,   getScanlineStride,   hashCode,   setDataElements,   setPixel,   setPixels,   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.SinglePixelPackedSampleModel Detail:
 public SampleModel createCompatibleSampleModel(int w,
    int h) 
    Creates a new SinglePixelPackedSampleModel with the specified width and height. The new SinglePixelPackedSampleModel will have the same storage data type and bit masks as this SinglePixelPackedSampleModel.
 public DataBuffer createDataBuffer() 
    Creates a DataBuffer that corresponds to this SinglePixelPackedSampleModel. The DataBuffer's data type and size will be consistent with this SinglePixelPackedSampleModel. The DataBuffer will have a single bank.
 public SampleModel createSubsetSampleModel(int[] bands) 
    This creates a new SinglePixelPackedSampleModel with a subset of the bands of this SinglePixelPackedSampleModel. The new SinglePixelPackedSampleModel can be used with any DataBuffer that the existing SinglePixelPackedSampleModel can be used with. The new SinglePixelPackedSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original SinglePixelPackedSampleModel/DataBuffer combination.
 public boolean equals(Object o) 
 public int[] getBitMasks() 
    Returns the bit masks for all bands.
 public int[] getBitOffsets() 
    Returns the bit offsets into the data array element representing a pixel 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 SinglePixelPackedSampleModel, the array will have one element, and the type will be the same as the storage data type. 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 SinglePixelPackedSampleModel sppsm1, to DataBuffer db2, whose storage layout is described by SinglePixelPackedSampleModel sppsm2. The transfer will generally be more efficient than using getPixel/setPixel.

          SinglePixelPackedSampleModel sppsm1, sppsm2;
          DataBufferInt db1, db2;
          sppsm2.setDataElements(x, y, sppsm1.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 getNumDataElements() 
    Returns the number of data elements needed to transfer one pixel via the getDataElements and setDataElements methods. For a SinglePixelPackedSampleModel, this is one.
 public int getOffset(int x,
    int y) 
    Returns the offset (in data array elements) of pixel (x,y). The data element containing pixel x,y can be retrieved from a DataBuffer data with a SinglePixelPackedSampleModel sppsm as:
           data.getElem(sppsm.getOffset(x, y));
    
 public int[] getPixel(int x,
    int y,
    int[] iArray,
    DataBuffer data) 
    Returns all samples in 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 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 int[] getSampleSize() 
    Returns the number of bits per sample for all bands.
 public 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 for a specified band for the specified rectangle of pixels in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
 public int getScanlineStride() 
    Returns the scanline stride of this SinglePixelPackedSampleModel.
 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 SinglePixelPackedSampleModel, only the first element of the array will hold valid data, and the type of the array must be the same as the storage data type of the SinglePixelPackedSampleModel.

    The following code illustrates transferring data for one pixel from DataBuffer db1, whose storage layout is described by SinglePixelPackedSampleModel sppsm1, to DataBuffer db2, whose storage layout is described by SinglePixelPackedSampleModel sppsm2. The transfer will generally be more efficient than using getPixel/setPixel.

          SinglePixelPackedSampleModel sppsm1, sppsm2;
          DataBufferInt db1, db2;
          sppsm2.setDataElements(x, y, sppsm1.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 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 array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.