# Uses of Interface
org.opengis.geometry.Envelope

Packages that use Envelope
Package
Description
org.apache.sis.coverage
Functions that associates positions within a bounded space (its domain) to values (its range).
org.apache.sis.coverage.grid
A coverage backed by a regular grid.
org.apache.sis.filter
Filters features according their properties.
org.apache.sis.geometry
Basic geometric objects (envelopes and direct positions).
org.apache.sis.gui.map
Widgets for showing a map in a JavaFX application.
org.apache.sis.gui.referencing
Widgets about coordinate reference systems.
org.apache.sis.index.tree
A simple k-dimensional point tree implementation.
org.apache.sis.metadata.iso.extent
Information about spatial, vertical, and temporal extent.
org.apache.sis.portrayal
Symbology and map representations, together with a rendering engine for display.
org.apache.sis.referencing
Base classes for reference systems used for general positioning.
org.apache.sis.referencing.datum
Relationship of a `CoordinateSystem` (an abstract mathematical entity) to the earth or other system.
org.apache.sis.referencing.gazetteer
Mapping between geographic identifiers (addresses, grid indexes…) and locations (descriptions, coordinates…).
org.apache.sis.referencing.operation
Relationship between any two Coordinate Reference Systems (CRS).
org.apache.sis.referencing.operation.builder
Helper classes for creating Math Transforms from a set of points.
org.apache.sis.referencing.operation.matrix
Matrix implementations for spatiotemporal referencing.
org.apache.sis.referencing.operation.transform
Conversions or transformations of multi-dimensional coordinate tuples.
org.apache.sis.storage
Data store base types for retrieving and saving geospatial data in various storage formats.
org.apache.sis.storage.tiling
Base types for retrieving and saving tiles in resources.
org.apache.sis.util
Simple data objects and miscellaneous utilities.

- ## Uses of Envelope in org.apache.sis.coverage

  Methods in org.apache.sis.coverage that return types with arguments of type Envelope
  Modifier and Type
  Method
  Description
  `abstract Optional<Envelope>`
  BandedCoverage.`getEnvelope()`
  Returns the bounding box for the coverage domain in CRS coordinates.

- ## Uses of Envelope in org.apache.sis.coverage.grid

  Methods in org.apache.sis.coverage.grid that return Envelope
  Modifier and Type
  Method
  Description
  `Envelope`
  GridGeometry.`getEnvelope()`
  Returns the bounding box of "real world" coordinates for this grid geometry.
  `Envelope`
  GridGeometry.`getEnvelope(CoordinateReferenceSystem crs)`
  Returns the "real world" bounding box of this grid geometry transformed to the given CRS.
  Methods in org.apache.sis.coverage.grid that return types with arguments of type Envelope
  Modifier and Type
  Method
  Description
  `Optional<Envelope>`
  GridCoverage.`getEnvelope()`
  Returns the bounding box for the coverage domain in CRS coordinates.
  Methods in org.apache.sis.coverage.grid with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `GridCoverageBuilder`
  GridCoverageBuilder.`setDomain(Envelope domain)`
  Sets the domain as an enclosing envelope (including its CRS).
  `GridDerivation`
  GridDerivation.`subgrid(Envelope areaOfInterest, double... resolution)`
  Requests a grid geometry over a sub-envelope and optionally with a coarser resolution.
  Constructors in org.apache.sis.coverage.grid with parameters of type Envelope
  Modifier
  Constructor
  Description
  ``
  `GridGeometry(GridExtent extent, Envelope envelope, GridOrientation orientation)`
  Creates an axis-aligned grid geometry with an extent and an envelope.
  ``
  `GridGeometry(PixelInCell anchor, MathTransform gridToCRS, Envelope envelope, GridRoundingMode rounding)`
  Creates a new grid geometry from a geospatial envelope and a mapping from cell coordinates to "real world" coordinates.
  ``
  `GridGeometry(Envelope envelope)`
  Creates a grid geometry with only an envelope.

- ## Uses of Envelope in org.apache.sis.filter

  Methods in org.apache.sis.filter with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `Filter<R>`
  DefaultFilterFactory.`bbox(Expression<R, ? extends G> geometry, Envelope bounds)`
  Creates an operator that checks if the bounding box of the feature's geometry interacts with the bounding box provided in the filter properties.

