agi.foundation.coverage.figureofmerit

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

Class TimeSampledValues

java.lang.Object

agi.foundation.coverage.figureofmerit.TimeSampledValues

public class TimeSampledValues
extends Object

A data set containing scalar figure of merit data for a single grid point sampled over time.

Method Summary

Modifier and Type	Method and Description
static TimeSampledValues	computeData(CoverageData coverage, TimeInterval interval, Duration step, Scalar figureOfMerit) Compute the figure of merit data for the given set of results.
static TimeSampledValues	computeData(TimeIntervalCollection intervals, TimeInterval samplingInterval, Duration step, Scalar function) Compute the figure of merit data for the given set of results.
double	computeMaximum() Computes the maximum value over the computed timespan
double	computeMinimum() Computes the minimum value over the computed timespan
List<Double>	getData() Gets the list of data for this grid point.
double	getData(JulianDate time) Get the data for a given sample time from SampleTimes (get).
List<JulianDate>	getSampleTimes() Gets the list of times corresponding to the Data (get) values.

Methods inherited from class java.lang.Object

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

Method Detail

computeData

public static TimeSampledValues computeData(@Nonnull
                                            CoverageData coverage,
                                            @Nonnull
                                            TimeInterval interval,
                                            @Nonnull
                                            Duration step,
                                            Scalar figureOfMerit)

Compute the figure of merit data for the given set of results.

Parameters:

coverage - The set of coverage results for a single grid point.

interval - The sampling interval.

step - The step size for sampling.

figureOfMerit - The definition of the time-dynamic figure of merit to compute.

Returns:

A data set containing scalar figure of merit data for the given grid point over time.

computeData

public static TimeSampledValues computeData(@Nonnull
                                            TimeIntervalCollection intervals,
                                            @Nonnull
                                            TimeInterval samplingInterval,
                                            @Nonnull
                                            Duration step,
                                            @Nonnull
                                            Scalar function)

Compute the figure of merit data for the given set of results.

Parameters:

intervals - The set of intervals over which to sample.

samplingInterval - The reference time period defining the regularized sampling.

step - The step size for sampling.

function - The time-dynamic scalar function to compute.

Returns:

A data set containing scalar data sampled over time.

getData

public final double getData(@Nonnull
                            JulianDate time)

Get the data for a given sample time from SampleTimes (get).

Parameters:

time - The time to get.

Returns:

The data at or directly before the given time.

Throws:

IllegalStateException - Thrown if the time does not correspond with one of the sample times in SampleTimes (get).

getData

public final List<Double> getData()

Gets the list of data for this grid point.

If there is more than one interval in SatisfactionIntervals (get / set) of the CoverageQueryResult, there may be 'gaps' in the times between values. To see this, look at the SampleTimes (get) to check the times for each value or use TimeSampledValues.getData(agi.foundation.time.JulianDate) to find data at a specific time.

getSampleTimes

public final List<JulianDate> getSampleTimes()

Gets the list of times corresponding to the Data (get) values.

Returns:

The list of sample times.

computeMinimum

public final double computeMinimum()

Computes the minimum value over the computed timespan

Returns:

The minimum value of the Data (get).

Throws:

IllegalStateException - Thrown when Data (get) is empty.

computeMaximum

public final double computeMaximum()

Computes the maximum value over the computed timespan

Returns:

The maximum value of the Data (get).

Throws:

IllegalStateException - Thrown when Data (get) is empty.