agi.foundation.navigation

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

Class ConfidenceInterval

java.lang.Object

agi.foundation.navigation.ConfidenceInterval

All Implemented Interfaces:

ICloneWithContext

public class ConfidenceInterval
extends Object
implements ICloneWithContext

Provides confidence interval multiplier methods. Confidence interval multipliers are necessary to convert one sigma values generated by statistical navigation error predictions into a more meaningful scale. For example, a statistically predicted position error (a three dimensional quantity) has a one sigma confidence value of approximately 20%. To convert that one sigma value to a 95% confidence, it must be multiplied by a certain value. This class provides the multiplier values necessary to get to a specific confidence interval.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConfidenceInterval() Create a new instance.
	ConfidenceInterval(BufferedReader customMultiplierReader) Create a new ConfidenceInterval instance with a custom multiplier BufferedReader.
protected	ConfidenceInterval(ConfidenceInterval existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
Object	clone(CopyContext context) Clones this object using the specified context.
double	convertToGaussianConfidence(double value, int confidenceLevel, ConfidenceIntervalVariableDimension dimension) Converts a one standard deviation value to a given confidence level using the standard Gaussian derived multipliers, for the specified dimension.
double	convertToGlobalPositioningSystemConfidence(double value, int confidenceLevel, ConfidenceIntervalVariableDimension dimension) Converts a root mean square predicted GPS error value to a given confidence level using the GPS multipliers for a specific prediction type and specified variable dimension.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfidenceInterval

public ConfidenceInterval()

Create a new instance.

ConfidenceInterval

public ConfidenceInterval(@Nonnull
                          BufferedReader customMultiplierReader)

Create a new ConfidenceInterval instance with a custom multiplier BufferedReader.

The custom multiplier file must contain 101 lines, in a comma separated format. Each line must have exactly 4 entries. The first is the percentile to which the multipliers apply, the second is the one dimensional multiplier, the third is the two dimensional multiplier, and the fourth is the three dimensional multiplier. For example:

    100,3.000000000000000,2.750000000000000,2.500000000000000
    99,1.304925878948565,1.215418007158116,1.179820420543097
    98,1.181172351813840,1.117930688085218,1.068490729353685
    ...
    2,0.012647494820718,0.074148200000000,0.095101178097374
    1,0.006344699608901,0.052209500000000,0.074491500000000
    0,0.000000000000000,0.000000000000000,0.010000000000000

Parameters:

customMultiplierReader - Reader to the custom multiplier file

Throws:

ArgumentNullException - Thrown when customMultiplierReader is null.

ConfidenceInterval

protected ConfidenceInterval(@Nonnull
                             ConfidenceInterval existingInstance,
                             @Nonnull
                             CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

Specified by:

clone in interface ICloneWithContext

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

convertToGaussianConfidence

public final double convertToGaussianConfidence(double value,
                                                int confidenceLevel,
                                                @Nonnull
                                                ConfidenceIntervalVariableDimension dimension)

Converts a one standard deviation value to a given confidence level using the standard Gaussian derived multipliers, for the specified dimension.

Parameters:

value - The root mean square value to convert

confidenceLevel - The confidence level to convert to (0-100)%

dimension - The dimension of the variable

Returns:

The value converted to the requested confidence level

Throws:

ArgumentOutOfRangeException - Thrown when the confidenceLevel is outside of the range [0, 100].

convertToGlobalPositioningSystemConfidence

public final double convertToGlobalPositioningSystemConfidence(double value,
                                                               int confidenceLevel,
                                                               @Nonnull
                                                               ConfidenceIntervalVariableDimension dimension)

Converts a root mean square predicted GPS error value to a given confidence level using the GPS multipliers for a specific prediction type and specified variable dimension.

This method is intended to be used with the output of the evaluator obtained from GpsReceiver.getNavigationAccuracyPredictedEvaluator(agi.foundation.navigation.datareaders.PredictionSupportFile).

Parameters:

value - The root mean square value to convert

confidenceLevel - The confidence level to convert to (0-100)%

dimension - The dimension of the variable

Returns:

The value converted to the requested confidence level

Throws:

ArgumentOutOfRangeException - Thrown when the confidenceLevel is outside of the range [0, 100].