agi.foundation.coverage

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

Class CoverageResults

java.lang.Object

agi.foundation.coverage.CoverageResults

public final class CoverageResults
extends Object

This represents the overall results of a coverage calculation over a grid.

Constructor Summary

Constructors

Constructor and Description
CoverageResults(List<CoverageGridPointWithResults> gridPoints) Create a new instance based on the given grid points.
CoverageResults(Scalar totalWeight, List<CoverageGridPointWithResults> gridPoints) Create a new instance based on the given grid points and total statistical weight.

Method Summary

Modifier and Type	Method and Description
CoverageResults	applyFilter(CoverageFilter filter) Applies the given filter to this result and returns a new result.
CoverageGridPointWithResults	findNearestGridPoint(Cartesian cartesianLocation) Given a cartesian location find the nearest grid point according to physical distance.
CoverageGridPointWithResults	findNearestGridPoint(Cartographic location) Given a planetodetic cartographic location, find the nearest grid point according to physical distance.
CoverageGridPointWithResults	findNearestGridPoint(Point location, JulianDate date) Given a Point and a date, find the nearest grid point according to physical distance.
CoverageGridPointWithResults	findNearestGridPointAtTime(Cartesian cartesianLocation, JulianDate date) Given a cartesian location and date, find the nearest grid point according to physical distance.
List<CoverageGridPointWithResults>	getGridPoints() Gets a list of grid points.
Scalar	getTotalWeight() Gets a Scalar representing the total weight for all the points.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoverageResults

public CoverageResults(@Nonnull
                       List<CoverageGridPointWithResults> gridPoints)

Create a new instance based on the given grid points.

Parameters:

gridPoints - The list of grid points with their coverage results.

CoverageResults

public CoverageResults(Scalar totalWeight,
                       List<CoverageGridPointWithResults> gridPoints)

Create a new instance based on the given grid points and total statistical weight.

Parameters:

totalWeight - The sum of the individual weights of the points in the grid.

gridPoints - The list of grid points with their coverage results.

Method Detail

getGridPoints

public final List<CoverageGridPointWithResults> getGridPoints()

Gets a list of grid points.

getTotalWeight

public final Scalar getTotalWeight()

Gets a Scalar representing the total weight for all the points.

findNearestGridPoint

@Nullable
public final CoverageGridPointWithResults findNearestGridPoint(@Nonnull
                                                                          Cartographic location)

Given a planetodetic cartographic location, find the nearest grid point according to physical distance.

This method only works for static grids in the reference frame where the grid is created.

Parameters:

location - The planetodetic location at which to search.

Returns:

The nearest grid point. If GridPoints (get) is empty or the CentralBody is null on the grid points, this returns null.

findNearestGridPoint

@Nullable
public final CoverageGridPointWithResults findNearestGridPoint(@Nonnull
                                                                          Cartesian cartesianLocation)

Given a cartesian location find the nearest grid point according to physical distance.

This method only works for static grids in the reference frame where the grid is created. The grid point position will be evaluated at the start of availability.

Parameters:

cartesianLocation - The location at which to search.

Returns:

The nearest grid point. If GridPoints (get) is empty, this returns null.

Throws:

IllegalStateException - Thrown if the points do not have overlapping availability.

findNearestGridPointAtTime

@Nullable
public final CoverageGridPointWithResults findNearestGridPointAtTime(@Nonnull
                                                                                Cartesian cartesianLocation,
                                                                                @Nonnull
                                                                                JulianDate date)

Given a cartesian location and date, find the nearest grid point according to physical distance.

Parameters:

cartesianLocation - The location at which to search.

date - The date at which to query the grid's location.

Returns:

The nearest grid point. If GridPoints (get) is empty, this returns null.

findNearestGridPoint

@Nullable
public final CoverageGridPointWithResults findNearestGridPoint(Point location,
                                                                          @Nonnull
                                                                          JulianDate date)

Given a Point and a date, find the nearest grid point according to physical distance.

This method observes all grid points in the input query point's reference frame.

Parameters:

location - The location at which to search.

date - The date at which to query the grid's location.

Returns:

The nearest grid point. If GridPoints (get) is empty, this returns null.

applyFilter

@Nonnull
public final CoverageResults applyFilter(CoverageFilter filter)

Applies the given filter to this result and returns a new result.

Parameters:

filter - The filter indicating whether any given interval satisfies coverage.

Returns:

The new result reflecting the given filter.