public final class BandedSampleModel extends ComponentSampleModel
TYPE_BYTE
,
TYPE_USHORT
,
TYPE_SHORT
,
TYPE_INT
,
TYPE_FLOAT
, and
TYPE_DOUBLE
datatypesbandOffsets, bankIndices, numBands, numBanks, pixelStride, scanlineStride
dataType, height, width
Constructor and Description |
---|
BandedSampleModel(int dataType,
int w,
int h,
int numBands)
Constructs a BandedSampleModel with the specified parameters.
|
BandedSampleModel(int dataType,
int w,
int h,
int scanlineStride,
int[] bankIndices,
int[] bandOffsets)
Constructs a BandedSampleModel with the specified parameters.
|
Modifier and Type | Method and Description |
---|---|
SampleModel |
createCompatibleSampleModel(int w,
int h)
Creates a new BandedSampleModel with the specified
width and height.
|
DataBuffer |
createDataBuffer()
Creates a DataBuffer that corresponds to this BandedSampleModel,
The DataBuffer's data type, number of banks, and size
will be consistent with this BandedSampleModel.
|
SampleModel |
createSubsetSampleModel(int[] bands)
Creates a new BandedSampleModel with a subset of the bands of this
BandedSampleModel.
|
Object |
getDataElements(int x,
int y,
Object obj,
DataBuffer data)
Returns data for a single pixel in a primitive array of type
TransferType.
|
int[] |
getPixel(int x,
int y,
int[] iArray,
DataBuffer data)
Returns all samples 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 data 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).
|
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.
|
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.
|
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,
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.
|
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 data array element.
|
equals, getBandOffsets, getBankIndices, getNumDataElements, getOffset, getOffset, getPixelStride, getSampleSize, getSampleSize, getScanlineStride
getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSamples, setSamples
public BandedSampleModel(int dataType, int w, int h, int numBands)
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.numBands
- The number of bands for the image data.IllegalArgumentException
- if dataType
is not
one of the supported data typespublic BandedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets)
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 of the image data.bankIndices
- The bank index for each band.bandOffsets
- The band offset for each band.IllegalArgumentException
- if dataType
is not
one of the supported data typespublic SampleModel createCompatibleSampleModel(int w, int h)
createCompatibleSampleModel
in class ComponentSampleModel
w
- the width of the resulting BandedSampleModel
h
- the height of the resulting BandedSampleModel
BandedSampleModel
with the specified
width and height.IllegalArgumentException
- if w
or
h
equals either
Integer.MAX_VALUE
or
Integer.MIN_VALUE
IllegalArgumentException
- if dataType
is not
one of the supported data typespublic SampleModel createSubsetSampleModel(int[] bands)
createSubsetSampleModel
in class ComponentSampleModel
bands
- a subset of bands from this
ComponentSampleModel
ComponentSampleModel
created with a subset
of bands from this ComponentSampleModel
.RasterFormatException
- if the number of bands is greater than
the number of banks in this sample model.IllegalArgumentException
- if dataType
is not
one of the supported data typespublic DataBuffer createDataBuffer()
createDataBuffer
in class ComponentSampleModel
DataBuffer
whose data type, number of banks
and size are consistent with this
ComponentSampleModel
.IllegalArgumentException
- if dataType
is not
one of the supported types.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
BandedSampleModel bsm1
, to DataBuffer db2
,
whose storage layout is described by
BandedSampleModel bsm2
.
The transfer will generally be more efficient than using
getPixel/setPixel.
BandedSampleModel bsm1, bsm2; DataBufferInt db1, db2; bsm2.setDataElements(x, y, bsm1.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 ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationobj
- 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 ComponentSampleModel
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 datasetPixel(int, int, int[], DataBuffer)
public int[] getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
getPixels
in class ComponentSampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- The width of the pixel rectangleh
- The height of the pixel rectangleiArray
- If non-null, returns the samples in this arraydata
- The DataBuffer containing the image datasetPixels(int, int, int, int, int[], DataBuffer)
public int getSample(int x, int y, int b, DataBuffer data)
getSample
in class ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to returndata
- The DataBuffer containing the image datasetSample(int, int, int, int, DataBuffer)
public float getSampleFloat(int x, int y, int b, DataBuffer data)
getSampleFloat
in class ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to returndata
- The DataBuffer containing the image datapublic double getSampleDouble(int x, int y, int b, DataBuffer data)
getSampleDouble
in class ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to returndata
- The DataBuffer containing the image datapublic int[] getSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)
getSamples
in class ComponentSampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- The width of the pixel rectangleh
- The height of the pixel rectangleb
- The band to returniArray
- If non-null, returns the samples in this arraydata
- The DataBuffer containing the image datasetSamples(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
BandedSampleModel bsm1
, to DataBuffer db2
,
whose storage layout is described by
BandedSampleModel bsm2
.
The transfer will generally be more efficient than using
getPixel/setPixel.
BandedSampleModel bsm1, bsm2; DataBufferInt db1, db2; bsm2.setDataElements(x, y, bsm1.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 ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationobj
- If non-null, returns the primitive array in this
objectdata
- The DataBuffer containing the image datagetDataElements(int, int, Object, DataBuffer)
public void setPixel(int x, int y, int[] iArray, DataBuffer data)
setPixel
in class ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationiArray
- The input samples in an int arraydata
- The DataBuffer containing the image datagetPixel(int, int, int[], DataBuffer)
public void setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)
setPixels
in class ComponentSampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- The width of the pixel rectangleh
- The height of the pixel rectangleiArray
- The input samples in an int arraydata
- The DataBuffer containing the image datagetPixels(int, int, int, int, int[], DataBuffer)
public void setSample(int x, int y, int b, int s, DataBuffer data)
setSample
in class ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to sets
- The input sample as an intdata
- The DataBuffer containing the image datagetSample(int, int, int, DataBuffer)
public void setSample(int x, int y, int b, float s, DataBuffer data)
setSample
in class ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to sets
- The input sample as a floatdata
- The DataBuffer containing the image datagetSample(int, int, int, DataBuffer)
public void setSample(int x, int y, int b, double s, DataBuffer data)
setSample
in class ComponentSampleModel
x
- The X coordinate of the pixel locationy
- The Y coordinate of the pixel locationb
- The band to sets
- The input sample as a doubledata
- The DataBuffer containing the image datagetSample(int, int, int, DataBuffer)
public void setSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)
setSamples
in class ComponentSampleModel
x
- The X coordinate of the upper left pixel locationy
- The Y coordinate of the upper left pixel locationw
- The width of the pixel rectangleh
- The height of the pixel rectangleb
- The band to setiArray
- The input sample arraydata
- The DataBuffer containing the image datagetSamples(int, int, int, int, int, int[], DataBuffer)
public int hashCode()
Object
HashMap
.
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
JavaTM programming language.)
hashCode
in class ComponentSampleModel
Object.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, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.