agi.foundation.navigation

(agi.foundation.navigation-2025r1.jar)

Class NavigationAccuracyAssessed

java.lang.Object

agi.foundation.navigation.NavigationAccuracyAssessed

public class NavigationAccuracyAssessed
extends Object

The NavigationAccuracyAssessed class calculates navigation accuracy based on Performance Assessment File (PAF) Data.

Constructor Summary

Constructors

Constructor and Description
NavigationAccuracyAssessed() Initializes a new instance with 0.0 for all accuracy values.
NavigationAccuracyAssessed(double xSignalInSpace, double ySignalInSpace, double zSignalInSpace, double xySignalInSpace, double positionSignalInSpace, double timeSignalInSpace, double xSignalInSpaceOneSigma, double ySignalInSpaceOneSigma, double zSignalInSpaceOneSigma, double xySignalInSpaceOneSigma, double positionSignalInSpaceOneSigma, double timeSignalInSpaceOneSigma, double xTotal, double yTotal, double zTotal, double xyTotal, double positionTotal, double timeTotal, List<SatelliteUserRangeError> userRangeErrors) Initializes a new instance from the specified position error and satellite user range errors.

Method Summary

Modifier and Type	Method and Description
static NavigationAccuracyAssessed	compute(Matrix3By3 receiverOrientation, DilutionOfPrecision dilutionOfPrecision, List<SatelliteUserRangeError> userRangeErrors, List<Double> receiverNoise) Computes assessed navigation accuracy.
PlatformCollection	getIncludedSatellites() Gets the collection of satellites included in the accuracy computation.
double	getPositionSignalInSpace() Gets the signal-in-space position error.
double	getPositionSignalInSpaceOneSigma() Gets the one sigma error associated with the position of the signal in space navigation error
double	getPositionTotal() Gets the total position error.
double	getTimeSignalInSpace() Gets the signal-in-space time error.
double	getTimeSignalInSpaceOneSigma() Gets the one sigma error associated with the time component of the signal in space navigation 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.
List<SatelliteUserRangeError>	getUserRangeErrors() Gets the collection of user range errors for the tracked satellites.
double	getValueByType(NavigationAccuracyAssessedType type) Get the specific value of assessed navigation accuracy by its type.
double	getXSignalInSpace() Gets the signal-in-space error in the X direction.
double	getXSignalInSpaceOneSigma() Gets the one sigma error associated with the x component of the signal in space navigation error
double	getXTotal() Gets the total error in the X direction.
double	getXYSignalInSpace() Gets the signal-in-space error in the XY (Horizontal) direction.
double	getXYSignalInSpaceOneSigma() Gets the one sigma error associated with the horizontal component of the signal in space navigation error
double	getXYTotal() Gets the total error in the XY (Horizontal) direction.
double	getYSignalInSpace() Gets the signal-in-space error in the Y direction.
double	getYSignalInSpaceOneSigma() Gets the one sigma error associated with the Y component of the signal in space navigation error
double	getYTotal() Gets the total error in the Y direction.
double	getZSignalInSpace() Gets the signal-in-space error in the Z direction.
double	getZSignalInSpaceOneSigma() Gets the one sigma error associated with the Z component of the signal in space navigation error
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	setPositionSignalInSpace(double value) Sets the signal-in-space position error.
void	setPositionSignalInSpaceOneSigma(double value) Sets the one sigma error associated with the position of the signal in space navigation error
void	setPositionTotal(double value) Sets the total position error.
void	setTimeSignalInSpace(double value) Sets the signal-in-space time error.
void	setTimeSignalInSpaceOneSigma(double value) Sets the one sigma error associated with the time component of the signal in space navigation error
void	setTimeTotal(double value) Sets the total time error.
void	setTrackedSatellitesNotIncluded(PlatformCollection value) Sets the collection of satellites tracked by the GpsReceiver but NOT included in the accuracy computation.
void	setUserRangeErrors(List<SatelliteUserRangeError> value) Sets the collection of user range errors for the tracked satellites.
void	setXSignalInSpace(double value) Sets the signal-in-space error in the X direction.
void	setXSignalInSpaceOneSigma(double value) Sets the one sigma error associated with the x component of the signal in space navigation error
void	setXTotal(double value) Sets the total error in the X direction.
void	setXYSignalInSpace(double value) Sets the signal-in-space error in the XY (Horizontal) direction.
void	setXYSignalInSpaceOneSigma(double value) Sets the one sigma error associated with the horizontal component of the signal in space navigation error
void	setXYTotal(double value) Sets the total error in the XY (Horizontal) direction.
void	setYSignalInSpace(double value) Sets the signal-in-space error in the Y direction.
void	setYSignalInSpaceOneSigma(double value) Sets the one sigma error associated with the Y component of the signal in space navigation error
void	setYTotal(double value) Sets the total error in the Y direction.
void	setZSignalInSpace(double value) Sets the signal-in-space error in the Z direction.
void	setZSignalInSpaceOneSigma(double value) Sets the one sigma error associated with the Z component of the signal in space navigation error
void	setZTotal(double value) Sets the total error in the Z direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationAccuracyAssessed

