agi.foundation.coverage.figureofmerit

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

Class GridDescriptiveStatistics

java.lang.Object

agi.foundation.coverage.figureofmerit.GridDescriptiveStatistics

public final class GridDescriptiveStatistics
extends Object

A figure of merit providing statistical information pertaining to coverage over a grid.

Method Summary

Modifier and Type	Method and Description
static double	averageFigureOfMerit(Iterable<? extends CoverageGridPointWithResults> gridPoints, FigureOfMerit<Double> function) Computes the average of a given figure of merit over the grid (ignoring grid weighting).
static double	averageWeightedFigureOfMerit(Iterable<? extends CoverageGridPointWithResults> gridPoints, FigureOfMerit<Double> function) Computes the average of a given figure of merit over the grid, based on the grid point Weight (get / set).
static JulianDate	completeSatisfactionTime(Iterable<? extends CoverageGridPointWithResults> gridPoints) Gets the earliest time at which satisfaction has been achieved (not necessarily concurrently) for all the grid points, or null if one or more grid points are never satisfied.
static GridTimeSampledValues	computeFigureOfMeritData(CoverageResults grid, IFigureOfMeritDefinition figureOfMerit, TimeInterval interval, Duration stepSize) Compute the given figure of merit over the coverage grid.
static List<GridTimeSampledValues>	computeFigureOfMeritData(CoverageResults grid, List<IFigureOfMeritDefinition> figuresOfMerit, TimeInterval interval, Duration stepSize) Compute the given figure of merit over the coverage grid.
static double	instantaneousPercentCovered(Iterable<? extends CoverageGridPointWithResults> gridPoints, JulianDate time) Computes the percentage of the grid that is covered at the given time based on whether each individual grid point representing a given area is covered.
static double	instantaneousWeightCovered(Iterable<? extends CoverageGridPointWithResults> gridPoints, JulianDate time) Computes the total weight of the points on the grid that are covered at a given time.
static <T extends Comparable<T>> T	maximumFigureOfMerit(Iterable<? extends CoverageGridPointWithResults> gridPoints, FigureOfMerit<T> function) Computes the maximum of a given figure of merit over the grid, based on the grid point weights (usually area).
static <T extends Comparable<T>> T	minimumFigureOfMerit(Iterable<? extends CoverageGridPointWithResults> gridPoints, FigureOfMerit<T> function) Computes the minimum of a given figure of merit over the grid.
static double[]	percentAccumulated(Iterable<? extends CoverageGridPointWithResults> gridPoints, JulianDate start, JulianDate stop, Duration step) Given a time after a start time, computes the highest percentage of the grid which has been covered at any one time after the start and before the time of interest.
static double	percentCovered(Iterable<? extends CoverageGridPointWithResults> gridPoints) Computes the percentage of the grid that is covered based on whether each individual grid point representing a given area is covered at any time.
static TimeIntervalCollection	satisfactionIntervals(Iterable<? extends CoverageGridPointWithResults> gridPoints) Returns the set of intervals where the entire set of grid points is satisfied.
static TimeIntervalCollection	unknownIntervals(Iterable<? extends CoverageGridPointWithResults> gridPoints) Returns the set of intervals where coverage is unknown on any of the grid points.
static double	weightOfCoveredPoints(Iterable<? extends CoverageGridPointWithResults> gridPoints) Computes the total weight of the points on the grid which have been covered.

Methods inherited from class java.lang.Object

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

Method Detail

satisfactionIntervals

@Nonnull
public static TimeIntervalCollection satisfactionIntervals(@Nonnull
                                                                     Iterable<? extends CoverageGridPointWithResults> gridPoints)

Returns the set of intervals where the entire set of grid points is satisfied.

Parameters:

gridPoints - The set of grid points to analyze.

Returns:

Returns a set of time intervals representing times when all grid points are satisfied.

unknownIntervals

@Nonnull
public static TimeIntervalCollection unknownIntervals(@Nonnull
                                                                Iterable<? extends CoverageGridPointWithResults> gridPoints)

Returns the set of intervals where coverage is unknown on any of the grid points.

Parameters:

gridPoints - The set of grid points to analyze.

Returns:

Returns a set of time intervals representing times when any grid point is unknown.

percentCovered

public static double percentCovered(@Nonnull
                                    Iterable<? extends CoverageGridPointWithResults> gridPoints)

Computes the percentage of the grid that is covered based on whether each individual grid point representing a given area is covered at any time.

This method only works with static grids.

Parameters:

gridPoints - The data on the coverage intervals to analyze.

Returns:

The percentage of the grid which is covered at any time.

Throws:

IllegalStateException - Thrown if any of the weight scalars for the input grid points varies in time.

instantaneousPercentCovered

public static double instantaneousPercentCovered(@Nonnull
                                                 Iterable<? extends CoverageGridPointWithResults> gridPoints,
                                                 @Nonnull
                                                 JulianDate time)

Computes the percentage of the grid that is covered at the given time based on whether each individual grid point representing a given area is covered.

Parameters:

gridPoints - The data on the coverage intervals to analyze.

time - The time of interest.

Returns:

The percent of grid which is covered at the given time.

percentAccumulated

@Nonnull
public static double[] percentAccumulated(@Nonnull
                                                    Iterable<? extends CoverageGridPointWithResults> gridPoints,
                                                    @Nonnull
                                                    JulianDate start,
                                                    @Nonnull
                                                    JulianDate stop,
                                                    @Nonnull
                                                    Duration step)

