agi.foundation.geometry.discrete

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

Class SpheroidCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.GeometricPrimitiveCoverageGrid

agi.foundation.geometry.discrete.SpheroidCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class SpheroidCoverageGrid
extends GeometricPrimitiveCoverageGrid

A spheroid grid in spherical coordinates with the center at (0,0,0), the axis defined as right-handed at that location with positive z pointing north.

The weight of each grid point defaults to 1. The optional grid cell bounds are of the type, SphericalBounds where the clock angle is the azimuthal angle, the cone angle is the polar angle and the magnitude is the radius.

Constructor Summary

Constructors

Constructor and Description
SpheroidCoverageGrid(Bounds clockAngleBounds, Bounds coneAngleBounds, Bounds radialBounds, ICoverageGriddingTechnique clockAngleGriddingTechnique, ICoverageGriddingTechnique coneAngleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a spheroid grid with the specified parameters.
SpheroidCoverageGrid(double radius, double clockAngleResolution, double coneAngleResolution, double radialResolution, ReferenceFrame frame) Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
SpheroidCoverageGrid(double radius, double clockAngleResolution, double coneAngleResolution, double radialResolution, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
SpheroidCoverageGrid(double radius, ICoverageGriddingTechnique clockAngleGriddingTechnique, ICoverageGriddingTechnique coneAngleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ReferenceFrame frame) Initializes a spheroid grid with the specified parameters.
SpheroidCoverageGrid(double radius, ICoverageGriddingTechnique clockAngleGriddingTechnique, ICoverageGriddingTechnique coneAngleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a spheroid grid with the specified parameters.
SpheroidCoverageGrid(double radius, int numberOfClockAnglePoints, int numberOfConeAnglePoints, int numberOfRadialPoints, ReferenceFrame frame) Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedNumberOfPointsCoverageGriddingTechnique.
SpheroidCoverageGrid(double radius, int numberOfClockAnglePoints, int numberOfConeAnglePoints, int numberOfRadialPoints, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedNumberOfPointsCoverageGriddingTechnique.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Generate the set of grid points.
Bounds	getClockAngleBounds() Gets the clock angle (azimuthal) bounds.
ICoverageGriddingTechnique	getClockAngleGriddingTechnique() Gets the gridding technique used in the clock (azimuthal) coordinate.
Bounds	getConeAngleBounds() Gets the cone angle (polar) bounds.
ICoverageGriddingTechnique	getConeAngleGriddingTechnique() Gets the gridding technique used in the cone (polar) coordinate.
Bounds	getRadialBounds() Gets the radial bounds, which must be positive.
ICoverageGriddingTechnique	getRadialGriddingTechnique() Gets the gridding technique used in the radius coordinate.
boolean	getSaveGridCell() Gets a value indicating whether the grid is to save grid cell information.
boolean	getUseCellVolumeForWeight() Gets a value indicating whether to use the volume of the grid cells as the weight for each point.
void	setClockAngleBounds(Bounds value) Sets the clock angle (azimuthal) bounds.
void	setClockAngleGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the clock (azimuthal) coordinate.
void	setConeAngleBounds(Bounds value) Sets the cone angle (polar) bounds.
void	setConeAngleGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the cone (polar) coordinate.
void	setRadialBounds(Bounds value) Sets the radial bounds, which must be positive.
void	setRadialGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the radius coordinate.
void	setSaveGridCell(boolean value) Sets a value indicating whether the grid is to save grid cell information.
void	setUseCellVolumeForWeight(boolean value) Sets a value indicating whether to use the volume of the grid cells as the weight for each point.

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

getGridPointRange, getGridPointRangeWithWrapping, getReferenceFrame, setReferenceFrame

Methods inherited from class java.lang.Object

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

Constructor Detail

SpheroidCoverageGrid

public SpheroidCoverageGrid(double radius,
                            int numberOfClockAnglePoints,
                            int numberOfConeAnglePoints,
                            int numberOfRadialPoints,
                            ReferenceFrame frame)

Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedNumberOfPointsCoverageGriddingTechnique. UseCellVolumeForWeight (get / set) and SaveGridCell (get / set) are both set to false.

Parameters:

radius - The radius of the spheroid.

numberOfClockAnglePoints - The number of points in the azimuth coordinate.

numberOfConeAnglePoints - The number of points in the polar coordinate.

numberOfRadialPoints - The number of points in the radius coordinate.

frame - The reference frame of the grid.

SpheroidCoverageGrid

public SpheroidCoverageGrid(double radius,
                            int numberOfClockAnglePoints,
                            int numberOfConeAnglePoints,
                            int numberOfRadialPoints,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedNumberOfPointsCoverageGriddingTechnique.

Parameters:

radius - The radius of the spheroid.

numberOfClockAnglePoints - The number of points in the azimuth coordinate.

numberOfConeAnglePoints - The number of points in the polar coordinate.

numberOfRadialPoints - The number of points in the radius coordinate.

frame - The reference frame of the grid.

useCellVolumeForWeight - A boolean that specifies if the volume of each cell should be used as that cell's weight.

saveGridCell - A boolean that specifies if the grid point's cell should be saved.

SpheroidCoverageGrid

public SpheroidCoverageGrid(double radius,
                            double clockAngleResolution,
                            double coneAngleResolution,
                            double radialResolution,
                            ReferenceFrame frame)

Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10. UseCellVolumeForWeight (get / set) and SaveGridCell (get / set) are both set to false.

Parameters:

radius - The radius of the spheroid.

clockAngleResolution - The minimum spacing in the azimuth coordinate.

coneAngleResolution - The minimum spacing in the polar coordinate.

radialResolution - The minimum spacing in the radius coordinate.

frame - The reference frame of the grid.

SpheroidCoverageGrid

public SpheroidCoverageGrid(double radius,
                            double clockAngleResolution,
                            double coneAngleResolution,
                            double radialResolution,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

Initializes a spheroid grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.

Parameters:

radius - The radius of the spheroid.

clockAngleResolution - The minimum spacing in the azimuth coordinate.

coneAngleResolution - The minimum spacing in the polar coordinate.

radialResolution - The minimum spacing in the radius coordinate.

frame - The reference frame of the grid.

useCellVolumeForWeight - A boolean that specifies if the volume of each cell should be used as that cell's weight.

saveGridCell - A boolean that specifies if the grid point's cell should be saved.

SpheroidCoverageGrid

public SpheroidCoverageGrid(double radius,
                            ICoverageGriddingTechnique clockAngleGriddingTechnique,
                            ICoverageGriddingTechnique coneAngleGriddingTechnique,
                            ICoverageGriddingTechnique radialGriddingTechnique,
                            ReferenceFrame frame)

Initializes a spheroid grid with the specified parameters. UseCellVolumeForWeight (get / set) and SaveGridCell (get / set) are both set to false.

Parameters:

radius - The radius of the spheroid.

clockAngleGriddingTechnique - The gridding technique used in the azimuth coordinate.

coneAngleGriddingTechnique - The gridding technique used in the polar coordinate.

radialGriddingTechnique - The gridding technique used in the radius coordinate.

frame - The reference frame of the grid.

SpheroidCoverageGrid

public SpheroidCoverageGrid(double radius,
                            ICoverageGriddingTechnique clockAngleGriddingTechnique,
                            ICoverageGriddingTechnique coneAngleGriddingTechnique,
                            ICoverageGriddingTechnique radialGriddingTechnique,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

Initializes a spheroid grid with the specified parameters.

Parameters:

radius - The radius of the spheroid.

clockAngleGriddingTechnique - The gridding technique used in the azimuth coordinate.

coneAngleGriddingTechnique - The gridding technique used in the polar coordinate.

radialGriddingTechnique - The gridding technique used in the radius coordinate.

frame - The reference frame of the grid.

useCellVolumeForWeight - A boolean that specifies if the volume of each cell should be used as that cell's weight.

saveGridCell - A boolean that specifies if the grid point's cell should be saved.

SpheroidCoverageGrid

public SpheroidCoverageGrid(@Nonnull
                            Bounds clockAngleBounds,
                            @Nonnull
                            Bounds coneAngleBounds,
                            @Nonnull
                            Bounds radialBounds,
                            ICoverageGriddingTechnique clockAngleGriddingTechnique,
                            ICoverageGriddingTechnique coneAngleGriddingTechnique,
                            ICoverageGriddingTechnique radialGriddingTechnique,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

Initializes a spheroid grid with the specified parameters.

Parameters:

clockAngleBounds - The bounds for the clock (azimuthal) angle.

coneAngleBounds - The bounds for the cone (polar) angle.

radialBounds - The bounds for the radius.

clockAngleGriddingTechnique - The gridding technique used in the azimuth coordinate.

coneAngleGriddingTechnique - The gridding technique used in the polar coordinate.

radialGriddingTechnique - The gridding technique used in the radius coordinate.

frame - The reference frame of the grid.

useCellVolumeForWeight - A boolean that specifies if the volume of each cell should be used as that cell's weight.

saveGridCell - A boolean that specifies if the grid point's cell should be saved.

Method Detail

getUseCellVolumeForWeight

public final boolean getUseCellVolumeForWeight()

Gets a value indicating whether to use the volume of the grid cells as the weight for each point.

setUseCellVolumeForWeight

public final void setUseCellVolumeForWeight(boolean value)

Sets a value indicating whether to use the volume of the grid cells as the weight for each point.

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.

getRadialBounds

@Nonnull
public final Bounds getRadialBounds()

Gets the radial bounds, which must be positive.

setRadialBounds

public final void setRadialBounds(@Nonnull
                                  Bounds value)

Sets the radial bounds, which must be positive.

getClockAngleBounds

@Nonnull
public final Bounds getClockAngleBounds()

Gets the clock angle (azimuthal) bounds. The clock angle bounds define the closed set of values between LowerBound (get) and UpperBound (get) where UpperBound (get) is mapped to the interval [lower bound, lower bound + Constants.TwoPi].

setClockAngleBounds

public final void setClockAngleBounds(@Nonnull
                                      Bounds value)

Sets the clock angle (azimuthal) bounds. The clock angle bounds define the closed set of values between LowerBound (get) and UpperBound (get) where UpperBound (get) is mapped to the interval [lower bound, lower bound + Constants.TwoPi].

getConeAngleBounds

@Nonnull
public final Bounds getConeAngleBounds()

Gets the cone angle (polar) bounds. The bounds must fall between 0 and pi.

setConeAngleBounds

public final void setConeAngleBounds(@Nonnull
                                     Bounds value)

Sets the cone angle (polar) bounds. The bounds must fall between 0 and pi.

getRadialGriddingTechnique

public final ICoverageGriddingTechnique getRadialGriddingTechnique()

Gets the gridding technique used in the radius coordinate.

setRadialGriddingTechnique

public final void setRadialGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the radius coordinate.

getClockAngleGriddingTechnique

public final ICoverageGriddingTechnique getClockAngleGriddingTechnique()

Gets the gridding technique used in the clock (azimuthal) coordinate.

setClockAngleGriddingTechnique

public final void setClockAngleGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the clock (azimuthal) coordinate.

getConeAngleGriddingTechnique

public final ICoverageGriddingTechnique getConeAngleGriddingTechnique()

Gets the gridding technique used in the cone (polar) coordinate.

setConeAngleGriddingTechnique

public final void setConeAngleGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the cone (polar) coordinate.

generateGridPoints

public List<CoverageGridPoint> generateGridPoints()

Generate the set of grid points.

When implementing, note that the space represented by each grid point should not overlap.

Specified by:

generateGridPoints in interface ICoverageGrid

Specified by:

generateGridPoints in class GeometricPrimitiveCoverageGrid

Returns:

The set of grid points.

Throws:

PropertyInvalidException - Thrown if any of the following are null- ReferenceFrame (get / set), RadialGriddingTechnique (get / set), ClockAngleGriddingTechnique (get / set), ConeAngleGriddingTechnique (get / set). Thrown if ConeAngleBounds (get / set) is not between 0 and pi. Also thrown if RadialBounds (get / set) are not positive.