public NavigationAccuracyAssessed()

Initializes a new instance with 0.0 for all accuracy values.

NavigationAccuracyAssessed

public NavigationAccuracyAssessed(double xSignalInSpace,
                                  double ySignalInSpace,
                                  double zSignalInSpace,
                                  double xySignalInSpace,
                                  double positionSignalInSpace,
                                  double timeSignalInSpace,
                                  double xSignalInSpaceOneSigma,
                                  double ySignalInSpaceOneSigma,
                                  double zSignalInSpaceOneSigma,
                                  double xySignalInSpaceOneSigma,
                                  double positionSignalInSpaceOneSigma,
                                  double timeSignalInSpaceOneSigma,
                                  double xTotal,
                                  double yTotal,
                                  double zTotal,
                                  double xyTotal,
                                  double positionTotal,
                                  double timeTotal,
                                  List<SatelliteUserRangeError> userRangeErrors)

Initializes a new instance from the specified position error and satellite user range errors.

Parameters:

xSignalInSpace - The signal-in-space error in the X direction.

ySignalInSpace - The signal-in-space error in the Y direction.

zSignalInSpace - The signal-in-space error in the Z direction.

xySignalInSpace - The horizontal signal-in-space error.

positionSignalInSpace - The position signal-in-space error.

timeSignalInSpace - The time signal-in-space error.

xSignalInSpaceOneSigma - The one-sigma error of the signal-in-space navigation error in the X direction

ySignalInSpaceOneSigma - The one-sigma error of the signal-in-space navigation error in the Y direction

zSignalInSpaceOneSigma - The one-sigma error of the signal-in-space navigation error in the Z direction

xySignalInSpaceOneSigma - The one-sigma error of the signal-in-space horizontal navigation error

positionSignalInSpaceOneSigma - The one-sigma error of the signal-in-space position navigation error

timeSignalInSpaceOneSigma - The one-sigma error of the signal-in-space time error

xTotal - The total navigation error in the X direction

yTotal - The total navigation error in the Y direction

zTotal - The total navigation error in the Z direction

xyTotal - The total horizontal navigation error

positionTotal - The total position navigation error

timeTotal - The total time error

userRangeErrors - The list of user range errors used in determining the navigation error

Method Detail

compute

@Nonnull
public static NavigationAccuracyAssessed compute(@Nonnull
                                                           Matrix3By3 receiverOrientation,
                                                           @Nonnull
                                                           DilutionOfPrecision dilutionOfPrecision,
                                                           @Nonnull
                                                           List<SatelliteUserRangeError> userRangeErrors,
                                                           @Nonnull
                                                           List<Double> receiverNoise)

Computes assessed navigation accuracy.

The IncludedSatellites (get / set) and TrackedSatellitesNotIncluded (get / set) properties of the returned instance are set to null.

Parameters:

receiverOrientation - The orientation of the receiver relative to the axes in which the userRangeErrors are defined.

dilutionOfPrecision - The dilution of precision (DOP) for the satellites to consider.

userRangeErrors - The user range error for each satellite to consider. This list must have an entry for each satellite that was used to compute the dilutionOfPrecision.

receiverNoise - For each satellite to consider, the total noise, in meters, receiving the signal. The list must have an entry for each satellite that was used to compute the dilutionOfPrecision.

Returns:

The assessed navigation accuracy.

Throws:

ArgumentException - Thrown when the receiverNoise or userRangeErrors collections do not have the same number of elements as were used to compute the dilutionOfPrecision.

getXSignalInSpace

public final double getXSignalInSpace()

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

setXSignalInSpace

public final void setXSignalInSpace(double value)

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

getYSignalInSpace

public final double getYSignalInSpace()

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

setYSignalInSpace

public final void setYSignalInSpace(double value)

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

getZSignalInSpace

public final double getZSignalInSpace()

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

setZSignalInSpace

public final void setZSignalInSpace(double value)

Sets 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.

setXYSignalInSpace

public final void setXYSignalInSpace(double value)

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

getPositionSignalInSpace

public final double getPositionSignalInSpace()

Gets the signal-in-space position error.

setPositionSignalInSpace

public final void setPositionSignalInSpace(double value)

