agi.foundation.geometry.discrete

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

Class LatitudeBoundsCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

agi.foundation.geometry.discrete.LatitudeBoundsCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public class LatitudeBoundsCoverageGrid
extends CentralBodyCoverageGrid

Represents a set of grid points bounded by two lines of planetodetic latitude.

Constructor Summary

Constructors

Constructor and Description
LatitudeBoundsCoverageGrid() Construct a default instance.
LatitudeBoundsCoverageGrid(CentralBody centralBody, double minimumLatitude, double maximumLatitude, double resolution) Construct a new instance based on the given globe and planetodetic latitude bounds in the planet's fixed frame.
LatitudeBoundsCoverageGrid(TerrainProvider terrainProvider, CentralBody centralBody, double minimumLatitude, double maximumLatitude, double resolution) Construct a new instance based on the given terrain and planetodetic latitude bounds.
LatitudeBoundsCoverageGrid(TerrainProvider terrainProvider, double minimumLatitude, double maximumLatitude, double resolution) Construct a new instance based on the given terrain and planetodetic latitude bounds.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Computes the grid points based on the given set of parameters for the planetodetic latitude band.
double	getMaximumLatitude() Gets the north-most planetodetic latitude, in radians, bounding the grid.
double	getMinimumLatitude() Gets the south-most planetodetic latitude, in radians, bounding the 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 is to 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	setMaximumLatitude(double value) Sets the north-most planetodetic latitude, in radians, bounding the grid.
void	setMinimumLatitude(double value) Sets the south-most planetodetic latitude, in radians, bounding the grid.
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 is to 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

LatitudeBoundsCoverageGrid

public LatitudeBoundsCoverageGrid()

Construct a default instance. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

The default CentralBody (get / set) is the EarthCentralBody in the CentralBodiesFacet returned from CentralBodiesFacet.getFromContext(). The default resolution is 5 degrees and the bounds lie within 60 degrees of the equator. The default reference frame is the Earth's fixed frame.

LatitudeBoundsCoverageGrid

public LatitudeBoundsCoverageGrid(@Nonnull
                                  CentralBody centralBody,
                                  double minimumLatitude,
                                  double maximumLatitude,
                                  double resolution)

Construct a new instance based on the given globe and planetodetic latitude bounds in the planet's fixed frame. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

Parameters:

centralBody - The central body on which this grid is defined.

minimumLatitude - The south-most planetodetic latitude bounding the grid, in radians.

maximumLatitude - The north-most planetodetic latitude bounding the grid, in radians.

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

Throws:

ArgumentOutOfRangeException - Thrown if either latitude is outside the range from -pi/2 to pi/2, or the resolution is less than or equal to 0.

ArgumentNullException - Thrown if centralBody is null.

LatitudeBoundsCoverageGrid

public LatitudeBoundsCoverageGrid(@Nonnull
                                  TerrainProvider terrainProvider,
                                  double minimumLatitude,
                                  double maximumLatitude,
                                  double resolution)

Construct a new instance based on the given terrain and planetodetic latitude bounds. 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.

minimumLatitude - The south-most planetodetic latitude bounding the grid, in radians.

maximumLatitude - The north-most planetodetic latitude bounding the grid, in radians.

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

Throws:

ArgumentOutOfRangeException - Thrown if either latitude is outside the range from -pi/2 to pi/2, or the resolution is less than or equal to 0.

ArgumentNullException - Thrown when terrainProvider is null.

LatitudeBoundsCoverageGrid

public LatitudeBoundsCoverageGrid(@Nonnull
                                  TerrainProvider terrainProvider,
                                  @Nonnull
                                  CentralBody centralBody,
                                  double minimumLatitude,
                                  double maximumLatitude,
                                  double resolution)

Construct a new instance based on the given terrain and planetodetic latitude bounds. 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 central body on which this grid is defined.

minimumLatitude - The south-most planetodetic latitude bounding the grid, in radians.

maximumLatitude - The north-most planetodetic latitude bounding the grid, in radians.

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

Throws:

ArgumentOutOfRangeException - Thrown if either latitude is outside the range from -pi/2 to pi/2, or the resolution is less than or equal to 0.

ArgumentNullException - Thrown if terrainProvider or centralBody is null.

Method Detail

getMinimumLatitude

public final double getMinimumLatitude()

Gets the south-most planetodetic latitude, in radians, bounding the grid.

Throws:

ArgumentOutOfRangeException - Thrown if the latitude is set outside the range from -pi/2 to pi/2.

setMinimumLatitude

public final void setMinimumLatitude(double value)

Sets the south-most planetodetic latitude, in radians, bounding the grid.

Throws:

ArgumentOutOfRangeException - Thrown if the latitude is set outside the range from -pi/2 to pi/2.

getMaximumLatitude

public final double getMaximumLatitude()

Gets the north-most planetodetic latitude, in radians, bounding the grid.

Throws:

ArgumentOutOfRangeException - Thrown if the latitude is set outside the range from -pi/2 to pi/2.

setMaximumLatitude

public final void setMaximumLatitude(double value)

Sets the north-most planetodetic latitude, in radians, bounding the grid.

Throws:

ArgumentOutOfRangeException - Thrown if the latitude is set outside the range from -pi/2 to pi/2.

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 is to save grid cell information.

setSaveGridCell

public final void setSaveGridCell(boolean value)

Sets a value indicating whether the grid is to save grid cell information.

generateGridPoints

public List<CoverageGridPoint> generateGridPoints()

Computes the grid points based on the given set of parameters for the planetodetic latitude band. The boundary for this band is exclusive. The resolution specifies the granularity in both latitude and longitude, and 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 MinimumLatitude (get / set) is greater than MaximumLatitude (get / set).

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.