agi.foundation.navigation

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

Class NavigationAccuracyPredicted

java.lang.Object

agi.foundation.navigation.NavigationAccuracyPredicted

public class NavigationAccuracyPredicted
extends Object

The NavigationAccuracyPredicted class calculates navigation accuracy based on Prediction Support File (PSF) Data.

PSF files support statistical predictions of Navigation Accuracy - the errors reported are 1-sigma errors for predicted navigation accuracy. The confidence levels associated with the predictions are based off of standard multi-variate statistics. For example, for the predicted error in the vertical direction, a one-dimensional quantity, the 1-sigma error reported has a confidence value of 68% associated with it. On the other hand, the 1-sigma error reported for the position, a three-dimensional quantity, has a confidence level of 19% associated with it.

Constructor Summary

Constructors

Constructor and Description
NavigationAccuracyPredicted() Initializes a new instance with 0.0 for all accuracy values.
NavigationAccuracyPredicted(double xSignalInSpace, double ySignalInSpace, double zSignalInSpace, double xySignalInSpace, double positionSignalInSpace, double timeSignalInSpace, double xTotal, double yTotal, double zTotal, double xyTotal, double positionTotal, double timeTotal) Initializes a new instance from the specified position errors.

Method Summary

Modifier and Type	Method and Description
static NavigationAccuracyPredicted	compute(DilutionOfPrecision dilutionOfPrecision, List<PredictionSupportRecord> predictionSupportRecords, List<Double> receiverNoise) Computes predicted navigation accuracy.
PlatformCollection	getIncludedSatellites() Gets the collection of satellites included in the accuracy computation.
double	getPositionSignalInSpace() Gets the signal-in-space position error.
double	getPositionTotal() Gets the total position error.
double	getTimeSignalInSpace() Gets the signal-in-space time error.
double	getTimeTotal() Gets the total time error.
PlatformCollection	getTrackedSatellitesNotIncluded() Gets the collection of satellites tracked by the GpsReceiver but NOT included in the accuracy computation.
double	getValueByType(NavigationAccuracyPredictedType type) Get the specific value of NavigationAccuracyPredicted by its type.
double	getXSignalInSpace() Gets the signal-in-space error in the X direction.
double	getXTotal() Gets the total error in the X direction.
double	getXYSignalInSpace() Gets the signal-in-space error in the XY (Horizontal) direction.
double	getXYTotal() Gets the total error in the XY (Horizontal) direction.
double	getYSignalInSpace() Gets the signal-in-space error in the Y direction.
double	getYTotal() Gets the total error in the Y direction.
double	getZSignalInSpace() Gets the signal-in-space error in the Z direction.
double	getZTotal() Gets the total error in the Z direction.
void	setIncludedSatellites(PlatformCollection value) Sets the collection of satellites included in the accuracy computation.
void	setTrackedSatellitesNotIncluded(PlatformCollection value) Sets the collection of satellites tracked by the GpsReceiver but NOT included in the accuracy computation.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationAccuracyPredicted

public NavigationAccuracyPredicted()

Initializes a new instance with 0.0 for all accuracy values.

NavigationAccuracyPredicted

public NavigationAccuracyPredicted(double xSignalInSpace,
                                   double ySignalInSpace,
                                   double zSignalInSpace,
                                   double xySignalInSpace,
                                   double positionSignalInSpace,
                                   double timeSignalInSpace,
                                   double xTotal,
                                   double yTotal,
                                   double zTotal,
                                   double xyTotal,
                                   double positionTotal,
                                   double timeTotal)

Initializes a new instance from the specified position errors.

Parameters:

xSignalInSpace - The predicted signal-in-space navigation error in the X direction

ySignalInSpace - The predicted signal-in-space navigation error in the Y direction

zSignalInSpace - The predicted signal-in-space navigation error in the Z direction

xySignalInSpace - The predicted horizontal signal-in-space navigation error

positionSignalInSpace - The predicted position signal-in-space navigation error