- ## Uses of Envelope in org.apache.sis.geometry

  Classes in org.apache.sis.geometry that implement Envelope
  Modifier and Type
  Class
  Description
  `class`
  `AbstractEnvelope`
  Default implementations of most `Envelope` methods, leaving the data storage to subclasses.
  `class`
  `Envelope2D`
  A two-dimensional envelope on top of Java2D rectangle.
  `class`
  `GeneralEnvelope`
  A mutable `Envelope` (a minimum bounding box or rectangle) of arbitrary dimension.
  `final class`
  `ImmutableEnvelope`
  An immutable `Envelope` (a minimum bounding box or rectangle) of arbitrary dimension.
  Methods in org.apache.sis.geometry that return Envelope
  Modifier and Type
  Method
  Description
  `static Envelope`
  Envelopes.`compound(Envelope... components)`
  Puts together a list of envelopes, each of them using an independent coordinate reference system.
  `static Envelope`
  Envelopes.`fromWKT(CharSequence wkt)`
  Returns the bounding box of a geometry defined in Well Known Text (WKT) format.
  `Envelope[]`
  AbstractEnvelope.`toSimpleEnvelopes()`
  Returns this envelope as an array of simple (without wraparound) envelopes.
  `static Envelope`
  Envelopes.`transform(Envelope envelope, CoordinateReferenceSystem targetCRS)`
  Transforms the given envelope to the specified CRS.
  Methods in org.apache.sis.geometry with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `void`
  GeneralEnvelope.`add(Envelope envelope)`
  Adds an envelope object to this envelope.
  `boolean`
  Envelope2D.`boundsEquals(Envelope that, int xDim, int yDim, double eps)`
  Returns `true` if `this` envelope bounds is equal to `that` envelope bounds in two specified dimensions.
  `static AbstractEnvelope`
  AbstractEnvelope.`castOrCopy(Envelope envelope)`
  Returns the given envelope as an `AbstractEnvelope` instance.
  `static GeneralEnvelope`
  GeneralEnvelope.`castOrCopy(Envelope envelope)`
  Returns the given envelope as a `GeneralEnvelope` instance.
  `static ImmutableEnvelope`
  ImmutableEnvelope.`castOrCopy(Envelope envelope)`
  Returns the given envelope as an `ImmutableEnvelope` instance.
  `static Envelope`
  Envelopes.`compound(Envelope... components)`
  Puts together a list of envelopes, each of them using an independent coordinate reference system.
  `boolean`
  AbstractEnvelope.`contains(Envelope envelope)`
  Returns `true` if this envelope completely encloses the specified envelope.
  `boolean`
  AbstractEnvelope.`contains(Envelope envelope, boolean edgesInclusive)`
  Returns `true` if this envelope completely encloses the specified envelope.
  `boolean`
  AbstractEnvelope.`equals(Envelope other, double eps, boolean epsIsRelative)`
  Compares to the specified envelope for equality up to the specified tolerance value.
  `static CoordinateOperation`
  Envelopes.`findOperation(Envelope source, Envelope target)`
  Finds a mathematical operation from the CRS of the given source envelope to the CRS of the given target envelope.
  `static GeneralEnvelope`
  Envelopes.`intersect(Envelope... envelopes)`
  Computes the intersection of all given envelopes, transforming them to a common CRS if necessary.
  `void`
  GeneralEnvelope.`intersect(Envelope envelope)`
  Sets this envelope to the intersection of this envelope with the specified one.
  `static void`
  Shapes2D.`intersect(RectangularShape shape, Envelope envelope, int xdim, int ydim)`
  Sets the given shape to the intersection of that shape with the given envelope.
  `boolean`
  AbstractEnvelope.`intersects(Envelope envelope)`
  Returns `true` if this envelope intersects the specified envelope.
  `boolean`
  AbstractEnvelope.`intersects(Envelope envelope, boolean touch)`
  Returns `true` if this envelope intersects or (optionally) touches the specified envelope.
  `void`
  GeneralEnvelope.`setEnvelope(Envelope envelope)`
  Sets this envelope to the same coordinate values as the specified envelope.
  `GeneralEnvelope`
  WraparoundAdjustment.`shift(Envelope areaOfInterest)`
  Computes an envelope with coordinates equivalent to the given `areaOfInterest`, but potentially shifted for intersecting the domain of validity specified at construction time.
  `static String`
  Envelopes.`toPolygonWKT(Envelope envelope)`
  Formats the given envelope as a `POLYGON` element in the Well Known Text (WKT) format.
  `static String`
  Envelopes.`toString(Envelope envelope)`
  Formats the given envelope as a `BOX` element.
  `static Optional<Range<Instant>>`
  Envelopes.`toTimeRange(Envelope envelope)`
  Returns the time range of the first dimension associated to a temporal CRS.
  `static Envelope`
  Envelopes.`transform(Envelope envelope, CoordinateReferenceSystem targetCRS)`
  Transforms the given envelope to the specified CRS.
  `static GeneralEnvelope`
  Envelopes.`transform(CoordinateOperation operation, Envelope envelope)`
  Transforms an envelope using the given coordinate operation.
  `static GeneralEnvelope`
  Envelopes.`transform(MathTransform transform, Envelope envelope)`
  Transforms an envelope using the given math transform.
  `static Map<Parameters, GeneralEnvelope>`
  Envelopes.`transformWithWraparound(MathTransform transform, Envelope envelope)`
  Transforms potentially many times an envelope using the given math transform.
  `static GeneralEnvelope`
  Envelopes.`union(Envelope... envelopes)`
  Computes the union of all given envelopes, transforming them to a common CRS if necessary.
  Constructors in org.apache.sis.geometry with parameters of type Envelope
  Modifier
  Constructor
  Description
  ``
  `Envelope2D(Envelope envelope)`
  Constructs a two-dimensional envelope defined by another `Envelope`.
  ``
  `GeneralEnvelope(Envelope envelope)`
  Constructs a new envelope with the same data as the specified envelope.
  ``
  `ImmutableEnvelope(Envelope envelope)`
  Creates an immutable envelope with the values of the given envelope.
  ``
  `ImmutableEnvelope(CoordinateReferenceSystem crs, Envelope envelope)`
  Creates an immutable envelope with the coordinate values of the given envelope but a different CRS.
  ``
  `WraparoundAdjustment(Envelope domain, CoordinateReferenceSystem target)`
  Creates a new instance for adjusting Area Of Interest (AOI) or Point Of Interest (POI) to the given domain.
  ``
  `WraparoundAdjustment(Envelope domain, MathTransform domainToInput, MathTransform inputToResult)`
  Creates a new instance with specified transforms from domain to the CRS of inputs, then to the CRS of outputs.

