agi.foundation.geometry.discrete

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

Class CoverageGridPoint

java.lang.Object

agi.foundation.geometry.discrete.CoverageGridPoint

public class CoverageGridPoint
extends Object

Represents a grid point for use with the coverage system. It holds the position of the grid point, the statistical weight, the reference frame it is defined in, and (optionally) the grid point's cell.

Constructor Summary

Constructors

Constructor and Description
CoverageGridPoint(Point position, Scalar weight, ICoverageGridCell coverageGridCell, ReferenceFrame referenceFrame) Creates a new instance based on the given point, weight, grid cell, and reference frame.
CoverageGridPoint(Point position, Scalar weight, ICoverageGridCell coverageGridCell, ReferenceFrame referenceFrame, CentralBody centralBody) Creates a new instance based on the given point, weight, grid cell, central body, and reference frame.
CoverageGridPoint(Point position, Scalar weight, ReferenceFrame referenceFrame) Creates a new instance based on the given point, weight, and reference frame.
CoverageGridPoint(Point position, Scalar weight, ReferenceFrame referenceFrame, CentralBody centralBody) Creates a new instance based on the given point, weight, central body, and reference frame.

Method Summary

Modifier and Type	Method and Description
CentralBody	getCentralBody() Gets the (optional) CentralBody (get / set) associated with this grid point.
ICoverageGridCell	getCoverageGridCell() Gets the (optional) grid cell associated with this grid point.
Point	getPosition() Gets the point representing this grid point.
ReferenceFrame	getReferenceFrame() Gets the reference frame in which this grid point is defined.
Scalar	getWeight() Gets the weight representing the relative importance of this grid point with respect to the entire grid.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoverageGridPoint

public CoverageGridPoint(Point position,
                         Scalar weight,
                         ReferenceFrame referenceFrame)

Creates a new instance based on the given point, weight, and reference frame.

Parameters:

position - The point representing this grid point.

weight - The weight for this grid point. For example this can be the area or volume represented by the grid point.

referenceFrame - The reference frame in which this grid point is defined.

CoverageGridPoint

public CoverageGridPoint(Point position,
                         Scalar weight,
                         ReferenceFrame referenceFrame,
                         CentralBody centralBody)

Creates a new instance based on the given point, weight, central body, and reference frame.

Parameters:

position - The point representing this grid point.

weight - The weight for this grid point. For example this can be the area or volume represented by the grid point.

referenceFrame - The reference frame in which this grid point is defined.

centralBody - The central body associated with this point.

CoverageGridPoint

public CoverageGridPoint(Point position,
                         Scalar weight,
                         ICoverageGridCell coverageGridCell,
                         ReferenceFrame referenceFrame)

Creates a new instance based on the given point, weight, grid cell, and reference frame.

Parameters:

position - The point representing this grid point.

weight - The weight for this grid point. For example this can be the area or volume represented by the grid point.

coverageGridCell - The grid cell for this grid point.

referenceFrame - The reference frame in which this grid point is defined.

CoverageGridPoint

public CoverageGridPoint(Point position,
                         Scalar weight,
                         ICoverageGridCell coverageGridCell,
                         ReferenceFrame referenceFrame,
                         CentralBody centralBody)

Creates a new instance based on the given point, weight, grid cell, central body, and reference frame.

Parameters:

position - The point representing this grid point.

weight - The weight for this grid point. This can be the area or volume represented by the grid point.

coverageGridCell - The grid cell for this grid point.

referenceFrame - The reference frame in which this grid point is defined.

centralBody - The central body associated with this point.

Method Detail

getPosition

public final Point getPosition()

Gets the point representing this grid point.

getWeight

public final Scalar getWeight()

Gets the weight representing the relative importance of this grid point with respect to the entire grid.

getCoverageGridCell

@Nullable
public final ICoverageGridCell getCoverageGridCell()

Gets the (optional) grid cell associated with this grid point. This item may be null.

getCentralBody

@Nullable
public final CentralBody getCentralBody()

Gets the (optional) CentralBody (get / set) associated with this grid point. This item may be null.

getReferenceFrame

public final ReferenceFrame getReferenceFrame()

Gets the reference frame in which this grid point is defined.