Package org.orekit.files.ccsds.ndm.odm.ocm

Class OrbitDetermination

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.ndm.odm.ocm.OrbitDetermination
All Implemented Interfaces:
Section
public class OrbitDetermination extends CommentsContainer
Orbit determination data.

Beware that the Orekit getters and setters all rely on SI units. The parsers and writers take care of converting these SI units into CCSDS mandatory units. The Unit class provides useful fromSi and toSI methods in case the callers already use CCSDS units instead of the API SI units. The general-purpose Unit class (without an 's') and the CCSDS-specific Units class (with an 's') also provide some predefined units. These predefined units and the fromSi and toSI conversion methods are indeed what the parsers and writers use for the conversions.

Since:
11.0
Author:
Luc Maisonobe

  • Constructor Details

    • OrbitDetermination

      public OrbitDetermination()
      Simple constructor.

  • Method Details

    • validate

      public void validate(double version)
      Check is all mandatory entries have been initialized.

      This method should throw an exception if some mandatory entries are missing or not compatible with version number.

      Specified by:
      validate in interface Section
      Overrides:
      validate in class CommentsContainer
      Parameters:
      version - format version

    • getId

      public String getId()
      Get identification number.
      Returns:
      identification number

    • setId

      public void setId(String id)
      Set identification number.
      Parameters:
      id - identification number

    • getPrevId

      public String getPrevId()
      Get identification of previous orbit determination.
      Returns:
      identification of previous orbit determination

    • setPrevId

      public void setPrevId(String prevId)
      Set identification of previous orbit determination.
      Parameters:
      prevId - identification of previous orbit determination

    • getMethod

      public OdMethodFacade getMethod()
      Get orbit determination method.
      Returns:
      orbit determination method

    • setMethod

      public void setMethod(OdMethodFacade method)
      Set orbit determination method.
      Parameters:
      method - orbit determination method

    • getEpoch

      public AbsoluteDate getEpoch()
      Get time tag for orbit determination solved-for state.
      Returns:
      time tag for orbit determination solved-for state

    • setEpoch

      public void setEpoch(AbsoluteDate epoch)
      Set time tag for orbit determination solved-for state.
      Parameters:
      epoch - time tag for orbit determination solved-for state

    • getTimeSinceFirstObservation

      public double getTimeSinceFirstObservation()
      Get time elapsed between first accepted observation on epoch.
      Returns:
      time elapsed between first accepted observation on epoch

    • setTimeSinceFirstObservation

      public void setTimeSinceFirstObservation(double timeSinceFirstObservation)
      Set time elapsed between first accepted observation on epoch.
      Parameters:
      timeSinceFirstObservation - time elapsed between first accepted observation on epoch

    • getTimeSinceLastObservation

      public double getTimeSinceLastObservation()
      Get time elapsed between last accepted observation on epoch.
      Returns:
      time elapsed between last accepted observation on epoch

    • setTimeSinceLastObservation

      public void setTimeSinceLastObservation(double timeSinceLastObservation)
      Set time elapsed between last accepted observation on epoch.
      Parameters:
      timeSinceLastObservation - time elapsed between last accepted observation on epoch

    • getRecommendedOdSpan

      public double getRecommendedOdSpan()
      Get time span of observation recommended for the OD of the object.
      Returns:
      time span of observation recommended for the OD of the object

    • setRecommendedOdSpan

      public void setRecommendedOdSpan(double recommendedOdSpan)
      Set time span of observation recommended for the OD of the object.
      Parameters:
      recommendedOdSpan - time span of observation recommended for the OD of the object

    • getActualOdSpan

      public double getActualOdSpan()
      Get actual time span used for the OD of the object.
      Returns:
      actual time span used for the OD of the object

    • setActualOdSpan

      public void setActualOdSpan(double actualOdSpan)
      Set actual time span used for the OD of the object.
      Parameters:
      actualOdSpan - actual time span used for the OD of the object

    • getObsAvailable

      public Integer getObsAvailable()
      Get number of observations available within the actual OD span.
      Returns:
      number of observations available within the actual OD span

    • setObsAvailable

      public void setObsAvailable(Integer obsAvailable)
      Set number of observations available within the actual OD span.
      Parameters:
      obsAvailable - number of observations available within the actual OD span

    • getObsUsed

      public Integer getObsUsed()
      Get number of observations accepted within the actual OD span.
      Returns:
      number of observations accepted within the actual OD span

    • setObsUsed

      public void setObsUsed(Integer obsUsed)
      Set number of observations accepted within the actual OD span.
      Parameters:
      obsUsed - number of observations accepted within the actual OD span

    • getTracksAvailable

      public Integer getTracksAvailable()
      Get number of sensors tracks available for the OD within the actual OD span.
      Returns:
      number of sensors tracks available for the OD within the actual OD span

    • setTracksAvailable

      public void setTracksAvailable(Integer tracksAvailable)
      Set number of sensors tracks available for the OD within the actual OD span.
      Parameters:
      tracksAvailable - number of sensors tracks available for the OD within the actual OD span

    • getTracksUsed

      public Integer getTracksUsed()
      Get number of sensors tracks accepted for the OD within the actual OD span.
      Returns:
      number of sensors tracks accepted for the OD within the actual OD span

    • setTracksUsed

      public void setTracksUsed(Integer tracksUsed)
      Set number of sensors tracks accepted for the OD within the actual OD span.
      Parameters:
      tracksUsed - number of sensors tracks accepted for the OD within the actual OD span

    • getMaximumObsGap

      public double getMaximumObsGap()
      Get maximum time between observations in the OD of the object.
      Returns:
      maximum time between observations in the OD of the object

    • setMaximumObsGap

      public void setMaximumObsGap(double maximumObsGap)
      Set maximum time between observations in the OD of the object.
      Parameters:
      maximumObsGap - maximum time between observations in the OD of the object

    • getEpochEigenMaj

      public double getEpochEigenMaj()
      Get positional error ellipsoid 1σ major eigenvalue at the epoch of OD.
      Returns:
      positional error ellipsoid 1σ major eigenvalue at the epoch of OD

    • setEpochEigenMaj

      public void setEpochEigenMaj(double epochEigenMaj)
      Set positional error ellipsoid 1σ major eigenvalue at the epoch of OD.
      Parameters:
      epochEigenMaj - positional error ellipsoid 1σ major eigenvalue at the epoch of OD

    • getEpochEigenInt

      public double getEpochEigenInt()
      Get positional error ellipsoid 1σ intermediate eigenvalue at the epoch of OD.
      Returns:
      positional error ellipsoid 1σ intermediate eigenvalue at the epoch of OD

    • setEpochEigenInt

      public void setEpochEigenInt(double epochEigenInt)
      Set positional error ellipsoid 1σ intermediate eigenvalue at the epoch of OD.
      Parameters:
      epochEigenInt - positional error ellipsoid 1σ intermediate eigenvalue at the epoch of OD

    • getEpochEigenMin

      public double getEpochEigenMin()
      Get positional error ellipsoid 1σ minor eigenvalue at the epoch of OD.
      Returns:
      positional error ellipsoid 1σ minor eigenvalue at the epoch of OD

    • setEpochEigenMin

      public void setEpochEigenMin(double epochEigenMin)
      Set positional error ellipsoid 1σ minor eigenvalue at the epoch of OD.
      Parameters:
      epochEigenMin - positional error ellipsoid 1σ minor eigenvalue at the epoch of OD

    • getMaxPredictedEigenMaj

      public double getMaxPredictedEigenMaj()
      Get maximum predicted major eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM.
      Returns:
      maximum predicted major eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM

    • setMaxPredictedEigenMaj

      public void setMaxPredictedEigenMaj(double maxPredictedEigenMaj)
      Set maximum predicted major eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM.
      Parameters:
      maxPredictedEigenMaj - maximum predicted major eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM

    • getMinPredictedEigenMin

      public double getMinPredictedEigenMin()
      Get minimum predicted minor eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM.
      Returns:
      minimum predicted v eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM

    • setMinPredictedEigenMin

      public void setMinPredictedEigenMin(double minPredictedEigenMin)
      Set minimum predicted minor eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM.
      Parameters:
      minPredictedEigenMin - minimum predicted minor eigenvalue of 1σ positional error ellipsoid over entire time span of the OCM

    • getConfidence

      public double getConfidence()
      Get confidence metric.
      Returns:
      confidence metric

    • setConfidence

      public void setConfidence(double confidence)
      Set confidence metric.
      Parameters:
      confidence - confidence metric

    • getGdop

      public double getGdop()
      Get generalize Dilution Of Precision.
      Returns:
      generalize Dilution Of Precision

    • setGdop

      public void setGdop(double gdop)
      Set generalize Dilution Of Precision.
      Parameters:
      gdop - generalize Dilution Of Precision

    • getSolveN

      public Integer getSolveN()
      Get number of solved-for states.
      Returns:
      number of solved-for states

    • setSolveN

      public void setSolveN(Integer solveN)
      Set number of solved-for states.
      Parameters:
      solveN - number of solved-for states

    • getSolveStates

      public List<String> getSolveStates()
      Get description of state elements solved-for.
      Returns:
      description of state elements solved-for

    • setSolveStates

      public void setSolveStates(List<String> solveStates)
      Set description of state elements solved-for.
      Parameters:
      solveStates - description of state elements solved-for

    • getConsiderN

      public Integer getConsiderN()
      Get number of consider parameters.
      Returns:
      number of consider parameters

    • setConsiderN

      public void setConsiderN(Integer considerN)
      Set number of consider parameters.
      Parameters:
      considerN - number of consider parameters

    • getConsiderParameters

      public List<String> getConsiderParameters()
      Get description of consider parameters.
      Returns:
      description of consider parameters

    • setConsiderParameters

      public void setConsiderParameters(List<String> considerParameters)
      Set description of consider parameters.
      Parameters:
      considerParameters - description of consider parameters

    • getSedr

      public double getSedr()
      Get Specific Energy Dissipation Rate.
      Returns:
      Specific Energy Dissipation Rate
      Since:
      12.0

    • setSedr

      public void setSedr(double sedr)
      Set Specific Energy Dissipation Rate.
      Parameters:
      sedr - Specific Energy Dissipation Rate (W/kg)
      Since:
      12.0

    • getSensorsN

      public Integer getSensorsN()
      Get number of sensors used.
      Returns:
      number of sensors used

    • setSensorsN

      public void setSensorsN(Integer sensorsN)
      Set number of sensors used.
      Parameters:
      sensorsN - number of sensors used

    • getSensors

      public List<String> getSensors()
      Get description of sensors used.
      Returns:
      description of sensors used

    • setSensors

      public void setSensors(List<String> sensors)
      Set description of sensors used.
      Parameters:
      sensors - description of sensors used

    • getWeightedRms

      public double getWeightedRms()
      Get weighted RMS residual ratio.
      Returns:
      weighted RMS residual ratio

    • setWeightedRms

      public void setWeightedRms(double weightedRms)
      Set weighted RMS residual ratio.
      Parameters:
      weightedRms - weighted RMS residual ratio

    • getDataTypes

      public List<String> getDataTypes()
      Get observation data types used.
      Returns:
      observation data types used

    • setDataTypes

      public void setDataTypes(List<String> dataTypes)
      Set observation data types used.
      Parameters:
      dataTypes - observation data types used