public SinglePixelPackedSampleModel(int dataType,
    int w,
    int h,
    int[] bitMasks) 
{
        ColorModel.loadLibraries();
        initIDs();
        this(dataType, w, h, w, bitMasks);
        if (dataType != DataBuffer.TYPE_BYTE &&
            dataType != DataBuffer.TYPE_USHORT &&
            dataType != DataBuffer.TYPE_INT) {
            throw new IllegalArgumentException("Unsupported data type "+
                                               dataType);
        }
}

Constructs a SinglePixelPackedSampleModel with bitMasks.length bands. Each sample is stored in a data array element in the position of its corresponding bit mask. Each bit mask must be contiguous and masks must not overlap.

Parameters:

dataType - The data type for storing samples.

w - The width (in pixels) of the region of the image data described.

h - The height (in pixels) of the region of the image data described.

bitMasks - The bit masks for all bands.

Throws:

IllegalArgumentException - if dataType is not either DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT

 public SinglePixelPackedSampleModel(int dataType,
    int w,
    int h,
    int scanlineStride,
    int[] bitMasks) 
{
        super(dataType, w, h, bitMasks.length);
        if (dataType != DataBuffer.TYPE_BYTE &&
            dataType != DataBuffer.TYPE_USHORT &&
            dataType != DataBuffer.TYPE_INT) {
            throw new IllegalArgumentException("Unsupported data type "+
                                               dataType);
        }
        this.dataType = dataType;
        this.bitMasks = (int[]) bitMasks.clone();
        this.scanlineStride = scanlineStride;
        this.bitOffsets = new int[numBands];
        this.bitSizes = new int[numBands];
        this.maxBitSize = 0;
        for (int i=0; i< numBands; i++) {
            int bitOffset = 0, bitSize = 0, mask;
            mask = bitMasks[i];
            if (mask != 0) {
                while ((mask & 1) == 0) {
                    mask = mask  > > > 1;
                    bitOffset++;
                }
                while ((mask & 1) == 1) {
                    mask = mask  > > > 1;
                    bitSize++;
                }
                if (mask != 0) {
                    throw new IllegalArgumentException("Mask "+bitMasks[i]+
                                                       " must be contiguous");
                }
            }
            bitOffsets[i] = bitOffset;
            bitSizes[i] = bitSize;
            if (bitSize  > maxBitSize) {
                maxBitSize = bitSize;
            }
        }
}

Constructs a SinglePixelPackedSampleModel with bitMasks.length bands and a scanline stride equal to scanlineStride data array elements. Each sample is stored in a data array element in the position of its corresponding bit mask. Each bit mask must be contiguous and masks must not overlap.

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.

scanlineStride - The line stride of the image data.

bitMasks - The bit masks for all bands.

Throws:

IllegalArgumentException - if w or h is not greater than 0

IllegalArgumentException - if any mask in bitMask is not contiguous

IllegalArgumentException - if dataType is not either DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT

 public SampleModel createCompatibleSampleModel(int w,
    int h) 
{
      SampleModel sampleModel = new SinglePixelPackedSampleModel(dataType, w, h,
                                                              bitMasks);
      return sampleModel;
}

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() 
{
        DataBuffer dataBuffer = null;
        int size = (int)getBufferSize();
        switch (dataType) {
        case DataBuffer.TYPE_BYTE:
            dataBuffer = new DataBufferByte(size);
            break;
        case DataBuffer.TYPE_USHORT:
            dataBuffer = new DataBufferUShort(size);
            break;
        case DataBuffer.TYPE_INT:
            dataBuffer = new DataBufferInt(size);
            break;
        }
        return dataBuffer;
}

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) 
{
        if (bands.length  > numBands)
            throw new RasterFormatException("There are only " +
                                            numBands +
                                            " bands");
        int newBitMasks[] = new int[bands.length];
        for (int i=0; i< bands.length; i++)
            newBitMasks[i] = bitMasks[bands[i]];
        return new SinglePixelPackedSampleModel(this.dataType, width, height,
                                           this.scanlineStride, newBitMasks);
}

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) 
{
        if ((o == null) || !(o instanceof SinglePixelPackedSampleModel)) {
            return false;
        }
        SinglePixelPackedSampleModel that = (SinglePixelPackedSampleModel)o;
        return this.width == that.width &&
            this.height == that.height &&
            this.numBands == that.numBands &&
            this.dataType == that.dataType &&
            Arrays.equals(this.bitMasks, that.bitMasks) &&
            Arrays.equals(this.bitOffsets, that.bitOffsets) &&
            Arrays.equals(this.bitSizes, that.bitSizes) &&
            this.maxBitSize == that.maxBitSize &&
            this.scanlineStride == that.scanlineStride;
}

 public int[] getBitMasks() 
{
      return (int[])bitMasks.clone();
}