timeSignalInSpace - The predicted signal-in-space time error

xTotal - The predicted total navigation error in the X direction

yTotal - The predicted total navigation error in the Y direction

zTotal - The predicted total navigation error in the Z direction

xyTotal - The predicted total horizontal navigation error

positionTotal - The predicted total position navigation error

timeTotal - The predicted total time error

Method Detail

compute

@Nonnull
public static NavigationAccuracyPredicted compute(@Nonnull
                                                            DilutionOfPrecision dilutionOfPrecision,
                                                            @Nonnull
                                                            List<PredictionSupportRecord> predictionSupportRecords,
                                                            @Nonnull
                                                            List<Double> receiverNoise)

Computes predicted navigation accuracy.

Parameters:

dilutionOfPrecision - The dilution of precision (DOP) for the configuration of GPS satellites.

predictionSupportRecords - For each satellite to consider, a prediction support record used to predict the performance of the satellite.

receiverNoise - For each satellite to consider, the total noise, in meters, receiving the signal. The list must have an entry for each entry in predictionSupportRecords.

Returns:

The predicted navigation accuracy.

Throws:

ArgumentException - Thrown when the receiverNoise parameter does not have the same number of elements as the predictionSupportRecords parameter.

IllegalStateException - Thrown when predictionSupportRecords contains a null reference to a PredictionSupportRecord.

getXSignalInSpace

public final double getXSignalInSpace()

Gets the signal-in-space error in the X direction.

getYSignalInSpace

public final double getYSignalInSpace()

Gets the signal-in-space error in the Y direction.

getZSignalInSpace

public final double getZSignalInSpace()

Gets the signal-in-space error in the Z direction.

getXYSignalInSpace

public final double getXYSignalInSpace()

Gets the signal-in-space error in the XY (Horizontal) direction.

getPositionSignalInSpace

public final double getPositionSignalInSpace()

Gets the signal-in-space position error.

getTimeSignalInSpace

public final double getTimeSignalInSpace()

Gets the signal-in-space time error.

getXTotal

public final double getXTotal()

Gets the total error in the X direction.

getYTotal

public final double getYTotal()

Gets the total error in the Y direction.

getZTotal

public final double getZTotal()

Gets the total error in the Z direction.

getXYTotal

public final double getXYTotal()

Gets the total error in the XY (Horizontal) direction.

getPositionTotal

public final double getPositionTotal()

Gets the total position error.

getTimeTotal

public final double getTimeTotal()

Gets the total time error.

getValueByType

public final double getValueByType(@Nonnull
                                   NavigationAccuracyPredictedType type)

Get the specific value of NavigationAccuracyPredicted by its type.

Parameters:

type - The type of NavigationAccuracyPredicted.

Returns:

Returns the property corresponding to the given type of NavigationAccuracyPredicted.

getIncludedSatellites

public final PlatformCollection getIncludedSatellites()

Gets the collection of satellites included in the accuracy computation.

Generally, this includes all satellites tracked by the GpsReceiver. However, a tracked satellite might not be included if a PredictionSupportRecord is not available for the satellite.

setIncludedSatellites

public final void setIncludedSatellites(PlatformCollection value)

Sets the collection of satellites included in the accuracy computation.

Generally, this includes all satellites tracked by the GpsReceiver. However, a tracked satellite might not be included if a PredictionSupportRecord is not available for the satellite.

getTrackedSatellitesNotIncluded

public final PlatformCollection getTrackedSatellitesNotIncluded()

Gets the collection of satellites tracked by the GpsReceiver but NOT included in the accuracy computation.

Generally, this collection is empty. However, a tracked satellite might not be included if a PredictionSupportRecord is not available for the satellite.

setTrackedSatellitesNotIncluded

public final void setTrackedSatellitesNotIncluded(PlatformCollection value)

Sets the collection of satellites tracked by the GpsReceiver but NOT included in the accuracy computation.

Generally, this collection is empty. However, a tracked satellite might not be included if a PredictionSupportRecord is not available for the satellite.