agi.foundation.geometry.discrete

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

Class EllipsoidSurfaceRegionCoverageGridCell

java.lang.Object

agi.foundation.geometry.discrete.EllipsoidSurfaceRegionCoverageGridCell

All Implemented Interfaces:

ICoverageGridCell

public class EllipsoidSurfaceRegionCoverageGridCell
extends Object
implements ICoverageGridCell

An ellipsoid surface region grid cell that does not vary in time.

Constructor Summary

Constructors

Constructor and Description
EllipsoidSurfaceRegionCoverageGridCell(Collection<Cartographic> gridBoundaryVertices, double area, Ellipsoid shape) Initializes this 2D grid cell with the specified parameters.

Method Summary

Modifier and Type	Method and Description
EllipsoidSurfaceCurve	getGridCellBoundary() Gets the EllipsoidSurfaceCurve that represent this grid cell's boundary.
List<Cartographic>	getGridCellBoundaryVertices() Gets the grid point's grid cell boundary vertices.
Double	scalarMeasure(JulianDate date, int dimension) Returns a scalar measure for the grid cell.

Methods inherited from class java.lang.Object

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

Constructor Detail

EllipsoidSurfaceRegionCoverageGridCell

public EllipsoidSurfaceRegionCoverageGridCell(@Nonnull
                                              Collection<Cartographic> gridBoundaryVertices,
                                              double area,
                                              @Nonnull
                                              Ellipsoid shape)

Initializes this 2D grid cell with the specified parameters.

Parameters:

gridBoundaryVertices - The vertices for this cell as computed by the gridding algorithm.

area - The surface area of this region as computed by the gridding algorithm.

shape - The ellipsoid on which this grid cell is defined.

Throws:

ArgumentNullException - Thrown when gridBoundaryVertices or shape is null.

ArgumentOutOfRangeException - Thrown when the area is negative.

ArgumentException - Thrown when the number of boundary vertices is less than 3.

Method Detail

scalarMeasure

@Nullable
public Double scalarMeasure(@Nonnull
                                       JulianDate date,
                                       int dimension)

Returns a scalar measure for the grid cell. The dimension parameter indicates the spatial dimension.

This grid cell can return the perimeter (dimension 1) and surface area (dimension 2). It will return null otherwise.

Some examples of scalar measure are: for dimension 1 the perimeter, for dimension 2 the area or surface area, for dimension 3 the volume.

Specified by:

scalarMeasure in interface ICoverageGridCell

Parameters:

date - The date at which to evaluate the scalar measure of the grid cell.

dimension - The dimension of the scalar measure requested.

Returns:

The scalar measure, if available; otherwise null.

getGridCellBoundaryVertices

public final List<Cartographic> getGridCellBoundaryVertices()

Gets the grid point's grid cell boundary vertices.

Returns:

A list of the cartographic points that define the boundary of the grid point cell.

getGridCellBoundary

public final EllipsoidSurfaceCurve getGridCellBoundary()

Gets the EllipsoidSurfaceCurve that represent this grid cell's boundary.

Returns:

The grid cell boundary.