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

Packages that use GridCoverage
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.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.

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

  Methods in org.apache.sis.coverage that return GridCoverage
  Modifier and Type
  Method
  Description
  `GridCoverage`
  CoverageCombiner.`result()`
  Returns the combination of destination coverage with all coverages specified to `CoverageCombiner` methods.
  Methods in org.apache.sis.coverage with parameters of type GridCoverage
  Modifier and Type
  Method
  Description
  `boolean`
  CoverageCombiner.`acceptAll(GridCoverage... sources)`
  Writes the given coverages on top of the destination coverage.
  Constructors in org.apache.sis.coverage with parameters of type GridCoverage
  Modifier
  Constructor
  Description
  ``
  `CoverageCombiner(GridCoverage destination)`
  Creates a coverage combiner which will write in the given coverage.

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

  Subclasses of GridCoverage in org.apache.sis.coverage.grid
  Modifier and Type
  Class
  Description
  `class`
  `BufferedGridCoverage`
  Basic access to grid data values backed by a n-dimensional `DataBuffer`.
  `class`
  `GridCoverage2D`
  Basic access to grid data values backed by a two-dimensional `RenderedImage`.
  Classes in org.apache.sis.coverage.grid that implement interfaces with type arguments of type GridCoverage
  Modifier and Type
  Class
  Description
  `class`
  `DimensionalityReduction`
  Description about how to reduce the number of dimensions of the domain of a grid coverage.
  Methods in org.apache.sis.coverage.grid that return GridCoverage
  Modifier and Type
  Method
  Description
  `GridCoverage`
  GridCoverageProcessor.`aggregateRanges(GridCoverage... sources)`
  Aggregates in a single coverage the ranges of all specified coverages, in order.
  `GridCoverage`
  GridCoverageProcessor.`aggregateRanges(GridCoverage[] sources, int[][] bandsPerSource)`
  Aggregates in a single coverage the specified bands of a sequence of source coverages, in order.
  `GridCoverage`
  GridCoverageProcessor.`appendDimension(GridCoverage source, double lower, double span, SingleCRS crs)`
  Appends a single grid dimension after the dimensions of the given source coverage.
  `GridCoverage`
  GridCoverageProcessor.`appendDimension(GridCoverage source, Instant lower, Duration span)`
  Appends a temporal grid dimension after the dimensions of the given source coverage.
  `GridCoverage`
  GridCoverageProcessor.`appendDimensions(GridCoverage source, GridGeometry dimToAdd)`
  Appends the specified grid dimensions after the dimensions of the given source coverage.
  `GridCoverage`
  DimensionalityReduction.`apply(GridCoverage source)`
  Returns a grid coverage on which dimensionality reduction of the domain has been applied.
  `GridCoverage`
  DomainLinearizer.`apply(GridCoverage coverage)`
  Returns a grid coverage with a linear approximation of the grid to CRS conversion.
  `GridCoverage`
  GridCoverageBuilder.`build()`
  Creates the grid coverage from the domain, ranges and values given to setter methods.
  `GridCoverage`
  GridCoverageProcessor.`clip(GridCoverage source, GridExtent clip)`
  Returns the intersection of the given coverage with the given extent.
  `GridCoverage`
  GridCoverageProcessor.`convert(GridCoverage source, MathTransform1D[] converters, Function<SampleDimension.Builder, SampleDimension> sampleDimensionModifier)`
  Returns a coverage with sample values converted by the given functions.
  `protected GridCoverage`
  GridCoverage.`createConvertedValues(boolean converted)`
  Creates the grid coverage instance for the converted or packed values.
  `protected GridCoverage`
  GridCoverage2D.`createConvertedValues(boolean converted)`
  Creates a grid coverage that contains real values or sample values, depending if `converted` is `true` or `false` respectively.
  `GridCoverage`
  GridCoverage.`forConvertedValues(boolean converted)`
  Returns a grid coverage that contains real values or sample values, depending if `converted` is `true` or `false` respectively.
  `GridCoverage`
  GridCoverage.Evaluator.`getCoverage()`
  Returns the grid coverage from which this evaluator is computing sample values.
  `GridCoverage`
  GridCoverageProcessor.`mask(GridCoverage source, RegionOfInterest mask, boolean maskInside)`
  Applies a mask defined by a region of interest (ROI).
  `GridCoverage`
  GridCoverageProcessor.`reduceDimensionality(GridCoverage source)`
  Automatically reduces a grid coverage dimensionality by removing all grid axes with an extent size of 1.
  `GridCoverage`
  GridCoverageProcessor.`removeGridDimensions(GridCoverage source, int... gridAxesToRemove)`
  Creates a coverage trimmed from the specified grid dimensions.
  `GridCoverage`
  GridCoverageProcessor.`resample(GridCoverage source, GridGeometry target)`
  Creates a new coverage with a different grid extent, resolution or coordinate reference system.
  `GridCoverage`
  GridCoverageProcessor.`resample(GridCoverage source, CoordinateReferenceSystem target)`
  Creates a new coverage with a different coordinate reference system.
  `GridCoverage`
  GridCoverageProcessor.`selectGridDimensions(GridCoverage source, int... gridAxesToPass)`
  Creates a coverage containing only the specified grid dimensions.
  `GridCoverage`
  GridCoverageProcessor.`selectSampleDimensions(GridCoverage source, int... bands)`
  Selects a subset of sample dimensions (bands) in the given coverage.
  `GridCoverage`
  GridCoverageProcessor.`shiftGrid(GridCoverage source, long... translation)`
  Translates grid coordinates by the given number of cells without changing "real world" coordinates.
  Methods in org.apache.sis.coverage.grid with parameters of type GridCoverage
  Modifier and Type
  Method
  Description
  `GridCoverage`
  GridCoverageProcessor.`aggregateRanges(GridCoverage... sources)`
  Aggregates in a single coverage the ranges of all specified coverages, in order.
  `GridCoverage`
  GridCoverageProcessor.`aggregateRanges(GridCoverage[] sources, int[][] bandsPerSource)`
  Aggregates in a single coverage the specified bands of a sequence of source coverages, in order.
  `GridCoverage`
  GridCoverageProcessor.`appendDimension(GridCoverage source, double lower, double span, SingleCRS crs)`
  Appends a single grid dimension after the dimensions of the given source coverage.
  `GridCoverage`
  GridCoverageProcessor.`appendDimension(GridCoverage source, Instant lower, Duration span)`
  Appends a temporal grid dimension after the dimensions of the given source coverage.
  `GridCoverage`
  GridCoverageProcessor.`appendDimensions(GridCoverage source, GridGeometry dimToAdd)`
  Appends the specified grid dimensions after the dimensions of the given source coverage.
  `GridCoverage`
  DimensionalityReduction.`apply(GridCoverage source)`
  Returns a grid coverage on which dimensionality reduction of the domain has been applied.
  `GridCoverage`
  DomainLinearizer.`apply(GridCoverage coverage)`
  Returns a grid coverage with a linear approximation of the grid to CRS conversion.
  `GridCoverage`
  GridCoverageProcessor.`clip(GridCoverage source, GridExtent clip)`
  Returns the intersection of the given coverage with the given extent.
  `GridCoverage`
  GridCoverageProcessor.`convert(GridCoverage source, MathTransform1D[] converters, Function<SampleDimension.Builder, SampleDimension> sampleDimensionModifier)`
  Returns a coverage with sample values converted by the given functions.
  `GridCoverage`
  GridCoverageProcessor.`mask(GridCoverage source, RegionOfInterest mask, boolean maskInside)`
  Applies a mask defined by a region of interest (ROI).
  `GridCoverage`
  GridCoverageProcessor.`reduceDimensionality(GridCoverage source)`
  Automatically reduces a grid coverage dimensionality by removing all grid axes with an extent size of 1.
  `GridCoverage`
  GridCoverageProcessor.`removeGridDimensions(GridCoverage source, int... gridAxesToRemove)`
  Creates a coverage trimmed from the specified grid dimensions.
  `GridCoverage`
  GridCoverageProcessor.`resample(GridCoverage source, GridGeometry target)`
  Creates a new coverage with a different grid extent, resolution or coordinate reference system.
  `GridCoverage`
  GridCoverageProcessor.`resample(GridCoverage source, CoordinateReferenceSystem target)`
  Creates a new coverage with a different coordinate reference system.
  `GridCoverage`
  GridCoverageProcessor.`selectGridDimensions(GridCoverage source, int... gridAxesToPass)`
  Creates a coverage containing only the specified grid dimensions.
  `GridCoverage`
  GridCoverageProcessor.`selectSampleDimensions(GridCoverage source, int... bands)`
  Selects a subset of sample dimensions (bands) in the given coverage.
  `GridCoverage`
  GridCoverageProcessor.`shiftGrid(GridCoverage source, long... translation)`
  Translates grid coordinates by the given number of cells without changing "real world" coordinates.
  `RenderedImage`
  GridCoverageProcessor.`visualize(GridCoverage source, GridExtent slice)`
  Renders the given grid coverage as an image suitable for displaying purpose.
  Constructors in org.apache.sis.coverage.grid with parameters of type GridCoverage
  Modifier
  Constructor
  Description
  ``
  `GridCoverage2D(GridCoverage source, RenderedImage data)`
  Constructs a grid coverage using the same domain and range than the given coverage, but different data.
  ``
  `ImageRenderer(GridCoverage coverage, GridExtent sliceExtent)`
  Creates a new image renderer for the given slice extent.

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

  Fields in org.apache.sis.gui.coverage with type parameters of type GridCoverage
  Modifier and Type
  Field
  Description
  `final ObjectProperty<GridCoverage>`
  CoverageCanvas.`coverageProperty`
  The data shown in this canvas.
  `final ObjectProperty<GridCoverage>`
  CoverageExplorer.`coverageProperty`
  The data shown in this canvas.
  Methods in org.apache.sis.gui.coverage that return GridCoverage
  Modifier and Type
  Method
  Description
  `final GridCoverage`
  CoverageCanvas.`getCoverage()`
  Returns the source of image for this viewer.
  `final GridCoverage`
  CoverageExplorer.`getCoverage()`
  Returns the source of sample values for this explorer.
  Methods in org.apache.sis.gui.coverage that return types with arguments of type GridCoverage
  Modifier and Type
  Method
  Description
  `final Optional<GridCoverage>`
  ImageRequest.`getCoverage()`
  Returns the coverage specified at construction time, or an empty value if none.
  Methods in org.apache.sis.gui.coverage with parameters of type GridCoverage
  Modifier and Type
  Method
  Description
  `final void`
  CoverageCanvas.`setCoverage(GridCoverage coverage)`
  Sets the coverage to show in this viewer.
  `final void`
  CoverageExplorer.`setCoverage(GridCoverage coverage)`
  Sets the coverage to show in this explorer.
  Constructors in org.apache.sis.gui.coverage with parameters of type GridCoverage
  Modifier
  Constructor
  Description
  ``
  `ImageRequest(GridCoverage source, GridExtent slice)`
  Creates a new request for loading an image from the specified coverage.

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

  Methods in org.apache.sis.storage that return GridCoverage
  Modifier and Type
  Method
  Description
  `GridCoverage`
  GridCoverageResource.`read(GridGeometry domain, int... ranges)`
  Loads a subset of the grid coverage represented by this resource.
  Methods in org.apache.sis.storage that return types with arguments of type GridCoverage
  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.
  Methods in org.apache.sis.storage with parameters of type GridCoverage
  Modifier and Type
  Method
  Description
  `void`
  WritableGridCoverageResource.`write(GridCoverage coverage, WritableGridCoverageResource.Option... options)`
  Writes a new coverage in the data store for this resource.

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

  Methods in org.apache.sis.storage.aggregate with parameters of type GridCoverage
  Modifier and Type
  Method
  Description
  `void`
  CoverageAggregator.`add(GridCoverage coverage)`
  Adds the given coverage.
  `void`
  CoverageAggregator.`add(GridCoverage coverage, double lower, double span, SingleCRS crs)`
  Adds the given coverage augmented with a single grid dimension.
  `void`
  CoverageAggregator.`add(GridCoverage coverage, Instant lower, Duration span)`
  Adds the given coverage augmented with a single temporal grid dimension.
  `void`
  CoverageAggregator.`add(GridCoverage coverage, GridGeometry dimToAdd)`
  Adds the given coverage augmented with the specified grid dimensions.

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

  Methods in org.apache.sis.storage.geotiff with parameters of type GridCoverage
  Modifier and Type
  Method
  Description
  `GridCoverageResource`
  GeoTiffStore.`append(GridCoverage coverage, Metadata metadata)`
  Adds a new grid coverage in the GeoTIFF file.