agi.foundation.geometry.discrete

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

Class CuboidCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.GeometricPrimitiveCoverageGrid

agi.foundation.geometry.discrete.CuboidCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class CuboidCoverageGrid
extends GeometricPrimitiveCoverageGrid

A cuboid grid in Cartesian coordinates. Each coordinate is gridded from the minimum to maximum value of the coordinate's respective Bounds. (0,0,0) is defined as the center of the cuboid for the constructors that use length in each axis. It is possible to use this grid to produce a plane grid embedded in 3D by setting one coordinate's bounds to zero effective length.

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

Constructor Summary

Constructors

Constructor and Description
CuboidCoverageGrid(Bounds xAxisBounds, Bounds yAxisBounds, Bounds zAxisBounds, ICoverageGriddingTechnique xAxisGriddingTechnique, ICoverageGriddingTechnique yAxisGriddingTechnique, ICoverageGriddingTechnique zAxisGriddingTechnique, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cuboid grid with a single gridding technique used for each coordinate.
CuboidCoverageGrid(Bounds xAxisBounds, Bounds yAxisBounds, Bounds zAxisBounds, ICoverageGriddingTechnique griddingTechnique, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cuboid grid with a single gridding technique used for each coordinate.
CuboidCoverageGrid(double xAxisLength, double yAxisLength, double zAxisLength, double uniformResolution, ReferenceFrame frame) Initializes a cuboid grid with a uniform resolution in each coordinate.
CuboidCoverageGrid(double xAxisLength, double yAxisLength, double zAxisLength, double uniformResolution, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cuboid grid with a uniform resolution in each coordinate.
CuboidCoverageGrid(double xAxisLength, double yAxisLength, double zAxisLength, ICoverageGriddingTechnique griddingTechnique, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cuboid grid with a single gridding technique used for each coordinate.
CuboidCoverageGrid(double xAxisLength, double yAxisLength, double zAxisLength, int numberOfPoints, ReferenceFrame frame) Initializes a cuboid grid with each coordinate gridded by the specified number of points.
CuboidCoverageGrid(double xAxisLength, double yAxisLength, double zAxisLength, int numberOfPoints, ReferenceFrame frame, boolean useCellVolumeForWeight, boolean saveGridCell) Initializes a cuboid grid with each coordinate gridded by the specified number of points.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Generate the set of grid points.
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.
Bounds	getXAxisBounds() Gets the bounds in the x-axis.
ICoverageGriddingTechnique	getXGriddingTechnique() Gets the gridding technique for the grid points along x.
Bounds	getYAxisBounds() Gets the bounds in the y-axis.
ICoverageGriddingTechnique	getYGriddingTechnique() Gets the gridding technique for the grid points along y.
Bounds	getZAxisBounds() Gets the bounds in the z-axis.
ICoverageGriddingTechnique	getZGriddingTechnique() Gets the gridding technique for the grid points along z.
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	setXAxisBounds(Bounds value) Sets the bounds in the x-axis.
void	setXGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique for the grid points along x.
void	setYAxisBounds(Bounds value) Sets the bounds in the y-axis.
void	setYGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique for the grid points along y.
void	setZAxisBounds(Bounds value) Sets the bounds in the z-axis.
void	setZGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique for the grid points along z.

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

CuboidCoverageGrid

public CuboidCoverageGrid(double xAxisLength,
                          double yAxisLength,
                          double zAxisLength,
                          int numberOfPoints,
                          ReferenceFrame frame)

Initializes a cuboid grid with each coordinate gridded by the specified number of points. The grid is defined in the input ReferenceFrame (get / set).

Parameters:

xAxisLength - The length in x.

yAxisLength - The length in y.

zAxisLength - The length in z.

numberOfPoints - The number of points in each coordinate.

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

CuboidCoverageGrid

public CuboidCoverageGrid(double xAxisLength,
                          double yAxisLength,
                          double zAxisLength,
                          int numberOfPoints,
                          ReferenceFrame frame,
                          boolean useCellVolumeForWeight,
                          boolean saveGridCell)

Initializes a cuboid grid with each coordinate gridded by the specified number of points. The grid is defined in the input ReferenceFrame (get / set).

Parameters:

xAxisLength - The length in x.

yAxisLength - The length in y.

zAxisLength - The length in z.

numberOfPoints - The number of points in each coordinate.

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

CuboidCoverageGrid

public CuboidCoverageGrid(double xAxisLength,
                          double yAxisLength,
                          double zAxisLength,
                          double uniformResolution,
                          ReferenceFrame frame)

Initializes a cuboid grid with a uniform resolution in each coordinate. The grid is defined in the input ReferenceFrame (get / set).

Parameters:

xAxisLength - The length in x.

yAxisLength - The length in y.

zAxisLength - The length in z.

uniformResolution - The spatial resolution to use in all three dimensions.

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

CuboidCoverageGrid

public CuboidCoverageGrid(double xAxisLength,
                          double yAxisLength,
                          double zAxisLength,
                          double uniformResolution,
                          ReferenceFrame frame,
                          boolean useCellVolumeForWeight,
                          boolean saveGridCell)

Initializes a cuboid grid with a uniform resolution in each coordinate. The grid is defined in the input ReferenceFrame (get / set).

Parameters:

xAxisLength - The length in x.

yAxisLength - The length in y.

zAxisLength - The length in z.

uniformResolution - The spatial resolution to use in all three dimensions.

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

CuboidCoverageGrid

public CuboidCoverageGrid(double xAxisLength,
                          double yAxisLength,
                          double zAxisLength,
                          ICoverageGriddingTechnique griddingTechnique,
                          ReferenceFrame frame,
                          boolean useCellVolumeForWeight,
                          boolean saveGridCell)

Initializes a cuboid grid with a single gridding technique used for each coordinate. The grid is defined in the input ReferenceFrame (get / set).

Parameters:

xAxisLength - The length in x.

yAxisLength - The length in y.

zAxisLength - The length in z.

griddingTechnique - The gridding technique to be used for all three dimensions.

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

CuboidCoverageGrid

public CuboidCoverageGrid(@Nonnull
                          Bounds xAxisBounds,
                          @Nonnull
                          Bounds yAxisBounds,
                          @Nonnull
                          Bounds zAxisBounds,
                          ICoverageGriddingTechnique griddingTechnique,
                          ReferenceFrame frame,
                          boolean useCellVolumeForWeight,
                          boolean saveGridCell)

Initializes a cuboid grid with a single gridding technique used for each coordinate. Each coordinate is gridded from the minimum value to the maximum value specified in that coordinate's respective bounds structure. The grid is defined in the input ReferenceFrame (get / set).

Parameters:

xAxisBounds - The bounds in x.

yAxisBounds - The bounds in y.

zAxisBounds - The bounds in z.

griddingTechnique - The gridding technique to be used for all three dimensions.

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

CuboidCoverageGrid

public CuboidCoverageGrid(@Nonnull
                          Bounds xAxisBounds,
                          @Nonnull
                          Bounds yAxisBounds,
                          @Nonnull
                          Bounds zAxisBounds,
                          ICoverageGriddingTechnique xAxisGriddingTechnique,
                          ICoverageGriddingTechnique yAxisGriddingTechnique,
                          ICoverageGriddingTechnique zAxisGriddingTechnique,
                          ReferenceFrame frame,
                          boolean useCellVolumeForWeight,
                          boolean saveGridCell)

Initializes a cuboid grid with a single gridding technique used for each coordinate. Each coordinate is gridded from the minimum value to the maximum value specified in that coordinate's respective bounds structure. The grid is defined in the input ReferenceFrame (get / set).

Parameters:

xAxisBounds - The bounds in x.

yAxisBounds - The bounds in y.

zAxisBounds - The bounds in z.

xAxisGriddingTechnique - The gridding technique to be used for the x-axis.

yAxisGriddingTechnique - The gridding technique to be used for the y-axis.

zAxisGriddingTechnique - The gridding technique to be used for the z-axis.

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

getXAxisBounds

@Nonnull
public final Bounds getXAxisBounds()

Gets the bounds in the x-axis.

setXAxisBounds

public final void setXAxisBounds(@Nonnull
                                 Bounds value)

Sets the bounds in the x-axis.

getYAxisBounds

@Nonnull
public final Bounds getYAxisBounds()

Gets the bounds in the y-axis.

setYAxisBounds

public final void setYAxisBounds(@Nonnull
                                 Bounds value)

Sets the bounds in the y-axis.

getZAxisBounds

@Nonnull
public final Bounds getZAxisBounds()

Gets the bounds in the z-axis.

setZAxisBounds

public final void setZAxisBounds(@Nonnull
                                 Bounds value)

Sets the bounds in the z-axis.

getXGriddingTechnique

public final ICoverageGriddingTechnique getXGriddingTechnique()

Gets the gridding technique for the grid points along x.

setXGriddingTechnique

public final void setXGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique for the grid points along x.

getYGriddingTechnique

public final ICoverageGriddingTechnique getYGriddingTechnique()

Gets the gridding technique for the grid points along y.

setYGriddingTechnique

public final void setYGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique for the grid points along y.

getZGriddingTechnique

public final ICoverageGriddingTechnique getZGriddingTechnique()

Gets the gridding technique for the grid points along z.

setZGriddingTechnique

public final void setZGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique for the grid points along z.

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 if any of the gridding techniques are null.