- ## Uses of Envelope in org.apache.sis.gui.map

  Methods in org.apache.sis.gui.map that return Envelope
  Modifier and Type
  Method
  Description
  `Envelope`
  MapCanvas.`getObjectiveBounds()`
  Returns the data bounds to use for computing the initial "objective to display" transform.
  Methods in org.apache.sis.gui.map with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `void`
  MapCanvas.`setObjectiveBounds(Envelope visibleArea)`
  Sets the data bounds to use for computing the initial value of `PlanarCanvas.objectiveToDisplay`.

- ## Uses of Envelope in org.apache.sis.gui.referencing

  Fields in org.apache.sis.gui.referencing with type parameters of type Envelope
  Modifier and Type
  Field
  Description
  `final ObjectProperty<Envelope>`
  RecentReferenceSystems.`areaOfInterest`
  The area of interest, or `null` if none.
  Constructors in org.apache.sis.gui.referencing with parameters of type Envelope
  Modifier
  Constructor
  Description
  ``
  `CRSChooser(CRSAuthorityFactory factory, Envelope areaOfInterest, Locale locale)`
  Creates a chooser proposing all coordinate reference systems from the given factory.

- ## Uses of Envelope in org.apache.sis.index.tree

  Methods in org.apache.sis.index.tree with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `Stream<E>`
  PointTree.`queryByBoundingBox(Envelope searchRegion)`
  Returns all elements in the given bounding box.
  Constructors in org.apache.sis.index.tree with parameters of type Envelope
  Modifier
  Constructor
  Description
  ``
  `PointTree(Class<E> elementType, Envelope bounds, PointTree.Locator<? super E> locator, int nodeCapacity, boolean parallel)`
  Creates an initially empty k-dimensional tree with the given capacity for each node.

