agi.foundation.coverage.figureofmerit

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

Class CoverageGaps

java.lang.Object

agi.foundation.coverage.figureofmerit.CoverageGaps

public final class CoverageGaps
extends Object

A figure of merit which provides statistical information regarding gaps in coverage.

Method Summary

Modifier and Type	Method and Description
static double	timeAverageGap(CoverageQueryResult coverageIntervals) The time average length of gaps in coverage, computed as the sum of the square of the gap lengths all divided by the length of the interval of interest.
static int	totalNumberOfGaps(CoverageQueryResult coverageIntervals) Computes the total number of gaps in coverage between the given times.
static int	totalNumberOfGapsInSpan(CoverageQueryResult coverageIntervals, double min, double max) Computes the total number of gaps which are above a minimum and below a maximum duration.

Methods inherited from class java.lang.Object

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

Method Detail

totalNumberOfGaps

public static int totalNumberOfGaps(@Nonnull
                                    CoverageQueryResult coverageIntervals)

Computes the total number of gaps in coverage between the given times.

If there are gaps at the beginning or end, these will be included in the total.

Parameters:

coverageIntervals - The intervals of coverage.

Returns:

The total number of gaps where there is no coverage.

Throws:

ArgumentNullException - Thrown when coverageIntervals is null.

totalNumberOfGapsInSpan

public static int totalNumberOfGapsInSpan(@Nonnull
                                          CoverageQueryResult coverageIntervals,
                                          double min,
                                          double max)

Computes the total number of gaps which are above a minimum and below a maximum duration.

If there are gaps at the beginning or end, their duration will be the time between the interval of coverage and the beginning or end of the overall interval.

Parameters:

coverageIntervals - The intervals of coverage.

min - The minimum duration of a gap (in seconds).

max - The maximum duration of a gap (in seconds).

Returns:

The number of gaps which fall within the given bounds on gap duration.

Throws:

ArgumentNullException - Thrown when coverageIntervals is null.

timeAverageGap

public static double timeAverageGap(@Nonnull
                                    CoverageQueryResult coverageIntervals)

The time average length of gaps in coverage, computed as the sum of the square of the gap lengths all divided by the length of the interval of interest.

Parameters:

coverageIntervals - The intervals of coverage.

Returns:

The time average of all the gaps in coverage.

Throws:

ArgumentNullException - Thrown when coverageIntervals is null.