agi.foundation.geometry.discrete

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

Class SpecifiedCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.SpecifiedCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class SpecifiedCoverageGrid
extends Object
implements ICoverageGrid

Wraps a previously generated set of GridPoints or accepts a specified list of Points and weights. The grid is stored in memory instead of being generated on demand.

Constructor Summary

Constructors

Constructor and Description
SpecifiedCoverageGrid(ICoverageGrid existingGrid) Construct an instance given another ICoverageGrid.
SpecifiedCoverageGrid(ReferenceFrame referenceFrame, List<CoverageGridPoint> points) Initializes the grid with the specified parameters.
SpecifiedCoverageGrid(ReferenceFrame referenceFrame, List<Point> gridPoints, List<Scalar> weights) Initializes the grid with the specified parameters.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Generate the set of grid points.
ReferenceFrame	getReferenceFrame() Gets the reference frame in which this grid is defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecifiedCoverageGrid

public SpecifiedCoverageGrid(@Nonnull
                             ReferenceFrame referenceFrame,
                             @Nonnull
                             List<CoverageGridPoint> points)

Initializes the grid with the specified parameters.

Parameters:

referenceFrame - The reference frame used for the grid points.

points - The grid points.

Throws:

ArgumentNullException - Thrown if any of the parameters are .

SpecifiedCoverageGrid

public SpecifiedCoverageGrid(@Nonnull
                             ReferenceFrame referenceFrame,
                             @Nonnull
                             List<Point> gridPoints,
                             @Nonnull
                             List<Scalar> weights)

Initializes the grid with the specified parameters.

Note that the number of grid points must be equal to the number of weights. The weights are paired with the grid points in order.

Parameters:

referenceFrame - The reference frame used for the grid points.

gridPoints - A list of Points that represent the grid points.

weights - A list of weights that are to be used with the points.

Throws:

ArgumentException - Thrown if the number of grid points does not equal the number of weights.

ArgumentNullException - Thrown if any of the parameters are .

SpecifiedCoverageGrid

public SpecifiedCoverageGrid(@Nonnull
                             ICoverageGrid existingGrid)

Construct an instance given another ICoverageGrid.

Using this as a wrapper for another grid will store the generated grid in memory so that it is only generated once.

Parameters:

existingGrid - An existing grid.

Throws:

ArgumentNullException - Thrown if existingGrid is .

Method Detail

getReferenceFrame

public final ReferenceFrame getReferenceFrame()

Description copied from interface: ICoverageGrid

Gets the reference frame in which this grid is defined.

Specified by:

getReferenceFrame in interface ICoverageGrid

generateGridPoints

public final 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

Returns:

The set of grid points.