- ## Uses of Envelope in org.apache.sis.metadata.iso.extent

  Methods in org.apache.sis.metadata.iso.extent with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `void`
  DefaultExtent.`addElements(Envelope envelope)`
  Adds geographic, vertical or temporal extents inferred from the given envelope.
  `void`
  DefaultGeographicBoundingBox.`setBounds(Envelope envelope)`
  Sets the bounding box to the specified envelope.
  `void`
  DefaultSpatialTemporalExtent.`setBounds(Envelope envelope)`
  Sets this spatiotemporal extent to values inferred from the specified envelope.
  `void`
  DefaultTemporalExtent.`setBounds(Envelope envelope)`
  Sets this temporal extent to values inferred from the specified envelope.
  `void`
  DefaultVerticalExtent.`setBounds(Envelope envelope)`
  Sets this vertical extent to values inferred from the specified envelope.

- ## Uses of Envelope in org.apache.sis.portrayal

  Methods in org.apache.sis.portrayal that return Envelope
  Modifier and Type
  Method
  Description
  `Envelope`
  Canvas.`getDisplayBounds()`
  Returns the size and location of the display device.
  Methods in org.apache.sis.portrayal with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `void`
  Canvas.`setDisplayBounds(Envelope newValue)`
  Sets the size and location of the display device.

- ## Uses of Envelope in org.apache.sis.referencing

  Methods in org.apache.sis.referencing that return Envelope
  Modifier and Type
  Method
  Description
  `static Envelope`
  CRS.`getDomainOfValidity(CoordinateReferenceSystem crs)`
  Returns the domain of validity of the specified coordinate reference system, or `null` if unknown.

- ## Uses of Envelope in org.apache.sis.referencing.datum

  Methods in org.apache.sis.referencing.datum that return Envelope
  Modifier and Type
  Method
  Description
  `Envelope`
  DatumShiftGrid.`getDomainOfValidity()`
  Returns the domain of validity of input coordinates that can be specified to the `interpolateAt(…)` method.
  `Envelope`
  DatumShiftGrid.`getDomainOfValidity(Unit<C> unit)`
  Returns the domain of validity converted to the specified unit of measurement.

- ## Uses of Envelope in org.apache.sis.referencing.gazetteer

  Methods in org.apache.sis.referencing.gazetteer that return Envelope
  Modifier and Type
  Method
  Description
  `Envelope`
  AbstractLocation.`getEnvelope()`
  Returns an envelope that encompass the location.
  Methods in org.apache.sis.referencing.gazetteer with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `Iterator<String>`
  MilitaryGridReferenceSystem.Coder.`encode(Envelope areaOfInterest)`
  Returns an iterator over all MGRS references that intersect the given envelope.
  `Stream<String>`
  MilitaryGridReferenceSystem.Coder.`encode(Envelope areaOfInterest, boolean parallel)`
  Returns a stream of all MGRS references that intersect the given envelope.

- ## Uses of Envelope in org.apache.sis.referencing.operation

  Methods in org.apache.sis.referencing.operation with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `void`
  CoordinateOperationContext.`addAreaOfInterest(Envelope area)`
  Adds the geographic, vertical and temporal elements of an envelope as areas of interest.

- ## Uses of Envelope in org.apache.sis.referencing.operation.builder

  Methods in org.apache.sis.referencing.operation.builder that return Envelope
  Modifier and Type
  Method
  Description
  `Envelope`
  LinearTransformBuilder.`getSourceEnvelope()`
  Returns the envelope of source points (keys of the map returned by `LinearTransformBuilder.getControlPoints()`).
  `Envelope`
  LocalizationGridBuilder.`getSourceEnvelope(boolean fullArea)`
  Returns the envelope of source coordinates.
  `Envelope`
  LinearTransformBuilder.`getTargetEnvelope()`
  Returns the envelope of target points (values of the map returned by `LinearTransformBuilder.getControlPoints()`).
  Methods in org.apache.sis.referencing.operation.builder with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `static LinearTransform`
  LinearTransformBuilder.`approximate(MathTransform gridToCRS, Envelope domain)`
  Returns a linear approximation of the given transform for the specified domain.

