agi.foundation.geometry.discrete

(agi.foundation.spatial-2024r3.jar)

Class GlobalCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

agi.foundation.geometry.discrete.GlobalCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public class GlobalCoverageGrid
extends CentralBodyCoverageGrid

Represents a set of grid points spanning the entire globe of the specified CentralBody (get / set).

Constructor Summary

Constructors

Constructor and Description
GlobalCoverageGrid() Construct a new default instance based on Earth at 5 degrees (approximately 0.087 radians) resolution.
GlobalCoverageGrid(CentralBody centralBody, double resolution) Initializes a new instance based on the given central body, in the central body's fixed frame at the input resolution.
GlobalCoverageGrid(TerrainProvider terrainProvider, CentralBody centralBody, double resolution) Initializes a new instance based on the given terrain.
GlobalCoverageGrid(TerrainProvider terrainProvider, double resolution) Initializes a new instance based on the given terrain.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Produces the grid points based on the given set of parameters for the global grid.
double	getResolution() Gets the requested resolution, in radians, representing the maximum angular spacing between grid points.
boolean	getSaveGridCell() Gets a value indicating whether the grid should save grid cell information.
boolean	getUseCellSurfaceAreaForWeight() Gets a value indicating whether to use the surface area of the grid cells as the weight for each point, otherwise a value of 1 is used.
void	setResolution(double value) Sets the requested resolution, in radians, representing the maximum angular spacing between grid points.
void	setSaveGridCell(boolean value) Sets a value indicating whether the grid should save grid cell information.
void	setUseCellSurfaceAreaForWeight(boolean value) Sets a value indicating whether to use the surface area of the grid cells as the weight for each point, otherwise a value of 1 is used.

Methods inherited from class agi.foundation.geometry.discrete.CentralBodyCoverageGrid

getCentralBody, getGridCellBoundaries, getGridCellBoundary, getHeightRelativeToSurface, getReferenceFrame, getReferenceTerrain, setCentralBody, setReferenceTerrain

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlobalCoverageGrid

public GlobalCoverageGrid()

Construct a new default instance based on Earth at 5 degrees (approximately 0.087 radians) resolution.

The default CentralBody (get / set) is the EarthCentralBody acquired via CentralBodiesFacet.getFromContext(). The default resolution is 5 degrees (approximately 0.087 radians). Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

GlobalCoverageGrid

public GlobalCoverageGrid(@Nonnull
                          CentralBody centralBody,
                          double resolution)

Initializes a new instance based on the given central body, in the central body's fixed frame at the input resolution. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

Parameters:

centralBody - The CentralBody (get / set) representing the globe.

resolution - The requested resolution, in radians, representing an upper bound to the angular spacing between grid points.

Throws:

ArgumentOutOfRangeException - Thrown if the resolution is set to less than or equal to 0.

GlobalCoverageGrid

public GlobalCoverageGrid(@Nonnull
                          TerrainProvider terrainProvider,
                          double resolution)

Initializes a new instance based on the given terrain. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

Parameters:

terrainProvider - The TerrainProvider used to generate the height of the grid points.

resolution - The requested resolution, in radians, representing an upper bound to the angular spacing between grid points.

Throws:

ArgumentOutOfRangeException - Thrown if the resolution is set to less than or equal to 0.

ArgumentNullException - Thrown when terrainProvider is null.

GlobalCoverageGrid

public GlobalCoverageGrid(@Nonnull
                          TerrainProvider terrainProvider,
                          @Nonnull
                          CentralBody centralBody,
                          double resolution)

Initializes a new instance based on the given terrain. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

Parameters:

terrainProvider - The TerrainProvider used to generate the height of the grid points.

centralBody - The CentralBody (get / set) representing the globe.

resolution - The requested resolution, in radians, representing an upper bound to the angular spacing between grid points.

Throws:

ArgumentOutOfRangeException - Thrown if the resolution is set to less than or equal to 0.

ArgumentNullException - Thrown if terrainProvider or centralBody is null.

Method Detail

getResolution

public final double getResolution()

Gets the requested resolution, in radians, representing the maximum angular spacing between grid points.

Throws:

ArgumentOutOfRangeException - Thrown if the resolution is set to less than or equal to 0.

setResolution

public final void setResolution(double value)

Sets the requested resolution, in radians, representing the maximum angular spacing between grid points.

Throws:

ArgumentOutOfRangeException - Thrown if the resolution is set to less than or equal to 0.

getUseCellSurfaceAreaForWeight

public final boolean getUseCellSurfaceAreaForWeight()

Gets a value indicating whether to use the surface area of the grid cells as the weight for each point, otherwise a value of 1 is used.

setUseCellSurfaceAreaForWeight

public final void setUseCellSurfaceAreaForWeight(boolean value)

Sets a value indicating whether to use the surface area of the grid cells as the weight for each point, otherwise a value of 1 is used.

getSaveGridCell

public final boolean getSaveGridCell()

Gets a value indicating whether the grid should save grid cell information.

setSaveGridCell

public final void setSaveGridCell(boolean value)

Sets a value indicating whether the grid should save grid cell information.

generateGridPoints

public List<CoverageGridPoint> generateGridPoints()

Produces the grid points based on the given set of parameters for the global grid. The resolution will be increased slightly in each coordinate in order to evenly divide the coordinate's angular span. The granularity in longitude is also adjusted downwards to approximately preserve the surface area covered by each grid point, relative to the surface area each point covers near the equator, as either pole is approached.

If ReferenceTerrain (get / set) is configured, the heights of the grid points are determined by that TerrainProvider. Note that the type of Point used for the location in the returned GridPoints are PointCartographic.

Specified by:

generateGridPoints in interface ICoverageGrid

Specified by:

generateGridPoints in class CentralBodyCoverageGrid

Returns:

The grid points.

Throws:

IllegalStateException - Thrown if ReferenceTerrain (get / set) is configured and its shape doesn't match CentralBody (get / set) shape.

PropertyInvalidException - Thrown if ReferenceFrame (get) or CentralBody (get / set) is null.