public class SinglePixelPackedSampleModel extends SampleModel
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];
 dataType, height, numBands, width| Constructor and Description | 
|---|
| SinglePixelPackedSampleModel(int dataType,
                            int w,
                            int h,
                            int[] bitMasks)Constructs a SinglePixelPackedSampleModel with bitMasks.length bands. | 
| SinglePixelPackedSampleModel(int dataType,
                            int w,
                            int h,
                            int scanlineStride,
                            int[] bitMasks)Constructs a SinglePixelPackedSampleModel with bitMasks.length bands
 and a scanline stride equal to scanlineStride data array elements. | 
| Modifier and Type | Method and Description | 
|---|---|
| SampleModel | createCompatibleSampleModel(int w,
                           int h)Creates a new SinglePixelPackedSampleModel with the specified
 width and height. | 
| DataBuffer | createDataBuffer()Creates a DataBuffer that corresponds to this
 SinglePixelPackedSampleModel. | 
| SampleModel | createSubsetSampleModel(int[] bands)This creates a new SinglePixelPackedSampleModel with a subset of the
 bands of this SinglePixelPackedSampleModel. | 
| boolean | equals(Object o)Indicates whether some other object is "equal to" this one. | 
| int[] | getBitMasks()Returns the bit masks for all bands. | 
| int[] | getBitOffsets()Returns the bit offsets into the data array element representing
  a pixel for all bands. | 
| Object | getDataElements(int x,
               int y,
               Object obj,
               DataBuffer data)Returns data for a single pixel in a primitive array of type
 TransferType. | 
| int | getNumDataElements()Returns the number of data elements needed to transfer one pixel
 via the getDataElements and setDataElements methods. | 
| int | getOffset(int x,
         int y)Returns the offset (in data array elements) of pixel (x,y). | 
| int[] | getPixel(int x,
        int y,
        int[] iArray,
        DataBuffer data)Returns all samples in 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 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). | 
| 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. | 
| int[] | getSampleSize()Returns the number of bits per sample for all bands. | 
| int | getSampleSize(int band)Returns the number of bits per sample for the specified band. | 
| int | getScanlineStride()Returns the scanline stride of this SinglePixelPackedSampleModel. | 
| 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,
         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 array element. | 
getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSampleDouble, getSampleFloat, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSample, setSample, setSamples, setSamplespublic SinglePixelPackedSampleModel(int dataType,
                                    int w,
                                    int h,
                                    int[] bitMasks)
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.IllegalArgumentException - if dataType is not
         either DataBuffer.TYPE_BYTE,
         DataBuffer.TYPE_USHORT, or
         DataBuffer.TYPE_INTpublic SinglePixelPackedSampleModel(int dataType,
                                    int w,
                                    int h,
                                    int scanlineStride,
                                    int[] bitMasks)
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.IllegalArgumentException - if w or
         h is not greater than 0IllegalArgumentException - if any mask in
         bitMask is not contiguousIllegalArgumentException - if dataType is not
         either DataBuffer.TYPE_BYTE,
         DataBuffer.TYPE_USHORT, or
         DataBuffer.TYPE_INTpublic int getNumDataElements()
getNumDataElements in class SampleModelSampleModel.getDataElements(int, int, Object, DataBuffer), 
SampleModel.getDataElements(int, int, int, int, Object, DataBuffer), 
SampleModel.setDataElements(int, int, Object, DataBuffer), 
SampleModel.setDataElements(int, int, int, int, Object, DataBuffer), 
SampleModel.getTransferType()public SampleModel createCompatibleSampleModel(int w, int h)
createCompatibleSampleModel in class SampleModelw - the width of the resulting SampleModelh - the height of the resulting SampleModelSinglePixelPackedSampleModel with the
         specified width and height.IllegalArgumentException - if w or
         h is not greater than 0public DataBuffer createDataBuffer()
createDataBuffer in class SampleModelDataBuffer corresponding to this
         SampleModel.public int[] getSampleSize()
getSampleSize in class SampleModelpublic int getSampleSize(int band)
getSampleSize in class SampleModelband - the specified bandpublic int getOffset(int x,
                     int y)
x,y
  can be retrieved from a DataBuffer data with a
  SinglePixelPackedSampleModel sppsm as:
 
        data.getElem(sppsm.getOffset(x, y));
 x - the X coordinate of the specified pixely - the Y coordinate of the specified pixelpublic int[] getBitOffsets()
public int[] getBitMasks()
public int getScanlineStride()
SinglePixelPackedSampleModel.public SampleModel createSubsetSampleModel(int[] bands)
createSubsetSampleModel in class SampleModelbands - the subset of bands of this SampleModelSampleModel with a subset of bands of this
         SampleModel.RasterFormatException - if the length of the bands argument is
                                  greater than the number of bands in
                                  the sample model.public Object getDataElements(int x, int y, Object obj, DataBuffer data)
 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.
getDataElements in class SampleModelx - The X coordinate of the pixel location.y - The Y coordinate of the pixel location.obj - If non-null, a primitive array in which to return
                  the pixel data.data - The DataBuffer containing the image data.setDataElements(int, int, Object, DataBuffer)public int[] getPixel(int x,
                      int y,
                      int[] iArray,
                      DataBuffer data)