- ## Uses of Envelope in org.apache.sis.referencing.operation.matrix

  Methods in org.apache.sis.referencing.operation.matrix with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `static MatrixSIS`
  Matrices.`createTransform(Envelope srcEnvelope, Envelope dstEnvelope)`
  Creates a transform matrix mapping the given source envelope to the given destination envelope.
  `static MatrixSIS`
  Matrices.`createTransform(Envelope srcEnvelope, AxisDirection[] srcAxes, Envelope dstEnvelope, AxisDirection[] dstAxes)`
  Creates a transform matrix mapping the given source envelope to the given destination envelope, combined with changes in axis order and/or direction.

- ## Uses of Envelope in org.apache.sis.referencing.operation.transform

  Methods in org.apache.sis.referencing.operation.transform that return types with arguments of type Envelope
  Modifier and Type
  Method
  Description
  `Optional<Envelope>`
  AbstractMathTransform.`getDomain(DomainDefinition criteria)`
  Returns the ranges of coordinate values which can be used as inputs.
  `Optional<Envelope>`
  AbstractMathTransform.Inverse.`getDomain(DomainDefinition criteria)`
  Returns the ranges of coordinate values which can be used as inputs.
  `static Optional<Envelope>`
  MathTransforms.`getDomain(MathTransform evaluated)`
  Returns source coordinate values where the transform is mathematically and numerically applicable.
  `Optional<Envelope>`
  DomainDefinition.`result()`
  Returns the domain computed so far by this instance.
  Methods in org.apache.sis.referencing.operation.transform with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `void`
  DomainDefinition.`intersect(Envelope domain)`
  Sets the domain to the intersection of current domain with the specified envelope.
  Method parameters in org.apache.sis.referencing.operation.transform with type arguments of type Envelope
  Modifier and Type
  Method
  Description
  `static MathTransform`
  MathTransforms.`specialize(MathTransform global, Map<Envelope, MathTransform> specializations)`
  Creates a transform defined as one transform applied globally except in sub-areas where more accurate transforms are available.

- ## Uses of Envelope in org.apache.sis.storage

  Methods in org.apache.sis.storage that return types with arguments of type Envelope
  Modifier and Type
  Method
  Description
  `Optional<Envelope>`
  AbstractGridCoverageResource.`getEnvelope()`
  Returns the envelope of the grid geometry if known.
  `Optional<Envelope>`
  AbstractResource.`getEnvelope()`
  Returns the spatiotemporal envelope of this resource.
  `Optional<Envelope>`
  DataSet.`getEnvelope()`
  Returns the spatiotemporal extent of this resource in its most natural coordinate reference system.
  `default Optional<Envelope>`
  GridCoverageResource.`getEnvelope()`
  Returns the spatiotemporal extent of this resource in its most natural coordinate reference system.
  Methods in org.apache.sis.storage with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `static Optional<GridCoverage>`
  DataStores.`readGridCoverage(Object storage, Envelope aoi)`
  Reads immediately the first grid coverage found in the given storage.
  `void`
  CoverageQuery.`setSelection(Envelope domain)`
  Sets the approximate area of cells or pixels to include in the subset.
  `void`
  FeatureQuery.`setSelection(Envelope domain)`
  Sets the approximate area of feature instances to include in the subset.
  `abstract void`
  Query.`setSelection(Envelope domain)`
  Sets the approximate area of feature instances or pixels to include in the subset.

- ## Uses of Envelope in org.apache.sis.storage.tiling

  Methods in org.apache.sis.storage.tiling that return types with arguments of type Envelope
  Modifier and Type
  Method
  Description
  `Optional<Envelope>`
  TileMatrixSet.`getEnvelope()`
  Returns an envelope that encompasses all `TileMatrix` instances in this set.

- ## Uses of Envelope in org.apache.sis.util

  Methods in org.apache.sis.util with parameters of type Envelope
  Modifier and Type
  Method
  Description
  `static void`
  ArgumentChecks.`ensureDimensionMatches(String name, int expected, Envelope envelope)`
  Ensures that the given envelope, if non-null, has the expected number of dimensions.