Package org.apache.sis.coverage
Class RegionOfInterest
java.lang.Object
org.apache.sis.coverage.RegionOfInterest
- All Implemented Interfaces:
Serializable
,LenientComparable
Region of interest (ROI) for an operation to apply on a coverage.
Multi-threading
Instances ofRegionOfInterest
are immutable and thread-safe.
Limitations
Current implementation supports two-dimensional regions only. This restriction will be relaxed progressively in future versions.Current implementation defines ROI using a geometric shape only. Future versions may allow other ways such as mask rasters.
- Since:
- 1.2
- Version:
- 1.2
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final org.opengis.referencing.crs.CoordinateReferenceSystem
The coordinate reference system of the region of interest, In current version, it shall be a two-dimensional CRS.private final Shape
The region of interest as a geometry.private static final long
For cross-version compatibility. -
Constructor Summary
ConstructorsConstructorDescriptionRegionOfInterest
(Shape geometry, org.opengis.referencing.crs.CoordinateReferenceSystem crs) Creates a new region of interest from a two-dimensional shape. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Compares this region of interest with the given object for equality.boolean
equals
(Object other, ComparisonMode mode) Compares this region of interest with the given object for equality.int
hashCode()
Returns a hash code value for this region of interest.toShape2D
(GridGeometry target) Returns the clip geometry in coordinates of grid cells.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDFor cross-version compatibility.- See Also:
-
geometry
The region of interest as a geometry. Coordinates are in the CRS given becrs
. -
crs
private final org.opengis.referencing.crs.CoordinateReferenceSystem crsThe coordinate reference system of the region of interest, In current version, it shall be a two-dimensional CRS. May benull
if unknown.
-
-
Constructor Details
-
RegionOfInterest
Creates a new region of interest from a two-dimensional shape. If the given CRS isnull
, then it will be assumed the same CRS than the CRS of the coverage on which operations are applied.- Parameters:
geometry
- the ROI as a geometry. Coordinates are in the CRS given bycrs
.crs
- coordinate reference system of the region of interest, ornull
.
-
-
Method Details
-
toShape2D
public Shape toShape2D(GridGeometry target) throws org.opengis.referencing.operation.TransformException Returns the clip geometry in coordinates of grid cells. The target space is specified by aGridGeometry
.Limitations
In current implementation, the grid geometry most be two-dimensional. This restriction will be relaxed progressively in future versions.- Parameters:
target
- two-dimensional grid geometry of the target image.- Returns:
- clip in pixel coordinates of given grid.
- Throws:
org.opengis.referencing.operation.TransformException
- if ROI coordinates cannot be transformed to grid coordinates.
-
equals
Compares this region of interest with the given object for equality.- Specified by:
equals
in interfaceLenientComparable
- Overrides:
equals
in classObject
- Parameters:
other
- the other object to compare with this ROI.- Returns:
- whether the given object is equal to this ROI?
- See Also:
-
equals
Compares this region of interest with the given object for equality.- Specified by:
equals
in interfaceLenientComparable
- Parameters:
other
- the other object to compare with this ROI.mode
- the comparison criterion.- Returns:
- whether the given object is equal to this ROI?
- See Also:
-
hashCode
public int hashCode()Returns a hash code value for this region of interest.
-