getPixel in class SampleModelx - The X coordinate of the pixel location.y - The Y coordinate of the pixel location.iArray - If non-null, returns the samples in this arraydata - The DataBuffer containing the image data.setPixel(int, int, int[], DataBuffer)public int[] getPixels(int x,
                       int y,
                       int w,
                       int h,
                       int[] iArray,
                       DataBuffer data)
getPixels in class SampleModelx - The X coordinate of the upper left pixel location.y - The Y coordinate of the upper left pixel location.w - The width of the pixel rectangle.h - The height of the pixel rectangle.iArray - If non-null, returns the samples in this array.data - The DataBuffer containing the image data.setPixels(int, int, int, int, int[], DataBuffer)public int getSample(int x,
                     int y,
                     int b,
                     DataBuffer data)
getSample in class SampleModelx - The X coordinate of the pixel location.y - The Y coordinate of the pixel location.b - The band to return.data - The DataBuffer containing the image data.setSample(int, int, int, int, DataBuffer)public int[] getSamples(int x,
                        int y,
                        int w,
                        int h,
                        int b,
                        int[] iArray,
                        DataBuffer data)
getSamples in class SampleModelx - The X coordinate of the upper left pixel location.y - The Y coordinate of the upper left pixel location.w - The width of the pixel rectangle.h - The height of the pixel rectangle.b - The band to return.iArray - If non-null, returns the samples in this array.data - The DataBuffer containing the image data.setSamples(int, int, int, int, int, int[], DataBuffer)public void setDataElements(int x,
                            int y,
                            Object obj,
                            DataBuffer data)
 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.
setDataElements in class SampleModelx - The X coordinate of the pixel location.y - The Y coordinate of the pixel location.obj - A primitive array containing pixel data.data - The DataBuffer containing the image data.getDataElements(int, int, Object, DataBuffer)public void setPixel(int x,
                     int y,
                     int[] iArray,
                     DataBuffer data)
setPixel in class SampleModelx - The X coordinate of the pixel location.y - The Y coordinate of the pixel location.iArray - The input samples in an int array.data - The DataBuffer containing the image data.getPixel(int, int, int[], DataBuffer)public void setPixels(int x,
                      int y,
                      int w,
                      int h,
                      int[] iArray,
                      DataBuffer data)
setPixels in class SampleModelx - The X coordinate of the upper left pixel location.y - The Y coordinate of the upper left pixel location.w - The width of the pixel rectangle.h - The height of the pixel rectangle.iArray - The input samples in an int array.data - The DataBuffer containing the image data.getPixels(int, int, int, int, int[], DataBuffer)public void setSample(int x,
                      int y,
                      int b,
                      int s,
                      DataBuffer data)
setSample in class SampleModelx - The X coordinate of the pixel location.y - The Y coordinate of the pixel location.b - The band to set.s - The input sample as an int.data - The DataBuffer containing the image data.getSample(int, int, int, DataBuffer)public void setSamples(int x,
                       int y,
                       int w,
                       int h,
                       int b,
                       int[] iArray,
                       DataBuffer data)
setSamples in class SampleModelx - The X coordinate of the upper left pixel location.y - The Y coordinate of the upper left pixel location.w - The width of the pixel rectangle.h - The height of the pixel rectangle.b - The band to set.iArray - The input samples in an int array.data - The DataBuffer containing the image data.getSamples(int, int, int, int, int, int[], DataBuffer)public boolean equals(Object o)
Object
 The equals method implements an equivalence relation
 on non-null object references:
 
x, x.equals(x) should return
     true.
 x and y, x.equals(y)
     should return true if and only if
     y.equals(x) returns true.
 x, y, and z, if
     x.equals(y) returns true and
     y.equals(z) returns true, then
     x.equals(z) should return true.
 x and y, multiple invocations of
     x.equals(y) consistently return true
     or consistently return false, provided no
     information used in equals comparisons on the
     objects is modified.
 x,
     x.equals(null) should return false.
 
 The equals method for class Object implements
 the most discriminating possible equivalence relation on objects;
 that is, for any non-null reference values x and
 y, this method returns true if and only
 if x and y refer to the same object
 (x == y has the value true).
 
 Note that it is generally necessary to override the hashCode
 method whenever this method is overridden, so as to maintain the
 general contract for the hashCode method, which states
 that equal objects must have equal hash codes.
equals in class Objecto - the reference object with which to compare.true if this object is the same as the obj
          argument; false otherwise.Object.hashCode(), 
HashMappublic int hashCode()
ObjectHashMap.
 
 The general contract of hashCode is:
 
hashCode method
     must consistently return the same integer, provided no information
     used in equals comparisons on the object is modified.
     This integer need not remain consistent from one execution of an
     application to another execution of the same application.
 equals(Object)
     method, then calling the hashCode method on each of
     the two objects must produce the same integer result.
 Object.equals(java.lang.Object)
     method, then calling the hashCode method on each of the
     two objects must produce distinct integer results.  However, the
     programmer should be aware that producing distinct integer results
     for unequal objects may improve the performance of hash tables.
 
 As much as is reasonably practical, the hashCode method defined by
 class Object does return distinct integers for distinct
 objects. (This is typically implemented by converting the internal
 address of the object into an integer, but this implementation
 technique is not required by the
 Java™ programming language.)
hashCode in class ObjectObject.equals(java.lang.Object), 
System.identityHashCode(java.lang.Object) Submit a bug or feature 
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
 Copyright © 1993, 2025, Oracle and/or its affiliates.  All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.