# Uses of Class
org.apache.sis.coverage.grid.GridGeometry

Packages that use GridGeometry
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.gui.coverage
Widgets showing `GridCoverage` images or sample values.
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.portrayal
Symbology and map representations, together with a rendering engine for display.
org.apache.sis.storage
Data store base types for retrieving and saving geospatial data in various storage formats.
org.apache.sis.storage.aggregate
Resources which are aggregations or concatenations of other resources.
org.apache.sis.storage.geotiff
A data store that can read and write GeoTIFF files as grid coverages.
org.apache.sis.storage.modifier
A plugin mechanism for modifying some aspects of the resources read by data stores.
org.apache.sis.storage.tiling
Base types for retrieving and saving tiles in resources.

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

  Methods in org.apache.sis.coverage with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `Shape`
  RegionOfInterest.`toShape2D(GridGeometry target)`
  Returns the clip geometry in coordinates of grid cells.

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

  Fields in org.apache.sis.coverage.grid declared as GridGeometry
  Modifier and Type
  Field
  Description
  `protected final GridGeometry`
  GridDerivation.`base`
  The base grid geometry from which to derive a new grid geometry.
  `protected final GridGeometry`
  GridCoverage.`gridGeometry`
  The grid extent, coordinate reference system (CRS) and conversion from cell indices to CRS.
  `static final GridGeometry`
  GridGeometry.`UNDEFINED`
  An "empty" grid geometry with no value defined.
  Methods in org.apache.sis.coverage.grid that return GridGeometry
  Modifier and Type
  Method
  Description
  `GridGeometry`
  DimensionalityReduction.`apply(GridGeometry source)`
  Returns a grid geometry on which dimensionality reduction of the grid extent has been applied.
  `GridGeometry`
  DomainLinearizer.`apply(GridGeometry gg)`
  Creates a grid geometry with a linear approximation of the grid to CRS conversion.
  `GridGeometry`
  GridDerivation.`build()`
  Builds a grid geometry with the configuration specified by the other methods in this `GridDerivation` class.
  `GridGeometry`
  GridCoverage.`getGridGeometry()`
  Returns information about the domain of this grid coverage.
  `GridGeometry`
  GridCoverage2D.`getGridGeometry2D()`
  Returns the two-dimensional part of this grid geometry.
  `GridGeometry`
  ImageRenderer.`getImageGeometry(int dimCRS)`
  Computes the conversion from pixel coordinates to CRS, together with the geospatial envelope of the image.
  `GridGeometry`
  DimensionalityReduction.`getReducedGridGeometry()`
  Returns the grid geometry with only the retained grid axis dimension.
  `GridGeometry`
  DimensionalityReduction.`getSourceGridGeometry()`
  Returns the grid geometry with all grid axis dimension.
  `GridGeometry`
  GridGeometry.`relocate(GridExtent newExtent)`
  Returns a grid geometry with the given grid extent, which implies a new "real world" computation.
  `GridGeometry`
  DimensionalityReduction.`reverse(GridGeometry reduced)`
  Returns a grid geometry on which dimensionality reduction has been reverted.
  `GridGeometry`
  GridGeometry.`selectDimensions(int... indices)`
  Returns a grid geometry that encompass only some dimensions of this grid geometry.
  `final GridGeometry`
  GridGeometry.`shiftGrid(long... translation)`
  Translates grid coordinates by the given number of cells without changing "real world" coordinates.
  `GridGeometry`
  GridGeometry.`shiftGrid(long[] translation, boolean negate)`
  Translates grid coordinates by the given number of cells, optionally in the reverse direction.
  `GridGeometry`
  GridGeometry.`shiftGridToZeros()`
  Translates the grid to lower coordinate values of zero without changing the "real world" coordinates.
  `GridGeometry`
  GridGeometry.`upsample(int[] periods)`
  Deprecated.
  Use the version with `long` integers instead of `int`.
  `GridGeometry`
  GridGeometry.`upsample(long... periods)`
  Creates a new grid geometry upsampled by the given number of cells along each grid dimensions.
  Methods in org.apache.sis.coverage.grid with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `GridCoverage`
  GridCoverageProcessor.`appendDimensions(GridCoverage source, GridGeometry dimToAdd)`
  Appends the specified grid dimensions after the dimensions of the given source coverage.
  `GridGeometry`
  DimensionalityReduction.`apply(GridGeometry source)`
  Returns a grid geometry on which dimensionality reduction of the grid extent has been applied.
  `GridGeometry`
  DomainLinearizer.`apply(GridGeometry gg)`
  Creates a grid geometry with a linear approximation of the grid to CRS conversion.
  `boolean`
  GridGeometry.`contains(GridGeometry other)`
  Returns `true` if this grid geometry contains the given grid geometry within a tolerance of ½ cell.
  `MathTransform`
  GridGeometry.`createTransformTo(GridGeometry target, PixelInCell anchor)`
  Creates a transform from cell coordinates in this grid to cell coordinates in the given grid.
  `GridExtent`
  GridGeometry.`extentOf(GridGeometry other, PixelInCell include, GridRoundingMode rounding)`
  Returns the coordinate range of another grid geometry in units of cells of this grid geometry.
  `boolean`
  GridGeometry.`intersects(GridGeometry other)`
  Returns `true` if this grid geometry intersects the given grid geometry.
  `boolean`
  DimensionalityReduction.`isReduced(GridGeometry candidate)`
  Returns `true` if the given grid geometry is likely to be already reduced.
  `static DimensionalityReduction`
  DimensionalityReduction.`reduce(GridGeometry source)`
  Automatically reduces a grid geometry by removing all grid dimensions with an extent size of 1.
  `static DimensionalityReduction`
  DimensionalityReduction.`remove(GridGeometry source, int... gridAxesToRemove)`
  Reduces the dimension of the specified grid geometry by removing the specified axes.
  `GridCoverage`
  GridCoverageProcessor.`resample(GridCoverage source, GridGeometry target)`
  Creates a new coverage with a different grid extent, resolution or coordinate reference system.
  `GridGeometry`
  DimensionalityReduction.`reverse(GridGeometry reduced)`
  Returns a grid geometry on which dimensionality reduction has been reverted.
  `static DimensionalityReduction`
  DimensionalityReduction.`select(GridGeometry source, int... gridAxesToPass)`
  Reduces the dimension of the specified grid geometry by retaining only the specified axes.
  `static DimensionalityReduction`
  DimensionalityReduction.`select2D(GridGeometry source)`
  A convenience method for selecting the two first dimensions of the specified grid geometry.
  `GridCoverageBuilder`
  GridCoverageBuilder.`setDomain(GridGeometry grid)`
  Sets the domain envelope (including its CRS) and/or the transform from grid indices to domain coordinates.
  `GridDerivation`
  GridDerivation.`subgrid(GridGeometry areaOfInterest)`
  Adapts the base grid for the geographic area and resolution of the given grid geometry.
  Constructors in org.apache.sis.coverage.grid with parameters of type GridGeometry
  Modifier
  Constructor
  Description
  ``
  `BufferedGridCoverage(GridGeometry grid, List<? extends SampleDimension> bands, int dataType)`
  Constructs a grid coverage using the specified grid geometry, sample dimensions and data type.
  ``
  `BufferedGridCoverage(GridGeometry domain, List<? extends SampleDimension> range, DataBuffer data)`
  Constructs a grid coverage using the specified grid geometry, sample dimensions and data buffer.
  `protected`
  `DimensionalityReduction(GridGeometry source, BitSet gridAxes, MathTransformFactory factory)`
  Reduces the dimension of the specified grid geometry by retaining the axes specified in the given bitset.
  `protected`
  `GridCoverage(GridGeometry domain, List<? extends SampleDimension> ranges)`
  Constructs a grid coverage using the specified grid geometry and sample dimensions.
  ``
  `GridCoverage2D(GridGeometry domain, List<? extends SampleDimension> range, RenderedImage data)`
  Constructs a grid coverage using the specified domain, range and data.
  `protected`
  `GridDerivation(GridGeometry base)`
  Creates a new builder for deriving a grid geometry from the specified base.
  `protected`
  `GridGeometry(GridGeometry other)`
  Creates a new grid geometry with the same values as the given grid geometry.
  ``
  `GridGeometry(GridGeometry other, GridExtent extent, MathTransform toOther)`
  Creates a new grid geometry derived from the given grid geometry with a new extent and a modified transform.
  ``
  `GridGeometry(GridGeometry lower, GridGeometry upper)`
  Creates a new grid geometry as the concatenation of the two specified grid geometries.

