Package org.geotools.api.coverage.grid
Interface GridCoordinates
-
- All Known Implementing Classes:
GeneralGridCoordinates
,GeneralGridCoordinates.Immutable
,GridCoordinates2D
public interface GridCoordinates extends Cloneable
Holds the set of grid coordinates that specifies the location of the grid point within the grid.- Since:
- GeoAPI 2.1
- Author:
- Martin Schouwenburg, Wim Koolhoven, Martin Desruisseaux (IRD)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getCoordinateValue(int dimension)
Returns the coordinate value at the specified dimension.int[]
getCoordinateValues()
Returns one integer value for each dimension of the grid.int
getDimension()
Returns the number of dimensions.void
setCoordinateValue(int dimension, int value)
Sets the coordinate value at the specified dimension (optional operation).
-
-
-
Method Detail
-
getDimension
int getDimension()
Returns the number of dimensions. This method is equivalent togetCoordinateValues().length
. It is provided for efficienty.- Returns:
- The number of dimensions.
-
getCoordinateValues
int[] getCoordinateValues()
Returns one integer value for each dimension of the grid. The ordering of these coordinate values shall be the same as that of the elements ofGrid#getAxisNames
. The value of a single coordinate shall be the number of offsets from the origin of the grid in the direction of a specific axis.- Returns:
- A copy of the coordinates. Changes in the returned array will not be reflected back
in this
GridCoordinates
object.
-
getCoordinateValue
int getCoordinateValue(int dimension) throws IndexOutOfBoundsException
Returns the coordinate value at the specified dimension. This method is equivalent togetCoordinateValues()[i]
. It is provided for efficienty.- Parameters:
dimension
- The dimension for which to obtain the coordinate value.- Returns:
- The coordinate value at the given dimension.
- Throws:
IndexOutOfBoundsException
- If the given index is negative or is equals or greater than the grid dimension.
-
setCoordinateValue
void setCoordinateValue(int dimension, int value) throws IndexOutOfBoundsException, UnsupportedOperationException
Sets the coordinate value at the specified dimension (optional operation).- Parameters:
dimension
- The dimension for which to set the coordinate value.value
- The new value.- Throws:
IndexOutOfBoundsException
- If the given index is negative or is equals or greater than the grid dimension.UnsupportedOperationException
- if this grid coordinates is not modifiable.
-
-