agi.foundation.geometry.discrete

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

Class SurfaceRegionsCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

agi.foundation.geometry.discrete.SurfaceRegionsCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class SurfaceRegionsCoverageGrid
extends CentralBodyCoverageGrid

Represents a regular grid inside the boundaries of a specified set of surface regions, based on a given resolution.

Constructor Summary

Constructors

Constructor and Description
SurfaceRegionsCoverageGrid(double resolution, CentralBody centralBody, EllipsoidSurfaceRegion... regions) Create a new instance based on a given resolution and a set of polygonal regions.
SurfaceRegionsCoverageGrid(double resolution, CentralBody centralBody, Iterable<? extends EllipsoidSurfaceRegion> regions) Create a new instance based on a given resolution and a set of polygonal regions.
SurfaceRegionsCoverageGrid(double resolution, TerrainProvider terrainProvider, CentralBody centralBody, EllipsoidSurfaceRegion... regions) Create a new instance based on a given TerrainProvider, resolution and a set of polygonal regions.
SurfaceRegionsCoverageGrid(double resolution, TerrainProvider terrainProvider, CentralBody centralBody, Iterable<? extends EllipsoidSurfaceRegion> regions) Create a new instance based on a given TerrainProvider, resolution and a set of polygonal regions.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Generate a list of regularly spaced grid points inside the specified Regions (get).
List<EllipsoidSurfaceRegion>	getRegions() Gets a read-only collection of surface regions which define this 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	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

SurfaceRegionsCoverageGrid

public SurfaceRegionsCoverageGrid(double resolution,
                                  @Nonnull
                                  CentralBody centralBody,
                                  @Nonnull
                                  Iterable<? extends EllipsoidSurfaceRegion> regions)

Create a new instance based on a given resolution and a set of polygonal regions. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

Parameters:

resolution - The resolution, in radians, representing the requested spacing between grid points.

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

regions - The set of polygonal regions which define the grid.

Throws:

IllegalStateException - Thrown if the ReferenceSurfaces of the EllipsoidSurfaceRegions conflict.

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

ArgumentNullException - Thrown if regions or centralBody is null.

SurfaceRegionsCoverageGrid

public SurfaceRegionsCoverageGrid(double resolution,
                                  @Nonnull
                                  CentralBody centralBody,
                                  @Nonnull
                                  EllipsoidSurfaceRegion... regions)

Create a new instance based on a given resolution and a set of polygonal regions. Both SaveGridCell (get / set) and UseCellSurfaceAreaForWeight (get / set) are set to true.

Parameters:

resolution - The resolution, in radians, representing the requested spacing between grid points.

centralBody - The central body on which the grid is defined. The fixed frame of this body is used for the reference frame.

regions - The set of polygonal regions which define the grid.

Throws:

IllegalStateException - Thrown if the ReferenceSurfaces of the EllipsoidSurfaceRegions conflict.

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

ArgumentNullException - Thrown if centralBody or regions is null.

SurfaceRegionsCoverageGrid

public SurfaceRegionsCoverageGrid(double resolution,
                                  @Nonnull
                                  TerrainProvider terrainProvider,
                                  @Nonnull
                                  CentralBody centralBody,
                                  @Nonnull
                                  EllipsoidSurfaceRegion... regions)

Create a new instance based on a given TerrainProvider, resolution and a set of polygonal regions. 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 resolution, in radians, representing the requested spacing between grid points.

centralBody - The central body for this grid.

regions - The set of polygonal regions which define the grid.

Throws:

IllegalStateException - Thrown if the ReferenceSurfaces of the TerrainProvider conflict with the EllipsoidSurfaceRegions conflict.

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

ArgumentNullException - Thrown if terrainProvider, centralBody, or regions is null.

SurfaceRegionsCoverageGrid

public SurfaceRegionsCoverageGrid(double resolution,
                                  @Nonnull
                                  TerrainProvider terrainProvider,
                                  @Nonnull
                                  CentralBody centralBody,
                                  @Nonnull
                                  Iterable<? extends EllipsoidSurfaceRegion> regions)

Create a new instance based on a given TerrainProvider, resolution and a set of polygonal regions. 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 resolution, in radians, representing the requested spacing between grid points.

centralBody - The central body for this grid.

regions - The set of polygonal regions which define the grid.

Throws:

IllegalStateException - Thrown if the ReferenceSurfaces of the TerrainProvider conflict with the EllipsoidSurfaceRegions conflict.

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

ArgumentNullException - Thrown if regions, terrainProvider, or centralBody is null.

Method Detail

getRegions

@Nonnull
public final List<EllipsoidSurfaceRegion> getRegions()

Gets a read-only collection of surface regions which define this grid. If a point is inside any of the surface regions, it is included in this grid. However, if one of the surface regions is small enough, the generated grid may not have any grid points inside that region.

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()

Generate a list of regularly spaced grid points inside the specified Regions (get). This grid first computes a region that bounds all of the input Regions (get). The algorithm then grids this region, adjusting the resolution upwards slightly in order to evenly divide each coordinate's angular span. Points in this bounding region are then kept if they lie within one of the input regions.

If a TerrainProvider is present, the vertex heights are found using it as well. 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.