agi.foundation.geometry.discrete

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

Class ConeCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.GeometricPrimitiveCoverageGrid

agi.foundation.geometry.discrete.ConeCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class ConeCoverageGrid
extends GeometricPrimitiveCoverageGrid

A cone grid with (0,0,0) defined as the apex of the cone. The positive z-axis points from the apex to the base.

The weight of each grid point defaults to 1. The optional grid cell bounds are of the type, CylindricalBounds. In these bounds z is the z coordinate, the clock angle is the angle subtended by a circular slice, and r is the radius of a circular slice.

Constructor Summary

Constructors

Constructor and Description
ConeCoverageGrid(Bounds clockAngleBounds, Bounds baseRadiusBounds, Bounds heightBounds, ICoverageGriddingTechnique angleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cone grid with the specified parameters.
ConeCoverageGrid(double baseRadius, double coneHeight, double angularResolution, double radialResolution, double heightResolution, ReferenceFrame referenceFrame) Initializes a cone grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
ConeCoverageGrid(double baseRadius, double coneHeight, double angularResolution, double radialResolution, double heightResolution, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cone grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
ConeCoverageGrid(double baseRadius, double coneHeight, ICoverageGriddingTechnique angleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cone grid with the specified parameters.
ConeCoverageGrid(double coneBaseRadius, double coneHeight, int numberOfAngularPoints, int numberOfRadialPoints, int numberOfHeightPoints, ReferenceFrame referenceFrame) Initializes a cone grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
ConeCoverageGrid(double baseRadius, double coneHeight, int numberOfAngularPoints, int numberOfRadialPoints, int numberOfHeightPoints, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cone 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	getBaseRadiusBounds() Gets the cone's base radius bounds.
Bounds	getClockAngleBounds() Gets the cone clock angle bounds.
ICoverageGriddingTechnique	getClockAngleGriddingTechnique() Gets the gridding technique used in the clock angle coordinate.
Bounds	getHeightBounds() Gets the height bounds of the cone.
ICoverageGriddingTechnique	getHeightGriddingTechnique() Gets the gridding technique used in the cone's height coordinate.
ICoverageGriddingTechnique	getRadialGriddingTechnique() Gets the gridding technique used in the radial 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	setBaseRadiusBounds(Bounds value) Sets the cone's base radius bounds.
void	setClockAngleBounds(Bounds value) Sets the cone clock angle bounds.
void	setClockAngleGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the clock angle coordinate.
void	setHeightBounds(Bounds value) Sets the height bounds of the cone.
void	setHeightGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the cone's height coordinate.
void	setRadialGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the radial 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

ConeCoverageGrid

public ConeCoverageGrid(double coneBaseRadius,
                        double coneHeight,
                        int numberOfAngularPoints,
                        int numberOfRadialPoints,
                        int numberOfHeightPoints,
                        ReferenceFrame referenceFrame)

Initializes a cone 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:

coneBaseRadius - The radius of the base of the cone.

coneHeight - The height of the cone.

numberOfAngularPoints - The number of points to use in the angle coordinate.

numberOfRadialPoints - The number of points to use in the radial coordinate.

numberOfHeightPoints - The number of points to use in the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this cone is defined.

ConeCoverageGrid

public ConeCoverageGrid(double baseRadius,
                        double coneHeight,
                        int numberOfAngularPoints,
                        int numberOfRadialPoints,
                        int numberOfHeightPoints,
                        ReferenceFrame referenceFrame,
                        boolean useCellVolumeForWeight,
                        boolean saveGridCell)

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

Parameters:

baseRadius - The radius of the base of the cone.

coneHeight - The height of the cone.

numberOfAngularPoints - The number of points to use in the angle coordinate.

numberOfRadialPoints - The number of points to use in the radial coordinate.

numberOfHeightPoints - The number of points to use in the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this cone is defined.

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.

ConeCoverageGrid

public ConeCoverageGrid(double baseRadius,
                        double coneHeight,
                        double angularResolution,
                        double radialResolution,
                        double heightResolution,
                        ReferenceFrame referenceFrame)

Initializes a cone 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:

baseRadius - The radius of the base of the cone.

coneHeight - The height of the cone.

angularResolution - The angular resolution of the cone.

radialResolution - The minimum spacing in the radial coordinate of the cone.

heightResolution - The minimum spacing in the height coordinate of the cone.

referenceFrame - The ReferenceFrame (get / set) in which this cone is defined.

ConeCoverageGrid

public ConeCoverageGrid(double baseRadius,
                        double coneHeight,
                        double angularResolution,
                        double radialResolution,
                        double heightResolution,
                        ReferenceFrame referenceFrame,
                        boolean useCellVolumeForWeight,
                        boolean saveGridCell)

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

Parameters:

baseRadius - The radius of the base of the cone.

coneHeight - The height of the cone.

angularResolution - The angular resolution of the cone.

radialResolution - The minimum spacing in the radial coordinate of the cone.

heightResolution - The minimum spacing in the height coordinate of the cone.

referenceFrame - The ReferenceFrame (get / set) in which this cone is defined.

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.

ConeCoverageGrid

public ConeCoverageGrid(double baseRadius,
                        double coneHeight,
                        ICoverageGriddingTechnique angleGriddingTechnique,
                        ICoverageGriddingTechnique radialGriddingTechnique,
                        ICoverageGriddingTechnique heightGriddingTechnique,
                        ReferenceFrame referenceFrame,
                        boolean useCellVolumeForWeight,
                        boolean saveGridCell)

Initializes a cone grid with the specified parameters.

Parameters:

baseRadius - The radius of the base of the cone.

coneHeight - The height of the cone.

angleGriddingTechnique - The gridding technique for the angle coordinate.

radialGriddingTechnique - The gridding technique for the radial coordinate.

heightGriddingTechnique - The gridding technique for the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this cone is defined.

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.

ConeCoverageGrid

public ConeCoverageGrid(@Nonnull
                        Bounds clockAngleBounds,
                        @Nonnull
                        Bounds baseRadiusBounds,
                        @Nonnull
                        Bounds heightBounds,
                        ICoverageGriddingTechnique angleGriddingTechnique,
                        ICoverageGriddingTechnique radialGriddingTechnique,
                        ICoverageGriddingTechnique heightGriddingTechnique,
                        ReferenceFrame referenceFrame,
                        boolean useCellVolumeForWeight,
                        boolean saveGridCell)

Initializes a cone grid with the specified parameters.

Parameters:

clockAngleBounds - The bounds of the cone clock angle.

baseRadiusBounds - The bounds of the radius of the base of the cone.

heightBounds - The bounds of the height of the cone.

angleGriddingTechnique - The gridding technique for the angle coordinate.

radialGriddingTechnique - The gridding technique for the radial coordinate.

heightGriddingTechnique - The gridding technique for the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this cone is defined.

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.

getHeightBounds

@Nonnull
public final Bounds getHeightBounds()

Gets the height bounds of the cone. The height bounds must be positive and the upper bound is taken as length.

setHeightBounds

public final void setHeightBounds(@Nonnull
                                  Bounds value)

Sets the height bounds of the cone. The height bounds must be positive and the upper bound is taken as length.

getBaseRadiusBounds

@Nonnull
public final Bounds getBaseRadiusBounds()

Gets the cone's base radius bounds.

setBaseRadiusBounds

public final void setBaseRadiusBounds(@Nonnull
                                      Bounds value)

Sets the cone's base radius bounds.

getClockAngleBounds

@Nonnull
public final Bounds getClockAngleBounds()

Gets the cone clock angle 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 cone clock angle 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].

getRadialGriddingTechnique

public final ICoverageGriddingTechnique getRadialGriddingTechnique()

Gets the gridding technique used in the radial coordinate.

setRadialGriddingTechnique

public final void setRadialGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the radial coordinate.

getClockAngleGriddingTechnique

public final ICoverageGriddingTechnique getClockAngleGriddingTechnique()

Gets the gridding technique used in the clock angle coordinate.

setClockAngleGriddingTechnique

public final void setClockAngleGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the clock angle coordinate.

getHeightGriddingTechnique

public final ICoverageGriddingTechnique getHeightGriddingTechnique()

Gets the gridding technique used in the cone's height coordinate.

setHeightGriddingTechnique

public final void setHeightGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the cone's height 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 ReferenceFrame (get / set) is null or any of the gridding techniques are null. Also thrown if either BaseRadiusBounds (get / set) or HeightBounds (get / set) are negative.