Interface Tile
- 
 public interface Tile extends Iterable<Tile.Pos> A tile represents a rectangular region of sample data within the scene rectangle of a data product. Tiles are used to enable the sample data transfer from and to the source and target bands of data products used within operator graphs.Target tiles to be computed are passed into an Operator'scomputeTileandcomputeTileStackcomputeTileStack} methods. Source tiles are obtained by using thegetSourceTilemethod.Three ways are provided to access and manipulate the sample data of a target tile: (1) This is the simplest (but also slowest) way to modify sample data of a tile: for (int y = tile.getMinY(); y <= tile.getMaxY(); y++) { for (int x = tile.getMinX(); x <= tile.getMaxX(); x++) { // compute sample value... tile.setSample(x, y, sample); } }which can also be written even simpler using a tile iterator:for (Tile.Pos pos : tile) { // compute sample value... tile.setSample(pos.x, pos.y, sample); }The methods getSampleFloat(int, int)andsetSample(int, int, float)and their derivatives used in option (1) return and expect (geo-)physically scaled sample values.(2) More performance is gained if the sample data buffer is checked out and committed (required after modification only): ProductData samples = tile.getRawSamples(); // check out for (int y = 0; y < tile.getHeight(); y++) { for (int x = 0; x < tile.getWidth(); x++) { // compute sample value... samples.setElemFloatAt(y * getWidth() + x, sample); // ... } } tile.setRawSamples(samples); // commitThe method getRawSamples()used in option (2) returns a writable buffer for the raw, non-calibrated sample values. Use thetoGeoPhysical(float)andtoRaw(float)to convert between physical and raw sample values.(3) The the fastest way to read from or write to sample data is to directly access the sample data via their primitive data buffers: float[] samples = tile.getDataBufferFloat(); float sample; int offset = tile.getScanlineOffset(); for (int y = 0; y < tile.getHeight(); y++) { int index = offset; for (int x = 0; x < tile.getWidth(); x++) { // compute sample value... samples[index] = sample; index++; } offset += tile.getScanlineStride(); }Note that option (3) can only be used if the exact sample data type is known or has been identified in a former step. The code snippet above implies that the underlying data type is float(becausegetRasterDataNode().getDataType()returnsProductData.TYPE_FLOAT32). ThegetDataBufferFloat()and its derivatives all return arrays of raw, non-calibrated sample values. Use thetoGeoPhysical(float)andtoRaw(float)to convert between physical and raw sample values.- Since:
- 4.1
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static classTile.PosA pixel position within the tile's raster.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description ProductDatagetDataBuffer()Obtains access to the underlying raw sample buffer.byte[]getDataBufferByte()Gets the underlying raw sample array of typebyte(signed or unsigned).double[]getDataBufferDouble()Gets the underlying raw sample array of typedouble.float[]getDataBufferFloat()Gets the underlying raw sample array of typefloat.intgetDataBufferIndex(int x, int y)Gets the index into the underlying raw sample buffer for the given pixel coordinates.int[]getDataBufferInt()Gets the underlying raw sample array of typeint.short[]getDataBufferShort()Gets the underlying raw sample array of typeshort(signed or unsigned).intgetHeight()Gets the height in pixels within the scene covered by the tile'sRasterDataNode.intgetMaxX()Gets the maximum pixel x-coordinate within the scene covered by the tile'sRasterDataNode.intgetMaxY()Gets the maximum pixel y-coordinate within the scene covered by the tile'sRasterDataNode.intgetMinX()Gets the minimum pixel x-coordinate within the scene covered by the tile'sRasterDataNode.intgetMinY()Gets the minimum pixel y-coordinate within the scene covered by the tile'sRasterDataNode.RasterDataNodegetRasterDataNode()Gets theRasterDataNodeassociated with this tile, e.g.ProductDatagetRawSamples()Gets the raw (unscaled, uncalibrated) samples, e.g.RectanglegetRectangle()Gets the tile rectangle in pixel coordinates within the scene covered by the tile'sRasterDataNode.booleangetSampleBit(int x, int y, int bitIndex)Gets the bit-coded sample value for the given pixel coordinate and the specified bit index as aboolean.booleangetSampleBoolean(int x, int y)Gets the (geo-)physically scaled sample at the given pixel coordinate asbooleanvalue.doublegetSampleDouble(int x, int y)Gets the (geo-)physically scaled sample value for the given pixel coordinate asdouble.floatgetSampleFloat(int x, int y)Gets the (geo-)physically scaled sample at the given pixel coordinate asfloatvalue.intgetSampleInt(int x, int y)Gets the (geo-)physically scaled sample at the given pixel coordinate asintvalue.byte[]getSamplesByte()Gets the scaled, (geo-)physical array ofintsamples, copied from or directly returning the underlying data buffer.double[]getSamplesDouble()Gets the scaled, (geo-)physical array ofdoublesamples, copied from or directly returning the underlying data buffer.float[]getSamplesFloat()Gets the scaled, (geo-)physical array ofdoublesamples, copied from or directly returning the underlying data buffer.int[]getSamplesInt()Gets the scaled, (geo-)physical array ofintsamples, copied from or directly returning the underlying data buffer.short[]getSamplesShort()Gets the scaled, (geo-)physical array ofintsamples, copied from or directly returning the underlying data buffer.intgetScanlineOffset()Gets the scanline offset.intgetScanlineStride()Gets the raster scanline stride for addressing the internal data buffer.intgetWidth()Gets the width in pixels within the scene covered by the tile'sRasterDataNode.booleanisSampleValid(int x, int y)Checks whether or not the sample value exists and is valid at a given image pixel position.booleanisTarget()Checks if this is a target tile.Iterator<Tile.Pos>iterator()Gets an iterator which can be used to visit all pixels in the tile.voidsetRawSamples(ProductData rawSamples)Sets this tile's raw (unscaled, uncalibrated) samples.voidsetSample(int x, int y, boolean sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from abooleanvalue.voidsetSample(int x, int y, double sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from adoublevalue.voidsetSample(int x, int y, float sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from afloatvalue.voidsetSample(int x, int y, int sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from aintvalue.voidsetSample(int x, int y, int bitIndex, boolean sample)Sets the bit-coded sample at the given pixel coordinate and the specified bit index from abooleanvalue.voidsetSamples(byte[] samples)Sets this tile's scaled, (geo-)physical samples as array offloatss.voidsetSamples(double[] samples)Sets this tile's scaled, (geo-)physical samples as array ofdoubles.voidsetSamples(float[] samples)Sets this tile's scaled, (geo-)physical samples as array offloatss.voidsetSamples(int[] samples)Sets this tile's scaled, (geo-)physical samples as array offloatss.voidsetSamples(short[] samples)Sets this tile's scaled, (geo-)physical samples as array offloatss.doubletoGeoPhysical(double rawSample)Converts a raw sample value (e.g.floattoGeoPhysical(float rawSample)Converts a raw sample value (e.g.doubletoRaw(double sample)Converts a (geo-)physically scaled sample value of typedoubleto a its corresponding raw sample value (e.g.floattoRaw(float sample)Converts a (geo-)physically scaled sample value of typefloatto a its corresponding raw sample value (e.g.- 
Methods inherited from interface java.lang.IterableforEach, spliterator
 
- 
 
- 
- 
- 
Method Detail- 
getRasterDataNodeRasterDataNode getRasterDataNode() Gets theRasterDataNodeassociated with this tile, e.g. aBandfor source and target tiles orTiePointGridfor a source tile.- Returns:
- The RasterDataNodeassociated with this tile.
 
 - 
isTargetboolean isTarget() Checks if this is a target tile. Non-target tiles are read only.- Returns:
- trueif this is a target tile.
 
 - 
toGeoPhysicalfloat toGeoPhysical(float rawSample) Converts a raw sample value (e.g. digital counts) to a (geo-)physically scaled sample value of typefloat.- Parameters:
- rawSample- The raw sample value.
- Returns:
- The calibrated sample value.
 
 - 
toGeoPhysicaldouble toGeoPhysical(double rawSample) Converts a raw sample value (e.g. digital counts) to a (geo-)physically scaled sample value of typedouble.- Parameters:
- rawSample- The raw sample value.
- Returns:
- The calibrated sample value.
 
 - 
toRawfloat toRaw(float sample) Converts a (geo-)physically scaled sample value of typefloatto a its corresponding raw sample value (e.g. digital counts).- Parameters:
- sample- The calibrated sample value.
- Returns:
- The raw sample value.
 
 - 
toRawdouble toRaw(double sample) Converts a (geo-)physically scaled sample value of typedoubleto a its corresponding raw sample value (e.g. digital counts).- Parameters:
- sample- The calibrated sample value.
- Returns:
- The raw sample value.
 
 - 
getRectangleRectangle getRectangle() Gets the tile rectangle in pixel coordinates within the scene covered by the tile'sRasterDataNode. Simply returnsnew Rectangle(.minX,minY,width,height)- Returns:
- The tile rectangle in pixel coordinates.
 
 - 
getMinXint getMinX() Gets the minimum pixel x-coordinate within the scene covered by the tile'sRasterDataNode.- Returns:
- The minimum pixel x-coordinate.
 
 - 
getMaxXint getMaxX() Gets the maximum pixel x-coordinate within the scene covered by the tile'sRasterDataNode.- Returns:
- The maximum pixel x-coordinate.
 
 - 
getMinYint getMinY() Gets the minimum pixel y-coordinate within the scene covered by the tile'sRasterDataNode.- Returns:
- The minimum pixel y-coordinate.
 
 - 
getMaxYint getMaxY() Gets the maximum pixel y-coordinate within the scene covered by the tile'sRasterDataNode.- Returns:
- The maximum pixel y-coordinate.
 
 - 
getWidthint getWidth() Gets the width in pixels within the scene covered by the tile'sRasterDataNode.- Returns:
- The width in pixels.
 
 - 
getHeightint getHeight() Gets the height in pixels within the scene covered by the tile'sRasterDataNode.- Returns:
- The height in pixels.
 
 - 
getDataBufferIndexint getDataBufferIndex(int x, int y)Gets the index into the underlying raw sample buffer for the given pixel coordinates.The pixel coordinates are absolute; meaning they are defined in the scene raster coordinate system of this tile's RasterDataNode.The returned index is computed as follows: int dx = x - getMinX(); int dy = y -getMinY(); int index =getScanlineOffset()+ dy *getScanlineStride()+ dx;
 - 
getDataBufferProductData getDataBuffer() Obtains access to the underlying raw sample buffer. The data buffer holds the raw (unscaled, uncalibrated) sample data (e.g. detector counts). Elements in this array must be addressed by an index computed via the scanlineStrideandscanlineOffsetproperties. The index can also be directly computed using thegetDataBufferIndex(int, int)method.The most efficient way to access and/or modify the samples in the raw data buffer is using the following nested loops: int lineStride = tile. getScanlineStride(); int lineOffset = tile.getScanlineOffset(); for (int y = tile.getMinY(); y <= tile.getMaxY(); y++) { int index = lineOffset; for (int x = tile.getMinX(); x <= tile.getMaxX(); x++) { // use index here to access raw data buffer... index++; } lineOffset += lineStride; }If the absolute x,y pixel coordinates are not required, the following construct maybe more readable: int lineStride = tile. getScanlineStride(); int lineOffset = tile.getScanlineOffset(); for (int y = 0; y < tile.getHeight(); y++) { int index = lineOffset; for (int x = 0; x < tile.getWidth(); x++) { // use index here to access raw data buffer... index++; } lineOffset += lineStride; }- Returns:
- the sample data
 
 - 
getDataBufferBytebyte[] getDataBufferByte() Gets the underlying raw sample array of typebyte(signed or unsigned). If the underlying data buffer is not of typebyte,nullis returned.Refer to getDataBuffer()for using the primitive array.- Returns:
- The underlying data buffer's primitive array, or null(see above).
- See Also:
- getDataBufferIndex(int, int),- getDataBuffer()
 
 - 
getDataBufferShortshort[] getDataBufferShort() Gets the underlying raw sample array of typeshort(signed or unsigned). If the underlying data buffer is not of typeshort,nullis returned.Refer to getDataBuffer()for using the primitive array.- Returns:
- The underlying data buffer's primitive array, or null(see above).
- See Also:
- getDataBufferIndex(int, int),- getDataBuffer()
 
 - 
getDataBufferIntint[] getDataBufferInt() Gets the underlying raw sample array of typeint. If the underlying data buffer is not of typeint,nullis returned.Refer to getDataBuffer()for using the primitive array.- Returns:
- The underlying data buffer's primitive array, or null(see above).
- See Also:
- getDataBufferIndex(int, int),- getDataBuffer()
 
 - 
getDataBufferFloatfloat[] getDataBufferFloat() Gets the underlying raw sample array of typefloat. If the underlying data buffer is not of typefloat,nullis returned.Refer to getDataBuffer()for using the primitive array.- Returns:
- The underlying data buffer's primitive array, or null(see above).
- See Also:
- getDataBufferIndex(int, int),- getDataBuffer()
 
 - 
getDataBufferDoubledouble[] getDataBufferDouble() Gets the underlying raw sample array of typedouble. If the underlying data buffer is not of typedouble,nullis returned.Refer to getDataBuffer()for using the primitive array.- Returns:
- The underlying data buffer's primitive array, or null(see above).
- See Also:
- getDataBufferIndex(int, int),- getDataBuffer()
 
 - 
getScanlineOffsetint getScanlineOffset() Gets the scanline offset. The scanline offset is the index to the first valid sample element in the data buffer.- Returns:
- The raster scanline offset.
- See Also:
- getScanlineStride()
 
 - 
getScanlineStrideint getScanlineStride() Gets the raster scanline stride for addressing the internal data buffer. The scanline stride is added to the scanline offset in order to compute offsets of subsequent scanlines.- Returns:
- The raster scanline stride.
- See Also:
- getScanlineOffset()
 
 - 
getRawSamplesProductData getRawSamples() Gets the raw (unscaled, uncalibrated) samples, e.g. detector counts, copied from or wrapping the underlying data buffer. In contradiction to thegetDataBuffer()method, the returned samples will cover exactly the regiongetRectangle()rectangle} of this tile. Thus, the number of returned samples will always equalwidth*height.In order to apply changes of the samples values to this tile, it is mandatory to call setRawSamples(ProductData)with the modifiedProductDatainstance.- Returns:
- The raw samples copied from or wrapping the underlying data buffer.
 
 - 
setRawSamplesvoid setRawSamples(ProductData rawSamples) Sets this tile's raw (unscaled, uncalibrated) samples. The number of given samples must be equalwidth*heightof this tile.This method must be used in order to apply changes made to the samples returned by the getRawSamples()method.- Parameters:
- rawSamples- The raw samples to be set.
 
 - 
getSamplesBytebyte[] getSamplesByte() Gets the scaled, (geo-)physical array ofintsamples, copied from or directly returning the underlying data buffer. In contradiction to thegetDataBuffer()method, the returned samples will cover exactly the regiongetRectangle()rectangle} of this tile. Thus, the number of returned samples will always equalwidth*height.Sample values that are masked out (see isSampleValid(int, int)) are set to zero.- Returns:
- The (geo-)physical samples computed from the underlying raw data buffer.
- Since:
- BEAM 5.0
- See Also:
- setSamples(byte[])
 
 - 
getSamplesShortshort[] getSamplesShort() Gets the scaled, (geo-)physical array ofintsamples, copied from or directly returning the underlying data buffer. In contradiction to thegetDataBuffer()method, the returned samples will cover exactly the regiongetRectangle()rectangle} of this tile. Thus, the number of returned samples will always equalwidth*height.Sample values that are masked out (see isSampleValid(int, int)) are set to zero.- Returns:
- The (geo-)physical samples computed from the underlying raw data buffer.
- Since:
- BEAM 5.0
- See Also:
- setSamples(short[])
 
 - 
getSamplesIntint[] getSamplesInt() Gets the scaled, (geo-)physical array ofintsamples, copied from or directly returning the underlying data buffer. In contradiction to thegetDataBuffer()method, the returned samples will cover exactly the regiongetRectangle()rectangle} of this tile. Thus, the number of returned samples will always equalwidth*height.Sample values that are masked out (see isSampleValid(int, int)) are set to zero.- Returns:
- The (geo-)physical samples computed from the underlying raw data buffer.
- Since:
- BEAM 4.8
- See Also:
- setSamples(int[])
 
 - 
getSamplesFloatfloat[] getSamplesFloat() Gets the scaled, (geo-)physical array ofdoublesamples, copied from or directly returning the underlying data buffer. In contradiction to thegetDataBuffer()method, the returned samples will cover exactly the regiongetRectangle()rectangle} of this tile. Thus, the number of returned samples will always equalwidth*height.Sample values that are masked out (see isSampleValid(int, int)) are set toFloat.NaN.- Returns:
- The (geo-)physical samples computed from the underlying raw data buffer.
- See Also:
- setSamples(float[])
 
 - 
getSamplesDoubledouble[] getSamplesDouble() Gets the scaled, (geo-)physical array ofdoublesamples, copied from or directly returning the underlying data buffer. In contradiction to thegetDataBuffer()method, the returned samples will cover exactly the regiongetRectangle()rectangle} of this tile. Thus, the number of returned samples will always equalwidth*height.Sample values that are masked out (see isSampleValid(int, int)) are set toDouble.NaN.- Returns:
- The (geo-)physical samples computed from the underlying raw data buffer.
- See Also:
- setSamples(double[])
 
 - 