Sets the signal-in-space position error.

getTimeSignalInSpace

public final double getTimeSignalInSpace()

Gets the signal-in-space time error.

setTimeSignalInSpace

public final void setTimeSignalInSpace(double value)

Sets the signal-in-space time error.

getXTotal

public final double getXTotal()

Gets the total error in the X direction.

setXTotal

public final void setXTotal(double value)

Sets the total error in the X direction.

getYTotal

public final double getYTotal()

Gets the total error in the Y direction.

setYTotal

public final void setYTotal(double value)

Sets the total error in the Y direction.

getZTotal

public final double getZTotal()

Gets the total error in the Z direction.

setZTotal

public final void setZTotal(double value)

Sets the total error in the Z direction.

getXYTotal

public final double getXYTotal()

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

setXYTotal

public final void setXYTotal(double value)

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

getPositionTotal

public final double getPositionTotal()

Gets the total position error.

setPositionTotal

public final void setPositionTotal(double value)

Sets the total position error.

getTimeTotal

public final double getTimeTotal()

Gets the total time error.

setTimeTotal

public final void setTimeTotal(double value)

Sets the total time error.

getUserRangeErrors

public final List<SatelliteUserRangeError> getUserRangeErrors()

Gets the collection of user range errors for the tracked satellites.

Each entry in this list corresponds to a satellite in the IncludedSatellites (get / set) collection. For example, the first satellite in IncludedSatellites (get / set) has the first user range error int this collection. The second satellite in IncludedSatellites (get / set) has the second user range error in this collection. And so on.

setUserRangeErrors

public final void setUserRangeErrors(List<SatelliteUserRangeError> value)

Sets the collection of user range errors for the tracked satellites.

Each entry in this list corresponds to a satellite in the IncludedSatellites (get / set) collection. For example, the first satellite in IncludedSatellites (get / set) has the first user range error int this collection. The second satellite in IncludedSatellites (get / set) has the second user range error in this collection. And so on.

getXSignalInSpaceOneSigma

public final double getXSignalInSpaceOneSigma()

Gets the one sigma error associated with the x component of the signal in space navigation error

setXSignalInSpaceOneSigma

public final void setXSignalInSpaceOneSigma(double value)

Sets the one sigma error associated with the x component of the signal in space navigation error

getYSignalInSpaceOneSigma

public final double getYSignalInSpaceOneSigma()

Gets the one sigma error associated with the Y component of the signal in space navigation error

setYSignalInSpaceOneSigma

public final void setYSignalInSpaceOneSigma(double value)

Sets the one sigma error associated with the Y component of the signal in space navigation error

getZSignalInSpaceOneSigma

public final double getZSignalInSpaceOneSigma()

Gets the one sigma error associated with the Z component of the signal in space navigation error

setZSignalInSpaceOneSigma

public final void setZSignalInSpaceOneSigma(double value)

Sets the one sigma error associated with the Z component of the signal in space navigation error

getTimeSignalInSpaceOneSigma

public final double getTimeSignalInSpaceOneSigma()

Gets the one sigma error associated with the time component of the signal in space navigation error

setTimeSignalInSpaceOneSigma

public final void setTimeSignalInSpaceOneSigma(double value)

Sets the one sigma error associated with the time component of the signal in space navigation error

getPositionSignalInSpaceOneSigma

public final double getPositionSignalInSpaceOneSigma()

Gets the one sigma error associated with the position of the signal in space navigation error

setPositionSignalInSpaceOneSigma

public final void setPositionSignalInSpaceOneSigma(double value)

Sets the one sigma error associated with the position of the signal in space navigation error

getXYSignalInSpaceOneSigma

public final double getXYSignalInSpaceOneSigma()

Gets the one sigma error associated with the horizontal component of the signal in space navigation error

setXYSignalInSpaceOneSigma

public final void setXYSignalInSpaceOneSigma(double value)

Sets the one sigma error associated with the horizontal component of the signal in space navigation error

getValueByType

public final double getValueByType(@Nonnull
                                   NavigationAccuracyAssessedType type)

Get the specific value of assessed navigation accuracy by its type.

Parameters:

type - The NavigationAccuracyAssessed type used to return the value.

Returns:

Returns the property corresponding to the given type of NavigationAccuracyAssessed.

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 PerformanceAssessmentField is not available for the satellite at the JulianDate for which accuracy is being computed.

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 PerformanceAssessmentField is not available for the satellite at the JulianDate for which accuracy is being computed.

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 PerformanceAssessmentField is not available for the satellite at the JulianDate for which accuracy is being computed.

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 PerformanceAssessmentField is not available for the satellite at the JulianDate for which accuracy is being computed.