Returns the bit masks for all bands.

 public int[] getBitOffsets() 
{
      return (int[])bitOffsets.clone();
}

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) 
{
        // Bounds check for 'b' will be performed automatically
        if ((x <  0) || (y <  0) || (x  >= width) || (y  >= height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int type = getTransferType();
        switch(type) {
        case DataBuffer.TYPE_BYTE:
            byte[] bdata;
            if (obj == null)
                bdata = new byte[1];
            else
                bdata = (byte[])obj;
            bdata[0] = (byte)data.getElem(y * scanlineStride + x);
            obj = (Object)bdata;
            break;
        case DataBuffer.TYPE_USHORT:
            short[] sdata;
            if (obj == null)
                sdata = new short[1];
            else
                sdata = (short[])obj;
            sdata[0] = (short)data.getElem(y * scanlineStride + x);
            obj = (Object)sdata;
            break;
        case DataBuffer.TYPE_INT:
            int[] idata;
            if (obj == null)
                idata = new int[1];
            else
                idata = (int[])obj;
            idata[0] = data.getElem(y * scanlineStride + x);
            obj = (Object)idata;
            break;
        }
        return obj;
}

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() 
{
        return 1;
}

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) 
{
        int offset = y * scanlineStride + x;
        return offset;
}

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) 
{
        if ((x <  0) || (y <  0) || (x  >= width) || (y  >= height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int pixels[];
        if (iArray == null) {
            pixels = new int [numBands];
        } else {
            pixels = iArray;
        }
        int value = data.getElem(y * scanlineStride + x);
        for (int i=0; i< numBands; i++) {
            pixels[i] = (value & bitMasks[i])  > > > bitOffsets[i];
        }
        return pixels;
}

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) 
{
        if ((x <  0) || (y <  0) || (x + w  > width) || (y + h  > height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int pixels[];
        if (iArray != null) {
           pixels = iArray;
        } else {
           pixels = new int [w*h*numBands];
        }
        int lineOffset = y*scanlineStride + x;
        int dstOffset = 0;
        for (int i = 0; i <  h; i++) {
           for (int j = 0; j <  w; j++) {
              int value = data.getElem(lineOffset+j);
              for (int k=0; k <  numBands; k++) {
                  pixels[dstOffset++] =
                     ((value & bitMasks[k])  > > > bitOffsets[k]);
              }
           }
           lineOffset += scanlineStride;
        }
        return pixels;
}

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) 
{
        // Bounds check for 'b' will be performed automatically
        if ((x <  0) || (y <  0) || (x  >= width) || (y  >= height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int sample = data.getElem(y * scanlineStride + x);
        return ((sample & bitMasks[b])  > > > bitOffsets[b]);
}

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() 
{
        int mask;
        int sampleSize[] = new int [numBands];
        for (int i=0; i< numBands; i++) {
            sampleSize[i] = 0;
            mask = bitMasks[i]  > > > bitOffsets[i];
            while ((mask & 1) != 0) {
                sampleSize[i] ++;
                mask = mask  > > > 1;
            }
        }
        return sampleSize;
}

Returns the number of bits per sample for all bands.

 public int getSampleSize(int band) 
{
        int sampleSize = 0;
        int mask = bitMasks[band]  > > > bitOffsets[band];
        while ((mask & 1) != 0) {
            sampleSize ++;
            mask = mask  > > > 1;
        }
        return sampleSize;
}

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) 
{
        // Bounds check for 'b' will be performed automatically
        if ((x <  0) || (y <  0) || (x + w  > width) || (y + h  > height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int samples[];
        if (iArray != null) {
           samples = iArray;
        } else {
           samples = new int [w*h];
        }
        int lineOffset = y*scanlineStride + x;
        int dstOffset = 0;
        for (int i = 0; i <  h; i++) {
           for (int j = 0; j <  w; j++) {
              int value = data.getElem(lineOffset+j);
              samples[dstOffset++] =
                 ((value & bitMasks[b])  > > > bitOffsets[b]);
           }
           lineOffset += scanlineStride;
        }
        return samples;
}

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() 
{
      return scanlineStride;
}

Returns the scanline stride of this SinglePixelPackedSampleModel.

 public int hashCode() 
{
        int hash = 0;
        hash = width;
        hash < < = 8;
        hash ^= height;
        hash < < = 8;
        hash ^= numBands;
        hash < < = 8;
        hash ^= dataType;
        hash < < = 8;
        for (int i = 0; i <  bitMasks.length; i++) {
            hash ^= bitMasks[i];
            hash < < = 8;
        }
        for (int i = 0; i <  bitOffsets.length; i++) {
            hash ^= bitOffsets[i];
            hash < < = 8;
        }
        for (int i = 0; i <  bitSizes.length; i++) {
            hash ^= bitSizes[i];
            hash < < = 8;
        }
        hash ^= maxBitSize;
        hash < < = 8;
        hash ^= scanlineStride;
        return hash;
}

 public  void setDataElements(int x,
    int y,
    Object obj,
    DataBuffer data) 
{
        if ((x <  0) || (y <  0) || (x  >= width) || (y  >= height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int type = getTransferType();
        switch(type) {
        case DataBuffer.TYPE_BYTE:
            byte[] barray = (byte[])obj;
            data.setElem(y*scanlineStride+x, ((int)barray[0])&0xff);
            break;
        case DataBuffer.TYPE_USHORT:
            short[] sarray = (short[])obj;
            data.setElem(y*scanlineStride+x, ((int)sarray[0])&0xffff);
            break;
        case DataBuffer.TYPE_INT:
            int[] iarray = (int[])obj;
            data.setElem(y*scanlineStride+x, iarray[0]);
            break;
        }
}

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) 
{
        if ((x <  0) || (y <  0) || (x  >= width) || (y  >= height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int lineOffset = y * scanlineStride + x;
        int value = data.getElem(lineOffset);
        for (int i=0; i <  numBands; i++) {
            value &= ~bitMasks[i];
            value |= ((iArray[i] < <  bitOffsets[i]) & bitMasks[i]);
        }
        data.setElem(lineOffset, value);
}

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) 
{
        if ((x <  0) || (y <  0) || (x + w  > width) || (y + h  > height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int lineOffset = y*scanlineStride + x;
        int srcOffset = 0;
        for (int i = 0; i <  h; i++) {
           for (int j = 0; j <  w; j++) {
               int value = data.getElem(lineOffset+j);
               for (int k=0; k <  numBands; k++) {
                   value &= ~bitMasks[k];
                   int srcValue = iArray[srcOffset++];
                   value |= ((srcValue < <  bitOffsets[k])
                             & bitMasks[k]);
               }
               data.setElem(lineOffset+j, value);
           }
           lineOffset += scanlineStride;
        }
}

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) 
{
        // Bounds check for 'b' will be performed automatically
        if ((x <  0) || (y <  0) || (x  >= width) || (y  >= height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int value = data.getElem(y*scanlineStride + x);
        value &= ~bitMasks[b];
        value |= (s < <  bitOffsets[b]) & bitMasks[b];
        data.setElem(y*scanlineStride + x,value);
}

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) 
{
        // Bounds check for 'b' will be performed automatically
        if ((x <  0) || (y <  0) || (x + w  > width) || (y + h  > height)) {
            throw new ArrayIndexOutOfBoundsException
                ("Coordinate out of bounds!");
        }
        int lineOffset = y*scanlineStride + x;
        int srcOffset = 0;
        for (int i = 0; i <  h; i++) {
           for (int j = 0; j <  w; j++) {
              int value = data.getElem(lineOffset+j);
              value &= ~bitMasks[b];
              int sample = iArray[srcOffset++];
              value |= ((int)sample < <  bitOffsets[b]) & bitMasks[b];
              data.setElem(lineOffset+j,value);
           }
           lineOffset += scanlineStride;
        }
}

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.