Given a time after a start time, computes the highest percentage of the grid which has been covered at any one time after the start and before the time of interest.

Parameters:

gridPoints - The coverage grid which must contain the coverage intervals on each of the grid points.

start - The start of the coverage accumulation.

stop - The time of interest at which to report the accumulated percent coverage.

step - The time step at which to sample the coverage intervals.

Returns:

The accumulated percent of grid which has been covered.

weightOfCoveredPoints

public static double weightOfCoveredPoints(@Nonnull
                                           Iterable<? extends CoverageGridPointWithResults> gridPoints)

Computes the total weight of the points on the grid which have been covered.

This method only works with static grids. For grids that use geometric values for the statistical weight this value could be area or volume covered, for example.

Parameters:

gridPoints - The coverage grid points. These points must contain results.

Returns:

The total weight of the covered grid points.

Throws:

IllegalStateException - Thrown if any of the weight scalars for the input grid points varies in time.

instantaneousWeightCovered

public static double instantaneousWeightCovered(@Nonnull
                                                Iterable<? extends CoverageGridPointWithResults> gridPoints,
                                                @Nonnull
                                                JulianDate time)

Computes the total weight of the points on the grid that are covered at a given time.

For grids that use geometric values for the statistical weight this value could be area or volume covered, for example.

Parameters:

gridPoints - The coverage grid points. These points must contain results.

time - The time of interest at which to compute the coverage area.

Returns:

The total weight of the covered grid points at the specified time.

averageFigureOfMerit

public static double averageFigureOfMerit(Iterable<? extends CoverageGridPointWithResults> gridPoints,
                                          FigureOfMerit<Double> function)

Computes the average of a given figure of merit over the grid (ignoring grid weighting).

Parameters:

gridPoints - The coverage grid points. These points must contain results.

function - The figure of merit to average.

Returns:

The average of the given figure of merit.

averageWeightedFigureOfMerit

public static double averageWeightedFigureOfMerit(@Nonnull
                                                  Iterable<? extends CoverageGridPointWithResults> gridPoints,
                                                  FigureOfMerit<Double> function)

Computes the average of a given figure of merit over the grid, based on the grid point Weight (get / set).

This method only works with static grids.

Parameters:

gridPoints - The coverage grid points. These points must contain results.

function - The figure of merit to average.

Returns:

The average of the given figure of merit.

Throws:

IllegalStateException - Thrown if any of the weight scalars for the input grid points varies in time.

minimumFigureOfMerit

public static <T extends Comparable<T>> T minimumFigureOfMerit(@Nonnull
                                                               Iterable<? extends CoverageGridPointWithResults> gridPoints,
                                                               FigureOfMerit<T> function)

Computes the minimum of a given figure of merit over the grid.

Type Parameters:

T - The type of value produced by the figure of merit.

Parameters:

gridPoints - The coverage grid points. These points must contain results.

function - The figure of merit.

Returns:

The minimum of the given figure of merit.

maximumFigureOfMerit

public static <T extends Comparable<T>> T maximumFigureOfMerit(@Nonnull
                                                               Iterable<? extends CoverageGridPointWithResults> gridPoints,
                                                               FigureOfMerit<T> function)

Computes the maximum of a given figure of merit over the grid, based on the grid point weights (usually area).

Type Parameters:

T - The type of value produced by the figure of merit.

Parameters:

gridPoints - The coverage grid points. These points must contain results.

function - The figure of merit.

Returns:

The maximum of the given figure of merit.

computeFigureOfMeritData

public static GridTimeSampledValues computeFigureOfMeritData(CoverageResults grid,
                                                             IFigureOfMeritDefinition figureOfMerit,
                                                             TimeInterval interval,
                                                             @Nonnull
                                                             Duration stepSize)

Compute the given figure of merit over the coverage grid.

Calls GridTimeSampledValues.computeData(CoverageResults,IFigureOfMeritDefinition,TimeInterval,Duration) on GridTimeSampledValues.

Parameters:

grid - The coverage grid results.

figureOfMerit - The figure of merit to compute.

interval - The time interval over which to compute.

stepSize - The step size at which to compute.

Returns:

A dataset containing the figure of merit data for each grid point sampled over time.

computeFigureOfMeritData

public static List<GridTimeSampledValues> computeFigureOfMeritData(CoverageResults grid,
                                                                   List<IFigureOfMeritDefinition> figuresOfMerit,
                                                                   TimeInterval interval,
                                                                   @Nonnull
                                                                   Duration stepSize)

Compute the given figure of merit over the coverage grid.

Calls GridTimeSampledValues.computeData(CoverageResults,List,TimeInterval,Duration) on GridTimeSampledValues.

Parameters:

grid - The coverage grid results.

figuresOfMerit - The list of figures of merit to compute.

interval - The time interval over which to compute.

stepSize - The step size at which to compute.

Returns:

A list corresponding to the figuresOfMerit containing the data for each grid point sampled over time.

completeSatisfactionTime

@Nullable
public static JulianDate completeSatisfactionTime(@Nonnull
                                                             Iterable<? extends CoverageGridPointWithResults> gridPoints)

Gets the earliest time at which satisfaction has been achieved (not necessarily concurrently) for all the grid points, or null if one or more grid points are never satisfied.

Parameters:

gridPoints - The grid points and their coverage results.

Returns:

The first time at which all the grid points have been satisfied at some point in the past.