- ## Uses of GridGeometry in org.apache.sis.gui.coverage

  Fields in org.apache.sis.gui.coverage with type parameters of type GridGeometry
  Modifier and Type
  Field
  Description
  `final ObjectProperty<GridGeometry>`
  GridSliceSelector.`gridGeometry`
  The grid geometry for which to provide sliders.
  Methods in org.apache.sis.gui.coverage that return types with arguments of type GridGeometry
  Modifier and Type
  Method
  Description
  `final Optional<GridGeometry>`
  ImageRequest.`getDomain()`
  Returns the desired grid extent and resolution, or an empty value for reading the full domain.
  Constructors in org.apache.sis.gui.coverage with parameters of type GridGeometry
  Modifier
  Constructor
  Description
  ``
  `ImageRequest(GridCoverageResource source, GridGeometry domain, int... range)`
  Creates a new request for loading an image from the specified resource.

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

  Methods in org.apache.sis.gui.map with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `void`
  StatusBar.`applyCanvasGeometry(GridGeometry geometry)`
  Configures this status bar for showing coordinates in the CRS and with the resolution given by the specified grid geometry.
  `void`
  StatusBar.`applyCanvasGeometry(GridGeometry geometry, GridExtent sliceExtent, int xdim, int ydim)`
  Configures this status bar for showing coordinates of a slice of a grid coverage.
  `protected void`
  MapCanvas.`initialize(GridGeometry visibleArea)`
  Sets the objective bounds and/or the zoom level and objective CRS to use for the initial view of data.

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

  Method parameters in org.apache.sis.gui.referencing with type arguments of type GridGeometry
  Modifier and Type
  Method
  Description
  `void`
  RecentReferenceSystems.`setGridReferencing(boolean replaceByAuthoritativeDefinition, Map<String, GridGeometry> geometries)`
  Sets the reference systems, area of interest and "referencing by grid indices" systems.

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

  Methods in org.apache.sis.portrayal that return GridGeometry
  Modifier and Type
  Method
  Description
  `GridGeometry`
  Canvas.`getGridGeometry()`
  Returns canvas properties (CRS, display bounds, conversion) encapsulated in a grid geometry.
  Methods in org.apache.sis.portrayal with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `void`
  Canvas.`setGridGeometry(GridGeometry newValue)`
  Sets canvas properties from the given grid geometry.

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

  Methods in org.apache.sis.storage that return GridGeometry
  Modifier and Type
  Method
  Description
  `GridGeometry`
  GridCoverageResource.`getGridGeometry()`
  Returns the valid extent of grid coordinates together with the conversion from those grid coordinates to real world coordinates.
  `GridGeometry`
  CoverageQuery.`getSelection()`
  Returns the desired grid extent and resolution.
  Methods in org.apache.sis.storage that return types with arguments of type GridGeometry
  Modifier and Type
  Method
  Description
  `Function<GridGeometry, DimensionalityReduction>`
  CoverageQuery.`getAxisSelection()`
  Returns the dimensionality reduction to apply on coverage domain.
  Methods in org.apache.sis.storage with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `protected DataStoreException`
  AbstractGridCoverageResource.`canNotRead(String filename, GridGeometry request, Throwable cause)`
  Creates an exception for a failure to load data.
  `protected void`
  AbstractGridCoverageResource.`logReadOperation(Object file, GridGeometry domain, long startTime)`
  Logs the execution of a `GridCoverageResource.read(GridGeometry, int...)` operation.
  `GridCoverage`
  GridCoverageResource.`read(GridGeometry domain, int... ranges)`
  Loads a subset of the grid coverage represented by this resource.
  `void`
  CoverageQuery.`setSelection(GridGeometry domain)`
  Sets the desired grid extent and resolution.
  Method parameters in org.apache.sis.storage with type arguments of type GridGeometry
  Modifier and Type
  Method
  Description
  `void`
  CoverageQuery.`setAxisSelection(Function<GridGeometry, DimensionalityReduction> reduction)`
  Requests dimensionality reduction by selecting or removing specified domain axes.