setSamplesvoid setSamples(byte[] samples) Sets this tile's scaled, (geo-)physical samples as array offloatss. The number of given samples must be equalwidth*heightof this tile.- Parameters:
- samples- The (geo-)physical samples to be set.
- Since:
- BEAM 5.0
- See Also:
- getSamplesByte()
 
 - 
setSamplesvoid setSamples(short[] samples) Sets this tile's scaled, (geo-)physical samples as array offloatss. The number of given samples must be equalwidth*heightof this tile.- Parameters:
- samples- The (geo-)physical samples to be set.
- Since:
- BEAM 5.0
- See Also:
- getSamplesShort()
 
 - 
setSamplesvoid setSamples(int[] samples) Sets this tile's scaled, (geo-)physical samples as array offloatss. The number of given samples must be equalwidth*heightof this tile.- Parameters:
- samples- The (geo-)physical samples to be set.
- Since:
- BEAM 4.8
- See Also:
- getSamplesInt()
 
 - 
setSamplesvoid setSamples(float[] samples) Sets this tile's scaled, (geo-)physical samples as array offloatss. The number of given samples must be equalwidth*heightof this tile.- Parameters:
- samples- The (geo-)physical samples to be set.
- See Also:
- getSamplesFloat()
 
 - 
setSamplesvoid setSamples(double[] samples) Sets this tile's scaled, (geo-)physical samples as array ofdoubles. The number of given samples must be equalwidth*heightof this tile.This method must be used in order to apply changes made to the samples returned by the getRawSamples()method.- Parameters:
- samples- The (geo-)physical samples to be set.
- See Also:
- getSamplesDouble()
 
 - 
