agi.foundation.geometry.discrete

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

Class LongitudeLineCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

agi.foundation.geometry.discrete.LongitudeLineCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public class LongitudeLineCoverageGrid
extends CentralBodyCoverageGrid

Represents a set of grid points along a line of longitude.

Constructor Summary

Constructors

Constructor and Description
LongitudeLineCoverageGrid() Construct a default instance representing the prime meridian.
LongitudeLineCoverageGrid(CentralBody centralBody, double longitude, double minimumLatitude, double maximumLatitude, double resolution) Construct a new instance based on the given central body and latitude bounds.
LongitudeLineCoverageGrid(TerrainProvider terrainProvider, CentralBody centralBody, double longitude, double minimumLatitude, double maximumLatitude, double resolution) Construct a new instance based on the given terrain and latitude bounds.
LongitudeLineCoverageGrid(TerrainProvider terrainProvider, double longitude, double minimumLatitude, double maximumLatitude, double resolution) Construct a new instance based on the given terrain and 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 longitude line.
double	getLongitude() Gets the longitude of the line, in radians.
double	getMaximumLatitude() Gets the north-most planetodetic latitude of the line, in radians.
double	getMinimumLatitude() Gets the south-most planetodetic latitude of the line, in radians.
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	setLongitude(double value) Sets the longitude of the line, in radians.
void	setMaximumLatitude(double value) Sets the north-most planetodetic latitude of the line, in radians.
void	setMinimumLatitude(double value) Sets the south-most planetodetic latitude of the line, in radians.
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

LongitudeLineCoverageGrid

public LongitudeLineCoverageGrid()

Construct a default instance representing the prime meridian.

The default CentralBody (get / set) is the EarthCentralBody in the CentralBodiesFacet returned from CentralBodiesFacet.getFromContext(). The default resolution is 5 degrees. The default reference frame is the Earth's fixed frame. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

LongitudeLineCoverageGrid

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

Construct a new instance based on the given central body and latitude bounds. The reference frame is set to the central body's fixed frame and the shape is set to the central body's shape. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

Parameters:

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

longitude - The longitude of the line, in radians.

minimumLatitude - The south-most planetodetic latitude of the line, in radians.

maximumLatitude - The north-most planetodetic latitude of the line, 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 centralBody is null.

LongitudeLineCoverageGrid

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

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

longitude - The longitude of the line, in radians.

minimumLatitude - The south-most planetodetic latitude of the line, in radians.

maximumLatitude - The north-most planetodetic latitude of the line, 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.

LongitudeLineCoverageGrid

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

Construct a new instance based on the given terrain and latitude bounds. The reference frame is set to the central body's fixed frame and the shape is set to the central body's shape. 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.

longitude - The longitude of the line, in radians.

minimumLatitude - The south-most planetodetic latitude of the line, in radians.

maximumLatitude - The north-most planetodetic latitude of the line, 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

getLongitude

public final double getLongitude()

Gets the longitude of the line, in radians.

setLongitude

public final void setLongitude(double value)

Sets the longitude of the line, in radians.

getMinimumLatitude

public final double getMinimumLatitude()

Gets the south-most planetodetic latitude of the line, in radians.

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 of the line, in radians.

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 of the line, in radians.

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 of the line, in radians.

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 longitude line. The resolution sets the granularity in latitude, and will be adjusted upwards slightly in order to evenly divide the coordinate's angular span.

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.