- ## Uses of GridGeometry in org.apache.sis.storage.aggregate

  Methods in org.apache.sis.storage.aggregate with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `void`
  CoverageAggregator.`add(GridCoverage coverage, GridGeometry dimToAdd)`
  Adds the given coverage augmented with the specified grid dimensions.
  `void`
  CoverageAggregator.`add(GridCoverageResource resource, GridGeometry dimToAdd)`
  Adds the given resource augmented with the specified grid dimensions.
  `protected int[]`
  MergeStrategy.`filter(GridGeometry request, GridGeometry[] candidates)`
  Returns the indexes of the coverages to use in the aggregation.

- ## Uses of GridGeometry in org.apache.sis.storage.geotiff

  Methods in org.apache.sis.storage.geotiff with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `GridCoverageResource`
  GeoTiffStore.`append(RenderedImage image, GridGeometry grid, Metadata metadata)`
  Encodes the given image in the GeoTIFF file.

- ## Uses of GridGeometry in org.apache.sis.storage.modifier

  Methods in org.apache.sis.storage.modifier that return GridGeometry
  Modifier and Type
  Method
  Description
  `default GridGeometry`
  CoverageModifier.`customize(CoverageModifier.Source source, GridGeometry domain)`
  Invoked when a grid geometry is created for a coverage.
  Methods in org.apache.sis.storage.modifier with parameters of type GridGeometry
  Modifier and Type
  Method
  Description
  `default GridGeometry`
  CoverageModifier.`customize(CoverageModifier.Source source, GridGeometry domain)`
  Invoked when a grid geometry is created for a coverage.

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

  Methods in org.apache.sis.storage.tiling that return GridGeometry
  Modifier and Type
  Method
  Description
  `GridGeometry`
  TileMatrix.`getTilingScheme()`
  Returns a description about how space is partitioned into individual tiled units.