isSampleValidboolean isSampleValid(int x, int y)Checks whether or not the sample value exists and is valid at a given image pixel position.- Parameters:
- x- the image pixel x-coordinate
- y- the image pixel y-coordinate
- Returns:
- true, if the sample exists and is valid
- Since:
- BEAM 4.7.1
 
 - 
getSampleBooleanboolean getSampleBoolean(int x, int y)Gets the (geo-)physically scaled sample at the given pixel coordinate asbooleanvalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. Note that in most cases, accessing the tile's dataBufferdirectly in conjunction with thescanlineOffsetandscanlineStrideproperties gives a better performance.
 - 
setSamplevoid setSample(int x, int y, boolean sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from abooleanvalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. Note that in most cases, accessing the tile's dataBufferdirectly in conjunction with thescanlineOffsetandscanlineStrideproperties gives a better performance.
 - 
getSampleIntint getSampleInt(int x, int y)Gets the (geo-)physically scaled sample at the given pixel coordinate asintvalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. Note that in most cases, accessing the tile's dataBufferdirectly in conjunction with thescanlineOffsetandscanlineStrideproperties gives a better performance.
 - 
setSamplevoid setSample(int x, int y, int sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from aintvalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. The conversion ensures that no overflow happens. If necessary the value is cropped to the value range. Note that in most cases, accessing the tile's dataBufferdirectly in conjunction with thescanlineOffsetandscanlineStrideproperties gives a better performance.
 - 
getSampleFloatfloat getSampleFloat(int x, int y)Gets the (geo-)physically scaled sample at the given pixel coordinate asfloatvalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. Note that in most cases it is more performant to directly access the tile's dataBufferin conjunction with thescanlineOffsetandscanlineStrideproperties.
 - 
setSamplevoid setSample(int x, int y, float sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from afloatvalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. The conversion ensures that no overflow happens. If necessary the value is cropped to the value range. Note that in most cases, accessing the tile's dataBufferdirectly in conjunction with thescanlineOffsetandscanlineStrideproperties gives a better performance.
 - 
getSampleDoubledouble getSampleDouble(int x, int y)Gets the (geo-)physically scaled sample value for the given pixel coordinate asdouble.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. Note that in most cases, accessing the tile's dataBufferdirectly in conjunction with thescanlineOffsetandscanlineStrideproperties gives a better performance.
 - 
setSamplevoid setSample(int x, int y, double sample)Sets the (geo-)physically scaled sample at the given pixel coordinate from adoublevalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. The conversion ensures that no overflow happens. If necessary the value is cropped to the value range. Note that in most cases, accessing the tile's dataBufferdirectly in conjunction with thescanlineOffsetandscanlineStrideproperties gives a better performance.
 - 
getSampleBitboolean getSampleBit(int x, int y, int bitIndex)Gets the bit-coded sample value for the given pixel coordinate and the specified bit index as aboolean.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. Note that in most cases it is more performant to directly access the tile's dataBufferin conjunction with thescanlineOffsetandscanlineStrideproperties.
 - 
setSamplevoid setSample(int x, int y, int bitIndex, boolean sample)Sets the bit-coded sample at the given pixel coordinate and the specified bit index from abooleanvalue.If the underlying data buffer is of a different sample data type, an appropriate type conversion is performed. Note that in most cases it is more performant to directly access the tile's dataBufferin conjunction with thescanlineOffsetandscanlineStrideproperties.
 - 
iteratorIterator<Tile.Pos> iterator() Gets an iterator which can be used to visit all pixels in the tile. The method allows this tile to be the target of the Java "foreach" statement. Using the tile as an iterator in a single loopfor (Tile.Pos pos: tile) { int x = pos.x; int y = pos.y; // ... }is equivalent to iterating over all pixels using two nested loopsfor (int y = tile.getMinY(); y <= tile.getMaxY(); y++) { for (int x = tile.getMinX(); x <= tile.getMaxX(); x++) { // ... } }
 
- 
 
-