Class SigmaEigenvectorsCovariance

  • All Implemented Interfaces:
    Section

    public class SigmaEigenvectorsCovariance
    extends CommentsContainer
    Container for Sigma/Eigenvectors Covariance data. 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 Detail

      • 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 Detail

      • 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