Class SampleModel
- Direct Known Subclasses:
ComponentSampleModel
,MultiPixelPackedSampleModel
,SinglePixelPackedSampleModel
Subclasses of SampleModel specify the types of samples they can represent (e.g. unsigned 8-bit byte, signed 16-bit short, etc.) and may specify how the samples are organized in memory. In the Java 2D(tm) API, built-in image processing operators may not operate on all possible sample types, but generally will work for unsigned integral samples of 16 bits or less. Some operators support a wider variety of sample types.
A collection of pixels is represented as a Raster, which consists of a DataBuffer and a SampleModel. The SampleModel allows access to samples in the DataBuffer and may provide low-level information that a programmer can use to directly manipulate samples and pixels in the DataBuffer.
This class is generally a fall back method for dealing with images. More efficient code will cast the SampleModel to the appropriate subclass and extract the information needed to directly manipulate pixels in the DataBuffer.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected int
Data type of the DataBuffer storing the pixel data.protected int
Height in pixels of the region of image data that this SampleModel describes.protected int
Number of bands of the image data that this SampleModel describes.protected int
Width in pixels of the region of image data that this SampleModel describes. -
Constructor Summary
ConstructorDescriptionSampleModel
(int dataType, int w, int h, int numBands) Constructs a SampleModel with the specified parameters. -
Method Summary
Modifier and TypeMethodDescriptionabstract SampleModel
createCompatibleSampleModel
(int w, int h) Creates a SampleModel which describes data in this SampleModel's format, but with a different width and height.abstract DataBuffer
Creates a DataBuffer that corresponds to this SampleModel.abstract SampleModel
createSubsetSampleModel
(int[] bands) Creates a new SampleModel with a subset of the bands of this SampleModel.getDataElements
(int x, int y, int w, int h, Object obj, DataBuffer data) Returns the pixel data for the specified rectangle of pixels in a primitive array of type TransferType.abstract Object
getDataElements
(int x, int y, Object obj, DataBuffer data) Returns data for a single pixel in a primitive array of type TransferType.final int
Returns the data type of the DataBuffer storing the pixel data.final int
Returns the height in pixels.final int
Returns the total number of bands of image data.abstract int
Returns the number of data elements needed to transfer a pixel via the getDataElements and setDataElements methods.double[]
getPixel
(int x, int y, double[] dArray, DataBuffer data) Returns the samples for the specified pixel in an array of double.float[]
getPixel
(int x, int y, float[] fArray, DataBuffer data) Returns the samples for the specified pixel in an array of float.int[]
getPixel
(int x, int y, int[] iArray, DataBuffer data) Returns the samples for a specified pixel in an int array, one sample per array element.double[]
getPixels
(int x, int y, int w, int h, double[] dArray, DataBuffer data) Returns all samples for a rectangle of pixels in a double array, one sample per array element.float[]
getPixels
(int x, int y, int w, int h, float[] fArray, DataBuffer data) Returns all samples for a rectangle of pixels in a float array, one sample per array element.int[]
getPixels
(int x, int y, int w, int h, int[] iArray, DataBuffer data) Returns all samples for a rectangle of pixels in an int array, one sample per array element.abstract int
getSample
(int x, int y, int b, DataBuffer data) Returns the sample in a specified band for the pixel located at (x,y) as an int.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.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.double[]
getSamples
(int x, int y, int w, int h, int b, double[] dArray, DataBuffer data) Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element.float[]
getSamples
(int x, int y, int w, int h, int b, float[] fArray, DataBuffer data) Returns the samples for a specified band for the specified rectangle of pixels in a float array, one sample per array element.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.abstract int[]
Returns the size in bits of samples for all bands.abstract int
getSampleSize
(int band) Returns the size in bits of samples for the specified band.int
Returns the TransferType used to transfer pixels via the getDataElements and setDataElements methods.final int
getWidth()
Returns the width in pixels.void
setDataElements
(int x, int y, int w, int h, Object obj, DataBuffer data) Sets the data for a rectangle of pixels in the specified DataBuffer from a primitive array of type TransferType.abstract 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, double[] dArray, DataBuffer data) Sets a pixel in the DataBuffer using a double array of samples for input.void
setPixel
(int x, int y, float[] fArray, DataBuffer data) Sets a pixel in the DataBuffer using a float array of samples for input.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, double[] dArray, DataBuffer data) Sets all samples for a rectangle of pixels from a double array containing one sample per array element.void
setPixels
(int x, int y, int w, int h, float[] fArray, DataBuffer data) Sets all samples for a rectangle of pixels from a float array containing one sample per array element.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, 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.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.abstract 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, double[] dArray, DataBuffer data) Sets the samples in the specified band for the specified rectangle of pixels from a double array containing one sample per array element.void
setSamples
(int x, int y, int w, int h, int b, float[] fArray, DataBuffer data) Sets the samples in the specified band for the specified rectangle of pixels from a float array containing one sample per array element.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.
-
Field Details
-
width
protected int widthWidth in pixels of the region of image data that this SampleModel describes. -
height
protected int heightHeight in pixels of the region of image data that this SampleModel describes. -
numBands
protected int numBandsNumber of bands of the image data that this SampleModel describes. -
dataType
protected int dataTypeData type of the DataBuffer storing the pixel data.- See Also:
-
-
Constructor Details
-
SampleModel
public SampleModel(int dataType, int w, int h, int numBands) Constructs a SampleModel with the specified parameters.- Parameters:
dataType
- The data type of the DataBuffer storing the pixel data.w
- The width (in pixels) of the region of image data.h
- The height (in pixels) of the region of image data.numBands
- The number of bands of the image data.- Throws:
IllegalArgumentException
- ifw
orh
is not greater than 0IllegalArgumentException
- if the product ofw
andh
is greater thanInteger.MAX_VALUE
IllegalArgumentException
- ifdataType
is not one of the pre-defined data type tags in theDataBuffer
classIllegalArgumentException
- ifnumBands
is less than 1
-
-
Method Details
-
getWidth
public final int getWidth()Returns the width in pixels.- Returns:
- the width in pixels of the region of image data
that this
SampleModel
describes.
-
getHeight
public final int getHeight()Returns the height in pixels.- Returns:
- the height in pixels of the region of image data
that this
SampleModel
describes.
-
getNumBands
public final int getNumBands()Returns the total number of bands of image data.- Returns:
- the number of bands of image data that this
SampleModel
describes.
-
getNumDataElements
public abstract int getNumDataElements()Returns the number of data elements needed to transfer a pixel via the getDataElements and setDataElements methods. When pixels are transferred via these methods, they may be transferred in a packed or unpacked format, depending on the implementation of the SampleModel. Using these methods, pixels are transferred as an array of getNumDataElements() elements of a primitive type given by getTransferType(). The TransferType may or may not be the same as the storage DataType.- Returns:
- the number of data elements.
- See Also:
-
getDataType
public final int getDataType()Returns the data type of the DataBuffer storing the pixel data.- Returns:
- the data type.
-
getTransferType
public int getTransferType()Returns the TransferType used to transfer pixels via the getDataElements and setDataElements methods. When pixels are transferred via these methods, they may be transferred in a packed or unpacked format, depending on the implementation of the SampleModel. Using these methods, pixels are transferred as an array of getNumDataElements() elements of a primitive type given by getTransferType(). The TransferType may or may not be the same as the storage DataType. The TransferType will be one of the types defined in DataBuffer.- Returns:
- the transfer type.
- See Also:
-
getPixel
Returns the samples for a specified pixel in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationiArray
- If non-null, returns the samples in this arraydata
- The DataBuffer containing the image data- Returns:
- the samples for the specified pixel.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if iArray is too small to hold the output.- See Also:
-
getDataElements
Returns data for a single pixel in a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data may be returned in a packed format, thus increasing efficiency for data transfers. 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 SampleModelsm1
, to DataBufferdb2
, whose storage layout is described by SampleModelsm2
. The transfer will generally be more efficient than using getPixel/setPixel.SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, sm1.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.
- Parameters:
x
- 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.- Returns:
- the data elements for the specified pixel.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if obj is too small to hold the output.- See Also:
-
getDataElements
Returns the pixel data for the specified rectangle of pixels in a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data may be returned in a packed format, thus increasing efficiency for data transfers. 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 a rectangular region of pixels from DataBuffer
db1
, whose storage layout is described by SampleModelsm1
, to DataBufferdb2
, whose storage layout is described by SampleModelsm2
. The transfer will generally be more efficient than using getPixels/setPixels.SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w, h, 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.
- Parameters:
x
- The minimum X coordinate of the pixel rectangle.y
- The minimum Y coordinate of the pixel rectangle.w
- The width of the pixel rectangle.h
- The height of the pixel rectangle.obj
- If non-null, a primitive array in which to return the pixel data.data
- The DataBuffer containing the image data.- Returns:
- the data elements for the specified region of pixels.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if obj is too small to hold the output.- See Also:
-
setDataElements
Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data in the array may be in a packed format, thus increasing efficiency for data transfers.The following code illustrates transferring data for one pixel from DataBuffer
db1
, whose storage layout is described by SampleModelsm1
, to DataBufferdb2
, whose storage layout is described by SampleModelsm2
. The transfer will generally be more efficient than using getPixel/setPixel.SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, sm1.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.
- Parameters:
x
- 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.- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if obj is too small to hold the input.- See Also:
-
setDataElements
Sets the data for a rectangle of pixels in the specified DataBuffer from a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data in the array may be in a packed format, thus increasing efficiency for data transfers.The following code illustrates transferring data for a rectangular region of pixels from DataBuffer
db1
, whose storage layout is described by SampleModelsm1
, to DataBufferdb2
, whose storage layout is described by SampleModelsm2
. The transfer will generally be more efficient than using getPixels/setPixels.SampleModel sm1, sm2; DataBuffer db1, db2; sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w, h, 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.
- Parameters:
x
- The minimum X coordinate of the pixel rectangle.y
- The minimum Y coordinate of the pixel rectangle.w
- The width of the pixel rectangle.h
- The height of the pixel rectangle.obj
- A primitive array containing pixel data.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if obj is too small to hold the input.- See Also:
-
getPixel
Returns the samples for the specified pixel in an array of float. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- The X coordinate of the pixel location.y
- The Y coordinate of the pixel location.fArray
- If non-null, returns the samples in this array.data
- The DataBuffer containing the image data.- Returns:
- the samples for the specified pixel.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if fArray is too small to hold the output.- See Also:
-
getPixel
Returns the samples for the specified pixel in an array of double. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- The X coordinate of the pixel location.y
- The Y coordinate of the pixel location.dArray
- If non-null, returns the samples in this array.data
- The DataBuffer containing the image data.- Returns:
- the samples for the specified pixel.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if dArray is too small to hold the output.- See Also:
-
getPixels
Returns all samples for a rectangle of pixels in an int array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.- Returns:
- the samples for the specified region of pixels.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if iArray is too small to hold the output.- See Also:
-
getPixels
Returns all samples for a rectangle of pixels in a float array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.fArray
- If non-null, returns the samples in this array.data
- The DataBuffer containing the image data.- Returns:
- the samples for the specified region of pixels.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if fArray is too small to hold the output.- See Also:
-
getPixels
Returns all samples for a rectangle of pixels in a double array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.dArray
- If non-null, returns the samples in this array.data
- The DataBuffer containing the image data.- Returns:
- the samples for the specified region of pixels.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if dArray is too small to hold the output.- See Also:
-
getSample
Returns the sample in a specified band for the pixel located at (x,y) as an int. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.- Returns:
- the sample in a specified band for the specified pixel.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds.- See Also:
-
getSampleFloat
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.- Parameters:
x
- 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.- Returns:
- the sample in a specified band for the specified pixel.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds.
-
getSampleDouble
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.- Parameters:
x
- 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.- Returns:
- the sample in a specified band for the specified pixel.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds.
-
getSamples
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.- Parameters:
x
- 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.- Returns:
- the samples for the specified band for the specified region of pixels.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds, or if iArray is too small to hold the output.- See Also:
-
getSamples
Returns the samples for a specified band for the specified rectangle of pixels in a float array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.fArray
- If non-null, returns the samples in this array.data
- The DataBuffer containing the image data.- Returns:
- the samples for the specified band for the specified region of pixels.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds, or if fArray is too small to hold the output.- See Also:
-
getSamples
Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.dArray
- If non-null, returns the samples in this array.data
- The DataBuffer containing the image data.- Returns:
- the samples for the specified band for the specified region of pixels.
- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds, or if dArray is too small to hold the output.- See Also:
-
setPixel
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.- Parameters:
x
- 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.- Throws:
NullPointerException
- if iArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if iArray is too small to hold the input.- See Also:
-
setPixel
Sets a pixel in the DataBuffer using a float array of samples for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- The X coordinate of the pixel location.y
- The Y coordinate of the pixel location.fArray
- The input samples in a float array.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if fArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if fArray is too small to hold the input.- See Also:
-
setPixel
Sets a pixel in the DataBuffer using a double array of samples for input.- Parameters:
x
- The X coordinate of the pixel location.y
- The Y coordinate of the pixel location.dArray
- The input samples in a double array.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if dArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if fArray is too small to hold the input.- See Also:
-
setPixels
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.- Parameters:
x
- 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.- Throws:
NullPointerException
- if iArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if iArray is too small to hold the input.- See Also:
-
setPixels
Sets all samples for a rectangle of pixels from a float array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.fArray
- The input samples in a float array.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if fArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if fArray is too small to hold the input.- See Also:
-
setPixels
Sets all samples for a rectangle of pixels from a double array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.dArray
- The input samples in a double array.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if dArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates are not in bounds, or if dArray is too small to hold the input.- See Also:
-
setSample
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.- Parameters:
x
- 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.- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds.- See Also:
-
setSample
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input. The default implementation of this method casts the input float sample to an int and then calls thesetSample(int, int, int, DataBuffer)
method using that int value. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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 a float.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds.- See Also:
-
setSample
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a double for input. The default implementation of this method casts the input double sample to an int and then calls thesetSample(int, int, int, DataBuffer)
method using that int value. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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 a double.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds.- See Also:
-
setSamples
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.- Parameters:
x
- 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.- Throws:
NullPointerException
- if iArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds, or if iArray is too small to hold the input.- See Also:
-
setSamples
Sets the samples in the specified band for the specified rectangle of pixels from a float array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.fArray
- The input samples in a float array.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if fArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds, or if fArray is too small to hold the input.- See Also:
-
setSamples
Sets the samples in the specified band for the specified rectangle of pixels from a double array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.- Parameters:
x
- 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.dArray
- The input samples in a double array.data
- The DataBuffer containing the image data.- Throws:
NullPointerException
- if dArray or data is null.ArrayIndexOutOfBoundsException
- if the coordinates or the band index are not in bounds, or if dArray is too small to hold the input.- See Also:
-
createCompatibleSampleModel
Creates a SampleModel which describes data in this SampleModel's format, but with a different width and height.- Parameters:
w
- the width of the image datah
- the height of the image data- Returns:
- a
SampleModel
describing the same image data as thisSampleModel
, but with a different size.
-
createSubsetSampleModel
Creates a new SampleModel with a subset of the bands of this SampleModel.- Parameters:
bands
- the subset of bands of thisSampleModel
- Returns:
- a
SampleModel
with a subset of bands of thisSampleModel
.
-
createDataBuffer
Creates a DataBuffer that corresponds to this SampleModel. The DataBuffer's width and height will match this SampleModel's.- Returns:
- a
DataBuffer
corresponding to thisSampleModel
.
-
getSampleSize
public abstract int[] getSampleSize()Returns the size in bits of samples for all bands.- Returns:
- the size of samples for all bands.
-
getSampleSize
public abstract int getSampleSize(int band) Returns the size in bits of samples for the specified band.- Parameters:
band
- the specified band- Returns:
- the size of the samples of the specified band.
-