Object
FormattableObject
AbstractEnvelope
- Direct Known Subclasses:
GeneralEnvelope,ImmutableEnvelope
Default implementations of most
Envelope methods, leaving the data storage to subclasses.
This base class does not hold any state and does not implement the Serializable
or Cloneable interfaces. The internal representation, and the choice to be cloneable or
serializable, is left to subclasses.
Implementers needs to define at least the following methods:
All other methods, including toString(), equals(Object) and hashCode(),
are implemented on top of the above four methods.
Crossing the anti-meridian of a Geographic CRS
The Web Coverage Service (WCS) specification authorizes (with special treatment) cases where upper < lower at least in the longitude case. They are envelopes crossing the anti-meridian, like the red box below (the green box is the usual case). The default implementation of methods listed in the right column can handle such cases.
Choosing the range of longitude values
Geographic CRS typically have longitude values in the [-180 … +180]° range, but the [0 … 360]° range is also occasionally used. Users of this class need to ensure that this envelope CRS is associated to axes having the desired minimum and maximum value.Note on positive and negative zeros
The IEEE 754 standard defines two different values for positive zero and negative zero. When used with SIS envelopes and keeping in mind the above discussion, those zeros have different meanings:- The [-0…0]° range is an empty envelope.
- The [0…-0]° range makes a full turn around the globe, like the [-180…180]° range except that the former range spans across the anti-meridian.
- Since:
- 0.3
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AbstractEnvelopecastOrCopy(Envelope envelope) Returns the given envelope as anAbstractEnvelopeinstance.booleancontains(DirectPosition position) Tests if a specified coordinate is inside the boundary of this envelope.booleanReturnstrueif this envelope completely encloses the specified envelope.booleanReturnstrueif this envelope completely encloses the specified envelope.booleanReturnstrueif the specified object is an envelope of the same class with equals coordinates and CRS.booleanCompares to the specified envelope for equality up to the specified tolerance value.protected StringFormats this envelope as a "BOX" element.abstract doublegetLower(int dimension) Returns the limit in the direction of decreasing coordinate values in the specified dimension.A coordinate position consisting of all the lower coordinate values.doublegetMaximum(int dimension) Returns the maximal coordinate value for the specified dimension.A coordinate position consisting of all the median coordinate values.doublegetMedian(int dimension) Returns the median coordinate along the specified dimension.doublegetMinimum(int dimension) Returns the minimal coordinate value for the specified dimension.doublegetSpan(int dimension) Returns the envelope span (typically width or height) along the specified dimension.doubleReturns the envelope span along the specified dimension, in terms of the given units.Returns the time range of the first dimension associated to a temporal CRS.abstract doublegetUpper(int dimension) Returns the limit in the direction of increasing coordinate values in the specified dimension.A coordinate position consisting of all the upper coordinate values.intReturns a hash value for this envelope.booleanintersects(Envelope envelope) Returnstrueif this envelope intersects the specified envelope.booleanintersects(Envelope envelope, boolean touch) Returnstrueif this envelope intersects or (optionally) touches the specified envelope.booleanReturnsfalseif at least one coordinate value is not NaN.booleanisEmpty()Determines whether or not this envelope is empty.booleanDetermines whether or not this envelope contains only finite values.Envelope[]Returns this envelope as an array of simple (without wraparound) envelopes.Formats this envelope as a "BOX" element.Methods inherited from class FormattableObject
print, toString, toWKTMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface Envelope
getCoordinateReferenceSystem, getDimension
-
Constructor Details
-
AbstractEnvelope
protected AbstractEnvelope()Constructs an envelope.
-
-
Method Details
-
castOrCopy
Returns the given envelope as anAbstractEnvelopeinstance. If the given envelope is already an instance ofAbstractEnvelope, then it is returned unchanged. Otherwise the coordinate values and the CRS of the given envelope are copied in a new envelope.- Parameters:
envelope- the envelope to cast, ornull.- Returns:
- the values of the given envelope as an
AbstractEnvelopeinstance. - See Also:
-
getLowerCorner
A coordinate position consisting of all the lower coordinate values. The default implementation returns a view over thegetLower(int)method, so changes in this envelope will be immediately reflected in the returned direct position. If the particular case of theGeneralEnvelopesubclass, the returned position supports also write operations, so changes in the position are reflected back in the envelope.Note on wraparound
The Web Coverage Service (WCS) 1.1 specification uses an extended interpretation of the bounding box definition. In a WCS 1.1 data structure, the lower corner defines the edges region in the directions of decreasing coordinate values in the envelope CRS. This is usually the algebraic minimum coordinates, but not always. For example, an envelope crossing the anti-meridian could have a lower corner longitude greater than the upper corner longitude. Such extended interpretation applies mostly to axes havingWRAPAROUNDrange meaning.- Specified by:
getLowerCornerin interfaceEnvelope- Returns:
- a view over the lower corner, typically (but not necessarily) containing minimal coordinate values.
- See Also:
-
getUpperCorner
A coordinate position consisting of all the upper coordinate values. The default implementation returns a view over thegetUpper(int)method, so changes in this envelope will be immediately reflected in the returned direct position. If the particular case of theGeneralEnvelopesubclass, the returned position supports also write operations, so changes in the position are reflected back in the envelope.Note on wraparound
The Web Coverage Service (WCS) 1.1 specification uses an extended interpretation of the bounding box definition. In a WCS 1.1 data structure, the upper corner defines the edges region in the directions of increasing coordinate values in the envelope CRS. This is usually the algebraic maximum coordinates, but not always. For example, an envelope crossing the anti-meridian could have an upper corner longitude less than the lower corner longitude. Such extended interpretation applies mostly to axes havingWRAPAROUNDrange meaning.- Specified by:
getUpperCornerin interfaceEnvelope- Returns:
- a view over the upper corner, typically (but not necessarily) containing maximal coordinate values.
- See Also:
-
getMedian
A coordinate position consisting of all the median coordinate values. The default implementation returns a view over thegetMedian(int)method, so changes in this envelope will be immediately reflected in the returned direct position.- Returns:
- the median coordinates.
- See Also:
-
getLower
Returns the limit in the direction of decreasing coordinate values in the specified dimension. This is usually the algebraic minimum, except if this envelope spans the anti-meridian.- Parameters:
dimension- the dimension for which to obtain the coordinate value.- Returns:
- the starting coordinate value at the given dimension.
- Throws:
IndexOutOfBoundsException- if the given index is negative or is equal or greater than the envelope dimension.- See Also:
-
getUpper
Returns the limit in the direction of increasing coordinate values in the specified dimension. This is usually the algebraic maximum, except if this envelope spans the anti-meridian.- Parameters:
dimension- the dimension for which to obtain the coordinate value.- Returns:
- the starting coordinate value at the given dimension.
- Throws:
IndexOutOfBoundsException- if the given index is negative or is equal or greater than the envelope dimension.- See Also:
-
getMinimum
Returns the minimal coordinate value for the specified dimension. In the typical case of non-empty envelopes not crossing the anti-meridian, this method returns thegetLower(int)value verbatim. In the case of envelope crossing the anti-meridian, this method returns the axis minimum value. If the range in the given dimension is invalid, then this method returnsNaN.- Specified by:
getMinimumin interfaceEnvelope- Parameters:
dimension- the dimension for which to obtain the coordinate value.- Returns:
- the minimal coordinate value at the given dimension.
- Throws:
IndexOutOfBoundsException- if the given index is negative or is equal or greater than the envelope dimension.
-
getMaximum
Returns the maximal coordinate value for the specified dimension. In the typical case of non-empty envelopes not crossing the anti-meridian, this method returns thegetUpper(int)value verbatim. In the case of envelope crossing the anti-meridian, this method returns the axis maximum value. If the range in the given dimension is invalid, then this method returnsNaN.- Specified by:
getMaximumin interfaceEnvelope- Parameters:
dimension- the dimension for which to obtain the coordinate value.- Returns:
- the maximal coordinate value at the given dimension.
- Throws:
IndexOutOfBoundsException- if the given index is negative or is equal or greater than the envelope dimension.
-
getMedian
Returns the median coordinate along the specified dimension. In most cases, the result is equal (minus rounding error) to:median = (getUpper(dimension) + getLower(dimension)) / 2;Crossing the anti-meridian of a Geographic CRS
If upper < lower and the range meaning for the requested dimension is wraparound, then the median calculated above is actually in the middle of the space outside the envelope. In such cases, this method shifts the median value by half of the periodicity (180° in the longitude case) in order to switch from outer space to inner space. If the axis range meaning is notWRAPAROUND, then this method returnsNaN.- Specified by:
getMedianin interfaceEnvelope- Parameters:
dimension- the dimension for which to obtain the coordinate value.- Returns:
- the median coordinate at the given dimension, or
Double.NaN. - Throws:
IndexOutOfBoundsException- if the given index is negative or is equal or greater than the envelope dimension.- See Also:
-
getSpan
public double getSpan(int dimension) Returns the envelope span (typically width or height) along the specified dimension. In most cases, the result is equal (minus rounding error) to:span = getUpper(dimension) - getLower(dimension);Crossing the anti-meridian of a Geographic CRS
If upper < lower and the range meaning for the requested dimension is wraparound, then the span calculated above is negative. In such cases, this method adds the periodicity (typically 360° of longitude) to the span. If the result is a positive number, it is returned. Otherwise this method returnsNaN.- Specified by:
getSpanin interfaceEnvelope- Parameters:
dimension- the dimension for which to obtain the span.- Returns:
- the span (typically width or height) at the given dimension, or
Double.NaN. - Throws:
IndexOutOfBoundsException- if the given index is negative or is equal or greater than the envelope dimension.
-
getSpan
public double getSpan(int dimension, Unit<?> unit) throws IndexOutOfBoundsException, IncommensurableException Returns the envelope span along the specified dimension, in terms of the given units. The default implementation invokesgetSpan(int)and converts the result.- Parameters:
dimension- the dimension to query.unit- the unit for the return value.- Returns:
- the span in terms of the given unit.
- Throws:
IndexOutOfBoundsException- if the given index is out of bounds.IncommensurableException- if the length cannot be converted to the specified units.
-
getTimeRange
Returns the time range of the first dimension associated to a temporal CRS. This convenience method converts floating point values to instants usingDefaultTemporalCRS.toInstant(double).- Returns:
- time range in this given envelope.
- Since:
- 1.1
- See Also:
-
toSimpleEnvelopes
Returns this envelope as an array of simple (without wraparound) envelopes. The length of the returned array depends on the number of dimensions where a wraparound range is found. Typically, wraparound occurs only in the range of longitude values, when the range crosses the anti-meridian (a.k.a. date line). However, this implementation will take in account any axis having wraparound range meaning.Special cases:
- If this envelope is empty, then this method returns an empty array.
- If this envelope does not have any wraparound behavior, then this method returns
thisin an array of length 1. This envelope is not cloned. - If this envelope crosses the anti-meridian (a.k.a. date line) then this method returns two separated envelopes covering the same area than this envelopes.
- While uncommon, the envelope could theoretically crosses the limit of other axis having wraparound range meaning. If wraparounds occur along n axes, then this method may return 2ⁿ separated simple envelopes.
- Returns:
- a representation of this envelope as an array of non-empty envelope.
- Since:
- 0.4
- See Also:
-
isFinite
public boolean isFinite()Determines whether or not this envelope contains only finite values. More specifically this method returnsfalseif at least one coordinate value is NaN or infinity, andtrueotherwise. Note that a finite envelope may be empty.- Returns:
trueif this envelope contains only finite coordinate values.- Since:
- 1.4
-
isEmpty
public boolean isEmpty()Determines whether or not this envelope is empty. An envelope is empty if it has zero dimension, or if the span of at least one axis is negative, 0 orNaN.Note: Strictly speaking, there is an ambiguity if a span isIfNaNor if the envelope contains both 0 and infinite spans (since 0⋅∞ =NaN). In such cases, this method arbitrarily ignores the infinite values and returnstrue.isEmpty()returnsfalse, thenisAllNaN()is guaranteed to also returnfalse. However, the converse is not always true. -
isAllNaN
public boolean isAllNaN()Returnsfalseif at least one coordinate value is not NaN. ThisisAllNaN()check is different than theisEmpty()check since it returnsfalsefor a partially initialized envelope, whileisEmpty()returnsfalseonly after all dimensions have been initialized. More specifically, the following rules apply:- If
isAllNaN() == true, thenisEmpty() == true - If
isEmpty() == false, thenisAllNaN() == false - The converse of the above-cited rules are not always true.
- Returns:
trueif this envelope has NaN values.- See Also:
- If
-
contains
Tests if a specified coordinate is inside the boundary of this envelope. Both lower and upper values of this envelope are considered inclusive. If it least one coordinate value in the given point isNaN, then this method returnsfalse.Preconditions
This method assumes that the specified point uses a CRS equivalent to this envelope CRS. For performance reasons, it will no be verified unless Java assertions are enabled.Crossing the anti-meridian of a Geographic CRS
For any dimension, if upper < lower then this method uses an algorithm which is the opposite of the usual one: rather than testing if the given point is inside the envelope interior, this method tests if the given point is outside the envelope exterior.- Parameters:
position- the point to text.- Returns:
trueif the specified coordinate is inside the boundary of this envelope;falseotherwise.- Throws:
MismatchedDimensionException- if the specified point does not have the expected number of dimensions.AssertionError- if assertions are enabled and the envelopes have mismatched CRS.
-
contains
Returnstrueif this envelope completely encloses the specified envelope. The default implementation delegates to:contains(envelope, true)
Preconditions
This method assumes that the specified envelope uses the same CRS than this envelope. For performance reasons, it will no be verified unless Java assertions are enabled.Crossing the anti-meridian of a Geographic CRS
For every cases illustrated below, the yellow box is considered completely enclosed in the blue envelope:
- Parameters:
envelope- the envelope to test for inclusion.- Returns:
trueif this envelope completely encloses the specified one.- Throws:
MismatchedDimensionException- if the specified envelope doesn't have the expected dimension.AssertionError- if assertions are enabled and the envelopes have mismatched CRS.- Since:
- 0.4
- See Also:
-
contains
public boolean contains(Envelope envelope, boolean edgesInclusive) throws MismatchedDimensionException Returnstrueif this envelope completely encloses the specified envelope. If one or more edges from the specified envelope coincide with an edge from this envelope, then this method returnstrueonly ifedgesInclusiveistrue.This method is subject to the same preconditions than
contains(Envelope), and handles envelopes crossing the anti-meridian in the same way.- Parameters:
envelope- the envelope to test for inclusion.edgesInclusive-trueif this envelope edges are inclusive.- Returns:
trueif this envelope completely encloses the specified one.- Throws:
MismatchedDimensionException- if the specified envelope doesn't have the expected dimension.AssertionError- if assertions are enabled and the envelopes have mismatched CRS.- See Also:
-
intersects
Returnstrueif this envelope intersects the specified envelope. This method returnstrueif two envelope interiors have at least one point in common (in other words, their intersection is non-empty). The default implementation delegates to:intersects(envelope, false)
Preconditions
This method assumes that the specified envelope uses the same CRS than this envelope. For performance reasons, it will no be verified unless Java assertions are enabled.Crossing the anti-meridian of a Geographic CRS
This method can handle envelopes crossing the anti-meridian.- Parameters:
envelope- the envelope to test for intersection.- Returns:
trueif this envelope intersects the specified one.- Throws:
MismatchedDimensionException- if the specified envelope doesn't have the expected dimension.AssertionError- if assertions are enabled and the envelopes have mismatched CRS.- Since:
- 0.4
- See Also:
-
intersects
Returnstrueif this envelope intersects or (optionally) touches the specified envelope. Thetouchargument controls the value to return if only the envelope boundaries (not the interiors) have a point in common:- If
false, this method returnstrueif the intersection between the two envelopes is non-empty (i.e. the envelope interiors have points in common). This is the usual definition ofintersectsoperation. - If
true, this method returnstrueif the two envelopes intersect each other or touch each other.
intersects(Envelope), and handles envelopes crossing the anti-meridian in the same way.- Parameters:
envelope- the envelope to test for intersection.touch- the value to return if the two envelopes touch each other.- Returns:
trueif this envelope intersects the specified envelope, ortouchif this envelope touches the specified envelope, orfalseotherwise.- Throws:
MismatchedDimensionException- if the specified envelope does not have the expected dimension.AssertionError- if assertions are enabled and the envelopes have mismatched CRS.- See Also:
- If
-
equals
Compares to the specified envelope for equality up to the specified tolerance value. The tolerance valueepscan be either relative to the envelope span along each dimension or can be an absolute value (as for example some ground resolution of a grid coverage).- If
epsIsRelativeis set totrue, the actual tolerance value for a given dimension i iseps×spanwherespanis the maximum of this envelope span and the specified envelope span along dimension i. - If
epsIsRelativeis set tofalse, the actual tolerance value for a given dimension i iseps.
Note: Relative tolerance values (as opposed to absolute tolerance values) help to workaround the fact that tolerance value are CRS dependent. For example, the tolerance value need to be smaller for geographic CRS than for UTM projections, because the former typically has a [-180…180]° range while the latter can have a range of thousands of meters.Coordinate Reference System
To be considered equal, the two envelopes must have the same number of dimensions and their CRS must be approximately equal. If at least one envelope has a null CRS, then the CRS are ignored and the coordinate values are compared as if the CRS were equal.- Parameters:
other- the envelope to compare with.eps- the tolerance value to use for numerical comparisons.epsIsRelative-trueif the tolerance value should be relative to axis length, orfalseif it is an absolute value.- Returns:
trueif the given object is equal to this envelope up to the given tolerance value.- See Also:
- If
-
equals
Returnstrueif the specified object is an envelope of the same class with equals coordinates and CRS.Implementation note
This implementation requires that the providedobjectargument is of the same class than this envelope. We do not relax this rule since not every implementations in the SIS code base follow the same contract. -
hashCode
public int hashCode()Returns a hash value for this envelope. -
toString
Formats this envelope as a "BOX" element. The output is of the form "BOXnD(lower corner,upper corner)" where n is the number of dimensions. The number of dimension is written only if different than 2. Examples:BOX(-90 -180, 90 180)BOX3D(-90 -180 0, 90 180 1)
Double.toString(double)(i.e. without fixed number of fraction digits). The string returned by this method can be parsed by theGeneralEnvelopeconstructor.Note on standards
TheBOXelement is not part of the standard Well Known Text (WKT) format. However, it is understood by many software libraries, for example GDAL and PostGIS.- Overrides:
toStringin classFormattableObject- Returns:
- this envelope as a
BOXorBOX3D(most typical dimensions) element.
-
formatTo
Formats this envelope as a "BOX" element. The output is of the form "BOXnD[lower corner,upper corner]" where n is the number of dimensions. The number of dimension is written only if different than 2.If the coordinate reference system is geodetic or projected, then coordinate values are formatted with a precision equivalent to one centimetre on Earth (the actual number of fraction digits is adjusted for the axis unit of measurement and the planet size if different than Earth).
Note on standards
TheBOXelement is not part of the standard Well Known Text (WKT) format. However, it is understood by many software libraries, for example GDAL and PostGIS.- Specified by:
formatToin classFormattableObject- Parameters:
formatter- the formatter where to format the inner content of this envelope.- Returns:
- the pseudo-WKT keyword, which is
"Box"for this element. - Since:
- 1.0
- See Also:
-