agi.foundation.propagators

Class Sgp4Propagator.Sgp4EstimationInput

java.lang.Object

agi.foundation.propagators.Sgp4Propagator.Sgp4EstimationInput

Enclosing class:

Sgp4Propagator

public static class Sgp4Propagator.Sgp4EstimationInput
extends Object

A class containing configuration information for the static estimation methods available on the Sgp4Propagator.

Constructor Summary

Constructors

Constructor and Description
Sgp4EstimationInput(JulianDate requestedEstimationEpoch) Initializes a new instance with the given requestedEstimationEpoch for the estimated Sgp4Elements.

Method Summary

Modifier and Type	Method and Description
boolean	getAllowEstimationEpochDuringLeapSecond() Gets a value indicating whether to allow the estimation epoch to occur during a leap second.
double	getBStarDragValue() Gets the value for the BSTAR drag value to use for the Sgp4Elements.
double	getConvergenceTolerance() Gets the convergence tolerance to use when solving.
int	getMaxIterations() Gets the maximum iterations to perform when solving.
JulianDate	getRequestedEstimationEpoch() Gets the requested epoch for the estimated Sgp4Elements.
boolean	getSolveForDrag() Gets a value indicating whether to attempt to solve for the BSTAR drag value.
void	setAllowEstimationEpochDuringLeapSecond(boolean value) Sets a value indicating whether to allow the estimation epoch to occur during a leap second.
void	setBStarDragValue(double value) Sets the value for the BSTAR drag value to use for the Sgp4Elements.
void	setConvergenceTolerance(double value) Sets the convergence tolerance to use when solving.
void	setMaxIterations(int value) Sets the maximum iterations to perform when solving.
void	setRequestedEstimationEpoch(JulianDate value) Sets the requested epoch for the estimated Sgp4Elements.
void	setSolveForDrag(boolean value) Sets a value indicating whether to attempt to solve for the BSTAR drag value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sgp4EstimationInput

public Sgp4EstimationInput(@Nonnull
                           JulianDate requestedEstimationEpoch)

Initializes a new instance with the given requestedEstimationEpoch for the estimated Sgp4Elements.

Parameters:

requestedEstimationEpoch - The requested epoch for the estimated Sgp4Elements. The actual Epoch (get / set) of the Sgp4Propagator.Sgp4EstimationOutput may not be what was input if the input lies within the interval of a leap second. See the AllowEstimationEpochDuringLeapSecond (get / set) property for more information.

Method Detail

getRequestedEstimationEpoch

@Nonnull
public final JulianDate getRequestedEstimationEpoch()

Gets the requested epoch for the estimated Sgp4Elements. The actual Epoch (get / set) of the Sgp4Propagator.Sgp4EstimationOutput may not be what was input if the input lies within the interval of a leap second. See the AllowEstimationEpochDuringLeapSecond (get / set) property for more information.

setRequestedEstimationEpoch

public final void setRequestedEstimationEpoch(@Nonnull
                                              JulianDate value)

Sets the requested epoch for the estimated Sgp4Elements. The actual Epoch (get / set) of the Sgp4Propagator.Sgp4EstimationOutput may not be what was input if the input lies within the interval of a leap second. See the AllowEstimationEpochDuringLeapSecond (get / set) property for more information.

getAllowEstimationEpochDuringLeapSecond

public final boolean getAllowEstimationEpochDuringLeapSecond()

Gets a value indicating whether to allow the estimation epoch to occur during a leap second. By default, this value is false. If false and the RequestedEstimationEpoch (get / set) occurs during a leap second, the epoch of the estimated Sgp4Elements will occur one second later than the requested epoch, as per NASA's CDF standards, so that the estimated elements are representable in the TwoLineElementSet format. If true, the RequestedEstimationEpoch (get / set) is honored. In which case, the estimated Sgp4Elements may not be representable in the TwoLineElementSet format.

setAllowEstimationEpochDuringLeapSecond

public final void setAllowEstimationEpochDuringLeapSecond(boolean value)

Sets a value indicating whether to allow the estimation epoch to occur during a leap second. By default, this value is false. If false and the RequestedEstimationEpoch (get / set) occurs during a leap second, the epoch of the estimated Sgp4Elements will occur one second later than the requested epoch, as per NASA's CDF standards, so that the estimated elements are representable in the TwoLineElementSet format. If true, the RequestedEstimationEpoch (get / set) is honored. In which case, the estimated Sgp4Elements may not be representable in the TwoLineElementSet format.

getMaxIterations

public final int getMaxIterations()

Gets the maximum iterations to perform when solving. By default, the value is 20.

setMaxIterations

public final void setMaxIterations(int value)

Sets the maximum iterations to perform when solving. By default, the value is 20.

getConvergenceTolerance

public final double getConvergenceTolerance()

Gets the convergence tolerance to use when solving. By default, the value is 1e-4. This is used to determine when the normalized root mean square error of the residuals has converged.

setConvergenceTolerance

public final void setConvergenceTolerance(double value)

Sets the convergence tolerance to use when solving. By default, the value is 1e-4. This is used to determine when the normalized root mean square error of the residuals has converged.

getSolveForDrag

public final boolean getSolveForDrag()

Gets a value indicating whether to attempt to solve for the BSTAR drag value. By default, this value is true. If false, the system will use the BStarDragValue (get / set).

setSolveForDrag

public final void setSolveForDrag(boolean value)

Sets a value indicating whether to attempt to solve for the BSTAR drag value. By default, this value is true. If false, the system will use the BStarDragValue (get / set).

getBStarDragValue

public final double getBStarDragValue()

Gets the value for the BSTAR drag value to use for the Sgp4Elements. If SolveForDrag (get / set) is false, this value of BSTAR will not be modified when solving for the resulting elements. This is useful in cases where trying to solve for BSTAR may cause instability in the least squares iterations. By default, this value is zero.

setBStarDragValue

public final void setBStarDragValue(double value)

Sets the value for the BSTAR drag value to use for the Sgp4Elements. If SolveForDrag (get / set) is false, this value of BSTAR will not be modified when solving for the resulting elements. This is useful in cases where trying to solve for BSTAR may cause instability in the least squares iterations. By default, this value is zero.