Package org.orekit.files.ccsds.ndm.cdm

Class SigmaEigenvectorsCovariance

java.lang.Object

org.orekit.files.ccsds.section.CommentsContainer

org.orekit.files.ccsds.ndm.cdm.SigmaEigenvectorsCovariance

All Implemented Interfaces:

Section

public class SigmaEigenvectorsCovariance
extends CommentsContainer

Container for Sigma/Eigenvectors Covariance 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.

The positional covariance one-sigma dispersions corresponding to the major, intermediate and minor eigenvalues, followed by the associated eigenvectors. The data is presented on a single line (12 values separated by spaces). (Condition: Mandatory if ALT_COV_TYPE = CSIG3EIGVEC3)

Constructor Summary

Constructors

Constructor	Description
SigmaEigenvectorsCovariance(boolean altCovFlag)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
double[]	getCsig3eigvec3()	Get the Sigma/Eigenvectors Covariance data.
boolean	isAltCovFlagSet()	Get the flag indicating whether the alternate covariance type set in the CDM Object metadata section is Sigma/Eigenvectors Covariance.
void	setCsig3eigvec3(double[] csig3eigvec3)	Set the Sigma/Eigenvectors Covariance data.
void	validate(double version)	Check is all mandatory entries have been initialized.

Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer

acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments, setComments

Methods inherited from class java.lang.Object

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

Constructor Details

SigmaEigenvectorsCovariance

public SigmaEigenvectorsCovariance(boolean altCovFlag)

Simple constructor.

The Sigma/Eigenvectors Covariance data is only provided if CdmMetadataKey.ALT_COV_TYPE is AltCovarianceType.CSIG3EIGVEC3, otherwise its terms will return NaN.

Parameters:

altCovFlag - Flag indicating whether the alternate covariance type set in the CDM Object metadata section is Sigma/Eigenvectors Covariance.

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

getCsig3eigvec3

public double[] getCsig3eigvec3()

Get the Sigma/Eigenvectors Covariance data.

The Sigma/Eigenvectors Covariance data is only provided if CdmMetadataKey.ALT_COV_TYPE is AltCovarianceType.CSIG3EIGVEC3, otherwise its terms will return NaN.

Returns:

covarianceData the covariance data in the Sigma/Eigenvectors format.

setCsig3eigvec3

public void setCsig3eigvec3(double[] csig3eigvec3)

Set the Sigma/Eigenvectors Covariance data.

Parameters:

csig3eigvec3 - the covariance data in the Sigma/Eigenvectors format.

isAltCovFlagSet

public boolean isAltCovFlagSet()

Get the flag indicating whether the alternate covariance type set in the CDM Object metadata section is Sigma/Eigenvectors Covariance.

Returns:

the altCovFlag