agi.foundation.coverage.figureofmerit

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

Class GridTimeSampledValues

java.lang.Object

agi.foundation.coverage.figureofmerit.GridTimeSampledValues

public class GridTimeSampledValues
extends Object

A set of data representing the values of a particular figure of merit sampled over a coverage grid at predefined time intervals.

Method Summary

Modifier and Type	Method and Description
static GridTimeSampledValues	computeData(CoverageResults grid, IFigureOfMeritDefinition figureOfMerit, TimeInterval interval, Duration step) Compute figure of merit over the coverage grid.
static GridTimeSampledValues	computeData(CoverageResults grid, IFigureOfMeritDefinition figureOfMerit, TimeInterval interval, Duration step, ITrackCalculationProgress tracker) Compute figure of merit over the coverage grid.
static <T extends IFigureOfMeritDefinition> List<GridTimeSampledValues>	computeData(CoverageResults grid, List<T> figuresOfMerit, TimeInterval interval, Duration step) Compute figure of merit over the coverage grid.
static <T extends IFigureOfMeritDefinition> List<GridTimeSampledValues>	computeData(CoverageResults grid, List<T> figuresOfMerit, TimeInterval interval, Duration step, ITrackCalculationProgress tracker) Compute figure of merit over the coverage grid.
double	computeOverallMaximum() Computes the maximum value of the entire data set (the maximum of the maximum values of each grid point).
double	computeOverallMean() Computes the mean value of the entire combined data set (not the mean value of the individual mean values).
double	computeOverallMinimum() Computes the minimum value of the entire data set (the minimum of the minimum values of each grid point).
double	computeOverallPercentile(double percentile) Computes the figure of merit value which is closest to the given percentile after sorting the combined figure of merit data from smallest to largest.
double	computeOverallRootMeanSquare() Computes the root mean square average of the entire combined data set (not the root mean square of the individual root mean square values).
double	computeOverallStandardDeviation() Computes the standard deviation for the combined data set (not the standard deviation of the standard deviations).
List<TimeSampledValues>	getGridPointData() Gets the list of grid point data.

Methods inherited from class java.lang.Object

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

Method Detail

computeData

public static GridTimeSampledValues computeData(CoverageResults grid,
                                                IFigureOfMeritDefinition figureOfMerit,
                                                TimeInterval interval,
                                                @Nonnull
                                                Duration step)

Compute figure of merit over the coverage grid.

Parameters:

grid - The coverage grid, including results.

figureOfMerit - The time-dynamic figure of merit definition.

interval - The sampling interval.

step - The sampling step size.

Returns:

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

computeData

public static GridTimeSampledValues computeData(CoverageResults grid,
                                                IFigureOfMeritDefinition figureOfMerit,
                                                TimeInterval interval,
                                                @Nonnull
                                                Duration step,
                                                ITrackCalculationProgress tracker)

Compute figure of merit over the coverage grid.

Parameters:

grid - The coverage grid, including results.

figureOfMerit - The time-dynamic figure of merit definition.

interval - The sampling interval.

step - The sampling step size.

tracker - An object used for tracking the progress of the calculation.

Returns:

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

computeData

public static <T extends IFigureOfMeritDefinition> List<GridTimeSampledValues> computeData(CoverageResults grid,
                                                                                           List<T> figuresOfMerit,
                                                                                           TimeInterval interval,
                                                                                           @Nonnull
                                                                                           Duration step)

Compute figure of merit over the coverage grid.

Type Parameters:

T - The type of figure of merit being used to compute the data.

Parameters:

grid - The coverage grid, including results.

figuresOfMerit - A list of time-dynamic figure of merit definitions.

interval - The sampling interval.

step - The sampling step size.

Returns:

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

computeData

public static <T extends IFigureOfMeritDefinition> List<GridTimeSampledValues> computeData(CoverageResults grid,
                                                                                           List<T> figuresOfMerit,
                                                                                           TimeInterval interval,
                                                                                           @Nonnull
                                                                                           Duration step,
                                                                                           ITrackCalculationProgress tracker)

Compute figure of merit over the coverage grid.

Type Parameters:

T - The type of figure of merit being used to compute the data.

Parameters:

grid - The coverage grid, including results.

figuresOfMerit - A list of time-dynamic figure of merit definitions.

interval - The sampling interval.

step - The sampling step size.

tracker - An object used for tracking the progress of the calculation.

Returns:

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

getGridPointData

public final List<TimeSampledValues> getGridPointData()

Gets the list of grid point data.

computeOverallMinimum

public final double computeOverallMinimum()

Computes the minimum value of the entire data set (the minimum of the minimum values of each grid point).

Returns:

The overall minimum figure of merit.

Throws:

IllegalStateException - Thrown when GridPointData (get) is empty.

computeOverallMaximum

public final double computeOverallMaximum()

Computes the maximum value of the entire data set (the maximum of the maximum values of each grid point).

Returns:

The overall maximum figure of merit.

Throws:

IllegalStateException - Thrown when GridPointData (get) is empty.

computeOverallMean

public final double computeOverallMean()

Computes the mean value of the entire combined data set (not the mean value of the individual mean values).

Returns:

The overall mean value of the combined figure of merit data.

Throws:

IllegalStateException - Thrown when GridPointData (get) is empty.

computeOverallRootMeanSquare

public final double computeOverallRootMeanSquare()

Computes the root mean square average of the entire combined data set (not the root mean square of the individual root mean square values).

Returns:

The overall root mean square value of the figure of merit data.

Throws:

IllegalStateException - Thrown when GridPointData (get) is empty.

computeOverallPercentile

public final double computeOverallPercentile(double percentile)

Computes the figure of merit value which is closest to the given percentile after sorting the combined figure of merit data from smallest to largest.

Parameters:

percentile - The percentile value (1-100) indicating the location in the sorted list.

Returns:

The value of the figure of merit at the given percentile.

Throws:

IllegalStateException - Thrown when GridPointData (get) is empty.

computeOverallStandardDeviation

public final double computeOverallStandardDeviation()

Computes the standard deviation for the combined data set (not the standard deviation of the standard deviations).

Returns:

The overall standard deviation of the figure of merit data set.

Throws:

IllegalStateException - Thrown when GridPointData (get) is empty.