agi.foundation.geometry.discrete

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

Class RectangularPyramidCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.GeometricPrimitiveCoverageGrid

agi.foundation.geometry.discrete.RectangularPyramidCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class RectangularPyramidCoverageGrid
extends GeometricPrimitiveCoverageGrid

A rectangular pyramid grid. The coordinate origin is at the apex of the rectangular pyramid. The z-axis points from the apex to the base and is aligned with the pyramid's height. The axes are right handed.

The weight of each grid point defaults to 1. The input cartesian values are converted internally to pyramidal coordinates. The optional grid cell bounds are of the type, PyramidalBounds.

Constructor Summary

Constructors

Constructor and Description
RectangularPyramidCoverageGrid(double xAxisLength, double yAxisLength, Bounds heightBounds, ICoverageGriddingTechnique zxAngleGriddingTechnique, ICoverageGriddingTechnique zyAngleGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a rectangular pyramid grid with the specified parameters.
RectangularPyramidCoverageGrid(double xAxisLength, double yAxisLength, double height, double zxAngleResolution, double zyAngleResolution, double heightResolution, ReferenceFrame referenceFrame) Initializes a rectangular pyramid grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
RectangularPyramidCoverageGrid(double xAxisLength, double yAxisLength, double height, double zxAngleResolution, double zyAngleResolution, double heightResolution, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a rectangular pyramid grid with the specified parameters, where each coordinate uses a SpecifiedResolutionCoverageGriddingTechnique with a tolerance of Constants.Epsilon10.
RectangularPyramidCoverageGrid(double xAxisLength, double yAxisLength, double height, ICoverageGriddingTechnique zxAngleGriddingTechnique, ICoverageGriddingTechnique zyAngleGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame referenceFrame) Initializes a rectangular pyramid grid with the specified parameters.
RectangularPyramidCoverageGrid(double xAxisLength, double yAxisLength, double height, ICoverageGriddingTechnique zxAngleGriddingTechnique, ICoverageGriddingTechnique zyAngleGriddingTechnique, ICoverageGriddingTechnique heightGriddingTechnique, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a rectangular pyramid grid with the specified parameters.
RectangularPyramidCoverageGrid(double xAxisLength, double yAxisLength, double height, int numberOfZXAnglePoints, int numberOfZYAnglePoints, int numberOfHeightPoints, ReferenceFrame referenceFrame) Initializes a rectangular pyramid grid with the specified parameters, where each coordinate uses a SpecifiedNumberOfPointsCoverageGriddingTechnique.
RectangularPyramidCoverageGrid(double xAxisLength, double yAxisLength, double height, int numberOfZXAnglePoints, int numberOfZYAnglePoints, int numberOfHeightPoints, ReferenceFrame referenceFrame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a rectangular pyramid 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	getHeightBounds() Gets the height bounds of the pyramid.
ICoverageGriddingTechnique	getHeightGriddingTechnique() Gets the gridding technique used in the height direction of the pyramid.
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.
double	getXAxisLength() Gets the length of the pyramid's base in the x direction.
double	getYAxisLength() Gets the length of the pyramid's base in the y direction.
ICoverageGriddingTechnique	getZXAngleGriddingTechnique() Gets the gridding technique used in the (z-x) direction of the pyramid.
ICoverageGriddingTechnique	getZYAngleGriddingTechnique() Gets the gridding technique used in the (z-y) direction of the pyramid.
void	setHeightBounds(Bounds value) Sets the height bounds of the pyramid.
void	setHeightGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the height direction of the pyramid.
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.
void	setXAxisLength(double value) Sets the length of the pyramid's base in the x direction.
void	setYAxisLength(double value) Sets the length of the pyramid's base in the y direction.
void	setZXAngleGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the (z-x) direction of the pyramid.
void	setZYAngleGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used in the (z-y) direction of the pyramid.

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

RectangularPyramidCoverageGrid

public RectangularPyramidCoverageGrid(double xAxisLength,
                                      double yAxisLength,
                                      double height,
                                      int numberOfZXAnglePoints,
                                      int numberOfZYAnglePoints,
                                      int numberOfHeightPoints,
                                      ReferenceFrame referenceFrame)

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

Parameters:

xAxisLength - The length of the base in the x direction.

yAxisLength - The length of the base in the y direction.

height - The height of the pyramid.

numberOfZXAnglePoints - The number of points to use in the z-x angular coordinate.

numberOfZYAnglePoints - The number of points to use in the z-y angular coordinate.

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

referenceFrame - The ReferenceFrame (get / set) in which this rectangular pyramid is defined

RectangularPyramidCoverageGrid

public RectangularPyramidCoverageGrid(double xAxisLength,
                                      double yAxisLength,
                                      double height,
                                      int numberOfZXAnglePoints,
                                      int numberOfZYAnglePoints,
                                      int numberOfHeightPoints,
                                      ReferenceFrame referenceFrame,
                                      boolean useCellVolumeForWeight,
                                      boolean saveGridCell)

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

Parameters:

xAxisLength - The length of the base in the x direction.

yAxisLength - The length of the base in the y direction.

height - The height of the pyramid.

numberOfZXAnglePoints - The number of points to use in the z-x angular coordinate.

numberOfZYAnglePoints - The number of points to use in the z-y angular coordinate.

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

referenceFrame - The ReferenceFrame (get / set) in which this rectangular pyramid 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.

RectangularPyramidCoverageGrid

public RectangularPyramidCoverageGrid(double xAxisLength,
                                      double yAxisLength,
                                      double height,
                                      double zxAngleResolution,
                                      double zyAngleResolution,
                                      double heightResolution,
                                      ReferenceFrame referenceFrame)

Initializes a rectangular pyramid 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:

xAxisLength - The length of the base in the x direction.

yAxisLength - The length of the base in the y direction.

height - The height of the pyramid.

zxAngleResolution - The minimum spacing in the z-x angular coordinate.

zyAngleResolution - The minimum spacing in the z-y angular coordinate.

heightResolution - The minimum spacing in the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this rectangular pyramid is defined

RectangularPyramidCoverageGrid

public RectangularPyramidCoverageGrid(double xAxisLength,
                                      double yAxisLength,
                                      double height,
                                      double zxAngleResolution,
                                      double zyAngleResolution,
                                      double heightResolution,
                                      ReferenceFrame referenceFrame,
                                      boolean useCellVolumeForWeight,
                                      boolean saveGridCell)

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

Parameters:

xAxisLength - The length of the base in the x direction.

yAxisLength - The length of the base in the y direction.

height - The height of the pyramid.

zxAngleResolution - The minimum spacing in the z-x angular coordinate.

zyAngleResolution - The minimum spacing in the z-y angular coordinate.

heightResolution - The minimum spacing in the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this rectangular pyramid 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.

RectangularPyramidCoverageGrid

public RectangularPyramidCoverageGrid(double xAxisLength,
                                      double yAxisLength,
                                      double height,
                                      ICoverageGriddingTechnique zxAngleGriddingTechnique,
                                      ICoverageGriddingTechnique zyAngleGriddingTechnique,
                                      ICoverageGriddingTechnique heightGriddingTechnique,
                                      ReferenceFrame referenceFrame)

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

Parameters:

xAxisLength - The length of the base in the x direction.

yAxisLength - The length of the base in the y direction.

height - The height of the pyramid.

zxAngleGriddingTechnique - The gridding technique in the z-x angular coordinate.

zyAngleGriddingTechnique - The gridding technique in the z-y angular coordinate.

heightGriddingTechnique - The gridding technique in the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this rectangular pyramid is defined

RectangularPyramidCoverageGrid

public RectangularPyramidCoverageGrid(double xAxisLength,
                                      double yAxisLength,
                                      double height,
                                      ICoverageGriddingTechnique zxAngleGriddingTechnique,
                                      ICoverageGriddingTechnique zyAngleGriddingTechnique,
                                      ICoverageGriddingTechnique heightGriddingTechnique,
                                      ReferenceFrame referenceFrame,
                                      boolean useCellVolumeForWeight,
                                      boolean saveGridCell)

Initializes a rectangular pyramid grid with the specified parameters.

Parameters:

xAxisLength - The length of the base in the x direction.

yAxisLength - The length of the base in the y direction.

height - The height of the pyramid.

zxAngleGriddingTechnique - The gridding technique in the z-x angular coordinate.

zyAngleGriddingTechnique - The gridding technique in the z-y angular coordinate.

heightGriddingTechnique - The gridding technique in the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this rectangular pyramid 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.

RectangularPyramidCoverageGrid

public RectangularPyramidCoverageGrid(double xAxisLength,
                                      double yAxisLength,
                                      @Nonnull
                                      Bounds heightBounds,
                                      ICoverageGriddingTechnique zxAngleGriddingTechnique,
                                      ICoverageGriddingTechnique zyAngleGriddingTechnique,
                                      ICoverageGriddingTechnique heightGriddingTechnique,
                                      ReferenceFrame referenceFrame,
                                      boolean useCellVolumeForWeight,
                                      boolean saveGridCell)

Initializes a rectangular pyramid grid with the specified parameters.

Parameters:

xAxisLength - The length of the base in the x direction.

yAxisLength - The length of the base in the y direction.

heightBounds - The height bounds of the pyramid.

zxAngleGriddingTechnique - The gridding technique in the z-x angular coordinate.

zyAngleGriddingTechnique - The gridding technique in the z-y angular coordinate.

heightGriddingTechnique - The gridding technique in the height coordinate.

referenceFrame - The ReferenceFrame (get / set) in which this rectangular pyramid 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.

getXAxisLength

public final double getXAxisLength()

Gets the length of the pyramid's base in the x direction.

setXAxisLength

public final void setXAxisLength(double value)

Sets the length of the pyramid's base in the x direction.

getYAxisLength

public final double getYAxisLength()

Gets the length of the pyramid's base in the y direction.

setYAxisLength

public final void setYAxisLength(double value)

Sets the length of the pyramid's base in the y direction.

getHeightBounds

@Nonnull
public final Bounds getHeightBounds()

Gets the height bounds of the pyramid. 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 pyramid. The height bounds must be positive and the upper bound is taken as length.

getZXAngleGriddingTechnique

public final ICoverageGriddingTechnique getZXAngleGriddingTechnique()

Gets the gridding technique used in the (z-x) direction of the pyramid.

setZXAngleGriddingTechnique

public final void setZXAngleGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the (z-x) direction of the pyramid.

getZYAngleGriddingTechnique

public final ICoverageGriddingTechnique getZYAngleGriddingTechnique()

Gets the gridding technique used in the (z-y) direction of the pyramid.

setZYAngleGriddingTechnique

public final void setZYAngleGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the (z-y) direction of the pyramid.

getHeightGriddingTechnique

public final ICoverageGriddingTechnique getHeightGriddingTechnique()

Gets the gridding technique used in the height direction of the pyramid.

setHeightGriddingTechnique

public final void setHeightGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used in the height direction of the pyramid.

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. Thrown if either XAxisLength (get / set) or YAxisLength (get / set) is zero or less. Also thrown if HeightBounds (get / set) are not positive.