Package org.orekit.files.ccsds.ndm

Class CommonPhysicalProperties

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.ndm.CommonPhysicalProperties
All Implemented Interfaces:
Section
Direct Known Subclasses:
AdditionalParameters, OrbitPhysicalProperties
public class CommonPhysicalProperties extends CommentsContainer
Container for common physical properties for both OrbitPhysicalProperties and AdditionalParameters.

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.3
Author:
Maxime Journot

  • Constructor Details

    • CommonPhysicalProperties

      public CommonPhysicalProperties(AbsoluteDate epochT0, CcsdsFrameMapper frameMapper)
      Simple constructor.
      Parameters:
      epochT0 - T0 epoch from file metadata
      frameMapper - for creating a Frame.
      Since:
      13.1.5

  • Method Details

    • getOebParentFrame

      public FrameFacade getOebParentFrame()
      Get the Optimally Enclosing Box parent reference frame.
      Returns:
      Optimally Enclosing Box parent reference frame

    • setOebParentFrame

      public void setOebParentFrame(FrameFacade oebParentFrame)
      Set the Optimally Enclosing Box parent reference frame.
      Parameters:
      oebParentFrame - Optimally Enclosing Box parent reference frame

    • getOebParentFrameEpoch

      public Optional<AbsoluteDate> getOebParentFrameEpoch()
      Get the Optimally Enclosing Box parent reference frame epoch.
      Returns:
      Optimally Enclosing Box parent reference frame epoch

    • setOebParentFrameEpoch

      public void setOebParentFrameEpoch(AbsoluteDate oebParentFrameEpoch)
      Set the Optimally Enclosing Box parent reference frame epoch.
      Parameters:
      oebParentFrameEpoch - Optimally Enclosing Box parent reference frame epoch

    • getFrameMapper

      public CcsdsFrameMapper getFrameMapper()
      Get the mapping between a CCSDS frame and a Frame.
      Returns:
      the frame mapper.
      Since:
      13.1.5

    • getOebParent

      public Frame getOebParent()
      Get the frame OEB parent frame. Note that only the orientation of the returned frame is significant, the position of the returned frame is irrelevant and should be ignored.
      Returns:
      Orekit frame for this covariance history.
      Since:
      13.1.5
      See Also:

    • getOebQ

      public Optional<Quaternion> getOebQ()
      Get the quaternion defining Optimally Enclosing Box.
      Returns:
      quaternion defining Optimally Enclosing Box

    • setOebQ

      public void setOebQ(int i, double qI)
      set the component of quaternion defining Optimally Enclosing Box.
      Parameters:
      i - index of the component
      qI - component of quaternion defining Optimally Enclosing Box

    • getOebMax

      public Optional<Double> getOebMax()
      Get the maximum physical dimension of the OEB.
      Returns:
      maximum physical dimension of the OEB.

    • setOebMax

      public void setOebMax(double oebMax)
      Set the maximum physical dimension of the OEB.
      Parameters:
      oebMax - maximum physical dimension of the OEB.

    • getOebIntermediate

      public Optional<Double> getOebIntermediate()
      Get the intermediate physical dimension of the OEB.
      Returns:
      intermediate physical dimension of the OEB.

    • setOebIntermediate

      public void setOebIntermediate(double oebIntermediate)
      Set the intermediate physical dimension of the OEB.
      Parameters:
      oebIntermediate - intermediate physical dimension of the OEB.

    • getOebMin

      public Optional<Double> getOebMin()
      Get the minimum physical dimension of the OEB.
      Returns:
      dimensions the minimum physical dimension of the OEB.

    • setOebMin

      public void setOebMin(double oebMin)
      Set the minimum physical dimension of the OEB.
      Parameters:
      oebMin - the minimum physical dimension of the OEB.

    • getOebAreaAlongMax

      public Optional<Double> getOebAreaAlongMax()
      Get the cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.
      Returns:
      cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.

    • setOebAreaAlongMax

      public void setOebAreaAlongMax(double oebAreaAlongMax)
      Set the cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.
      Parameters:
      oebAreaAlongMax - cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.

    • getOebAreaAlongIntermediate

      public Optional<Double> getOebAreaAlongIntermediate()
      Get the cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.
      Returns:
      cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.

    • setOebAreaAlongIntermediate

      public void setOebAreaAlongIntermediate(double oebAreaAlongIntermediate)
      Set the cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.
      Parameters:
      oebAreaAlongIntermediate - cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.

    • getOebAreaAlongMin

      public Optional<Double> getOebAreaAlongMin()
      Get the cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.
      Returns:
      cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.

    • setOebAreaAlongMin

      public void setOebAreaAlongMin(double oebAreaAlongMin)
      Set the cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.
      Parameters:
      oebAreaAlongMin - cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.

    • getRcs

      public Optional<Double> getRcs()
      Get the typical (50th percentile) radar cross-section.
      Returns:
      typical (50th percentile) radar cross-section

    • setRcs

      public void setRcs(double rcs)
      Set the typical (50th percentile) radar cross-section.
      Parameters:
      rcs - typical (50th percentile) radar cross-section

    • getMinRcs

      public Optional<Double> getMinRcs()
      Get the minimum radar cross-section.
      Returns:
      minimum radar cross-section

    • setMinRcs

      public void setMinRcs(double minRcs)
      Set the minimum radar cross-section.
      Parameters:
      minRcs - minimum radar cross-section

    • getMaxRcs

      public Optional<Double> getMaxRcs()
      Get the maximum radar cross-section.
      Returns:
      maximum radar cross-section

    • setMaxRcs

      public void setMaxRcs(double maxRcs)
      Set the maximum radar cross-section.
      Parameters:
      maxRcs - maximum radar cross-section

    • getVmAbsolute

      public Optional<Double> getVmAbsolute()
      Get the typical (50th percentile) visual magnitude.
      Returns:
      typical (50th percentile) visual magnitude

    • setVmAbsolute

      public void setVmAbsolute(double vmAbsolute)
      Set the typical (50th percentile) visual magnitude.
      Parameters:
      vmAbsolute - typical (50th percentile) visual magnitude

    • getVmApparentMin

      public Optional<Double> getVmApparentMin()
      Get the minimum apparent visual magnitude.
      Returns:
      minimum apparent visual magnitude

    • setVmApparentMin

      public void setVmApparentMin(double vmApparentMin)
      Set the minimum apparent visual magnitude.
      Parameters:
      vmApparentMin - minimum apparent visual magnitude

    • getVmApparent

      public Optional<Double> getVmApparent()
      Get the typical (50th percentile) apparent visual magnitude.
      Returns:
      typical (50th percentile) apparent visual magnitude

    • setVmApparent

      public void setVmApparent(double vmApparent)
      Set the typical (50th percentile) apparent visual magnitude.
      Parameters:
      vmApparent - typical (50th percentile) apparent visual magnitude

    • getVmApparentMax

      public Optional<Double> getVmApparentMax()
      Get the maximum apparent visual magnitude.
      Returns:
      maximum apparent visual magnitude

    • setVmApparentMax

      public void setVmApparentMax(double vmApparentMax)
      Set the maximum apparent visual magnitude.
      Parameters:
      vmApparentMax - maximum apparent visual magnitude

    • getReflectance

      public Optional<Double> getReflectance()
      Get the typical (50th percentile) coefficient of reflectance.
      Returns:
      typical (50th percentile) coefficient of reflectance

    • setReflectance

      public void setReflectance(double reflectance)
      Set the typical (50th percentile) coefficient of reflectance.
      Parameters:
      reflectance - typical (50th percentile) coefficient of reflectance