agi.foundation.geometry.discrete

(agi.foundation.spatial-2025r1.jar)

Class CylinderCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.GeometricPrimitiveCoverageGrid

agi.foundation.geometry.discrete.CylinderCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class CylinderCoverageGrid
extends GeometricPrimitiveCoverageGrid

A cylinder grid with (0,0,0) defined to be at the center of the cylinder for the constructors that take length as parameters. The coordinates are right handed, defined in the usual way with height in z and the clock angle relative to the positive x-axis. Positive z is defined as from the bottom circular base to the top circular base.

The weight of each grid point defaults to 1. The optional grid cell bounds are of the type, CylindricalBounds.

Constructor Summary

Constructors

Constructor and Description
CylinderCoverageGrid(Bounds clockAngleBounds, Bounds radialBounds, Bounds heightBounds, ICoverageGriddingTechnique clockAngleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cylinder grid with the specified parameters.
CylinderCoverageGrid(double radius, double height, double angularResolution, double radialResolution, double heightResolution, ReferenceFrame frame) Initializes a cylinder grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
CylinderCoverageGrid(double radius, double height, double angularResolution, double radialResolution, double heightResolution, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cylinder grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
CylinderCoverageGrid(double radius, double height, ICoverageGriddingTechnique clockAngleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame frame) Initializes a cylinder grid with the specified parameters.
CylinderCoverageGrid(double radius, double height, ICoverageGriddingTechnique clockAngleGriddingTechnique, ICoverageGriddingTechnique radialGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cylinder grid with the specified parameters.
CylinderCoverageGrid(double radius, double height, int numberOfAngularPoints, int numberOfRadialPoints, int numberOfHeightPoints, ReferenceFrame frame) Initializes a cylinder grid with the specified parameters, where each coordinate uses a SpecifiedNumberOfPointsCoverageGriddingTechnique.
CylinderCoverageGrid(double radius, double height, int numberOfAngularPoints, int numberOfRadialPoints, int numberOfHeightPoints, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cylinder 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 bounds for the cylinder's clock angle.
ICoverageGriddingTechnique	getClockAngleGriddingTechnique() Gets the gridding technique used in the clock angle coordinate.
Bounds	getHeightBounds() Gets the height bounds for the cylinder's z coordinate.
ICoverageGriddingTechnique	getHeightGriddingTechnique() Gets the gridding technique used in the height (z) coordinate.
Bounds	getRadialBounds() Gets the radial bounds for the cylinder's radial coordinate, which must be positive.
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	setClockAngleBounds(Bounds value) Sets the bounds for the cylinder's clock angle.
void	setClockAngleGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the clock angle coordinate.
void	setHeightBounds(Bounds value) Sets the height bounds for the cylinder's z coordinate.
void	setHeightGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the height (z) coordinate.
void	setRadialBounds(Bounds value) Sets the radial bounds for the cylinder's radial coordinate, which must be positive.
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

CylinderCoverageGrid

public CylinderCoverageGrid(double radius,
                            double height,
                            int numberOfAngularPoints,
                            int numberOfRadialPoints,
                            int numberOfHeightPoints,
                            ReferenceFrame frame)

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

Parameters:

radius - The radius of the cylinder.

height - The height of the cylinder.

numberOfAngularPoints - The number of points to use in the gridding of the angular coordinate of the cylinder.

numberOfRadialPoints - The number of points to use in the gridding of the radius of the cylinder.

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

frame - The ReferenceFrame (get / set) in which this cylinder is defined.

CylinderCoverageGrid

public CylinderCoverageGrid(double radius,
                            double height,
                            int numberOfAngularPoints,
                            int numberOfRadialPoints,
                            int numberOfHeightPoints,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

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

Parameters:

radius - The radius of the cylinder.

height - The height of the cylinder.

numberOfAngularPoints - The number of points to use in the gridding of the angular coordinate of the cylinder.

numberOfRadialPoints - The number of points to use in the gridding of the radius of the cylinder.

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

frame - The ReferenceFrame (get / set) in which this cylinder 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.

CylinderCoverageGrid

public CylinderCoverageGrid(double radius,
                            double height,
                            double angularResolution,
                            double radialResolution,
                            double heightResolution,
                            ReferenceFrame frame)

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

Parameters:

radius - The radius of the cylinder.

height - The height of the cylinder.

angularResolution - The angular resolution of the cylinder.

radialResolution - The radial gridding resolution of the cylinder.

heightResolution - The height resolution of the cylinder.

frame - The ReferenceFrame (get / set) in which this cylinder is defined.

CylinderCoverageGrid

public CylinderCoverageGrid(double radius,
                            double height,
                            double angularResolution,
                            double radialResolution,
                            double heightResolution,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

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

Parameters:

radius - The radius of the cylinder.

height - The height of the cylinder.

angularResolution - The angular resolution of the cylinder.

radialResolution - The radial gridding resolution of the cylinder.

heightResolution - The height resolution of the cylinder.

frame - The ReferenceFrame (get / set) in which this cylinder 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.

CylinderCoverageGrid

public CylinderCoverageGrid(double radius,
                            double height,
                            ICoverageGriddingTechnique clockAngleGriddingTechnique,
                            ICoverageGriddingTechnique radialGriddingTechnique,
                            ICoverageGriddingTechnique heightGriddingTechnique,
                            ReferenceFrame frame)

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

Parameters:

radius - The radius of the cylinder.

height - The height of the cylinder.

clockAngleGriddingTechnique - The angular gridding technique of the cylinder.

radialGriddingTechnique - The radial gridding technique of the cylinder.

heightGriddingTechnique - The height gridding technique of the cylinder.

frame - The ReferenceFrame (get / set) in which this cylinder is defined.

CylinderCoverageGrid

public CylinderCoverageGrid(double radius,
                            double height,
                            ICoverageGriddingTechnique clockAngleGriddingTechnique,
                            ICoverageGriddingTechnique radialGriddingTechnique,
                            ICoverageGriddingTechnique heightGriddingTechnique,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

Initializes a cylinder grid with the specified parameters.

Parameters:

radius - The radius of the cylinder.

height - The height of the cylinder.

clockAngleGriddingTechnique - The angular gridding technique of the cylinder.

radialGriddingTechnique - The radial gridding technique of the cylinder.

heightGriddingTechnique - The height gridding technique of the cylinder.

frame - The ReferenceFrame (get / set) in which this cylinder 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.

CylinderCoverageGrid

public CylinderCoverageGrid(@Nonnull
                            Bounds clockAngleBounds,
                            @Nonnull
                            Bounds radialBounds,
                            @Nonnull
                            Bounds heightBounds,
                            ICoverageGriddingTechnique clockAngleGriddingTechnique,
                            ICoverageGriddingTechnique radialGriddingTechnique,
                            ICoverageGriddingTechnique heightGriddingTechnique,
                            ReferenceFrame frame,
                            boolean useCellVolumeForWeight,
                            boolean saveGridCell)

Initializes a cylinder grid with the specified parameters.

Parameters:

clockAngleBounds - The bounds in the clock angle of the cylinder.

radialBounds - The bounds of the radius of the cylinder.

heightBounds - The bounds of the height of the cylinder.

clockAngleGriddingTechnique - The angular gridding technique of the cylinder.

radialGriddingTechnique - The radial gridding technique of the cylinder.

heightGriddingTechnique - The height gridding technique of the cylinder.

frame - The ReferenceFrame (get / set) in which this cylinder 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.

getRadialBounds

@Nonnull
public final Bounds getRadialBounds()

Gets the radial bounds for the cylinder's radial coordinate, which must be positive.

setRadialBounds

public final void setRadialBounds(@Nonnull
                                  Bounds value)

Sets the radial bounds for the cylinder's radial coordinate, which must be positive.

getHeightBounds

@Nonnull
public final Bounds getHeightBounds()

Gets the height bounds for the cylinder's z coordinate.

setHeightBounds

public final void setHeightBounds(@Nonnull
                                  Bounds value)

Sets the height bounds for the cylinder's z coordinate.

getClockAngleBounds

@Nonnull
public final Bounds getClockAngleBounds()

Gets the bounds for the cylinder's clock angle. 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 bounds for the cylinder's clock angle. 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 height (z) coordinate.

setHeightGriddingTechnique

public final void setHeightGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the height (z) 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 RadialBounds (get / set) is negative.