OEMFile.java

  1. /* Copyright 2002-2020 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.orekit.files.ccsds;

  20. import java.util.ArrayList;
  21. import java.util.Collections;
  22. import java.util.HashMap;
  23. import java.util.List;
  24. import java.util.Map;
  25. import java.util.Map.Entry;

  27. import org.hipparchus.linear.RealMatrix;
  28. import org.orekit.errors.OrekitException;
  29. import org.orekit.errors.OrekitMessages;
  30. import org.orekit.files.general.EphemerisFile;
  31. import org.orekit.frames.Frame;
  32. import org.orekit.frames.LOFType;
  33. import org.orekit.time.AbsoluteDate;
  34. import org.orekit.time.TimeScale;
  35. import org.orekit.utils.CartesianDerivativesFilter;
  36. import org.orekit.utils.TimeStampedPVCoordinates;

  38. /** This class stocks all the information of the OEM File parsed by OEMParser. It
  39.  * contains the header and a list of Ephemerides Blocks each containing
  40.  * metadata, a list of ephemerides data lines and optional covariance matrices
  41.  * (and their metadata).
  42.  * @author sports
  43.  * @author Evan Ward
  44.  * @since 6.1
  45.  */
  46. public class OEMFile extends ODMFile implements EphemerisFile {

  48.     /** List of ephemeris blocks. */
  49.     private List<EphemeridesBlock> ephemeridesBlocks;

  51.     /** OEMFile constructor. */
  52.     public OEMFile() {
  53.         ephemeridesBlocks = new ArrayList<EphemeridesBlock>();
  54.     }

  56.     /** Add a block to the list of ephemeris blocks. */
  57.     public void addEphemeridesBlock() {
  58.         ephemeridesBlocks.add(new EphemeridesBlock());
  59.     }

  61.     /**Get the list of ephemerides blocks as an unmodifiable list.
  62.      * @return the list of ephemerides blocks
  63.      */
  64.     public List<EphemeridesBlock> getEphemeridesBlocks() {
  65.         return Collections.unmodifiableList(ephemeridesBlocks);
  66.     }

  68.     /** Check that, according to the CCSDS standard, every OEMBlock has the same time system.
  69.      */
  70.     public void checkTimeSystems() {
  71.         final CcsdsTimeScale timeSystem = getEphemeridesBlocks().get(0).getMetaData().getTimeSystem();
  72.         for (final EphemeridesBlock block : ephemeridesBlocks) {
  73.             if (!timeSystem.equals(block.getMetaData().getTimeSystem())) {
  74.                 throw new OrekitException(OrekitMessages.CCSDS_OEM_INCONSISTENT_TIME_SYSTEMS,
  75.                                           timeSystem, block.getMetaData().getTimeSystem());
  76.             }
  77.         }
  78.     }

  80.     /** {@inheritDoc} */
  81.     @Override
  82.     public Map<String, OemSatelliteEphemeris> getSatellites() {
  83.         final Map<String, List<EphemeridesBlock>> satellites = new HashMap<>();
  84.         for (final EphemeridesBlock ephemeridesBlock : ephemeridesBlocks) {
  85.             final String id = ephemeridesBlock.getMetaData().getObjectID();
  86.             satellites.putIfAbsent(id, new ArrayList<>());
  87.             satellites.get(id).add(ephemeridesBlock);
  88.         }
  89.         final Map<String, OemSatelliteEphemeris> ret = new HashMap<>();
  90.         for (final Entry<String, List<EphemeridesBlock>> entry : satellites.entrySet()) {
  91.             final String id = entry.getKey();
  92.             ret.put(id, new OemSatelliteEphemeris(id, getMuUsed(), entry.getValue()));
  93.         }
  94.         return ret;
  95.     }


  98.     /** OEM ephemeris blocks for a single satellite. */
  99.     public static class OemSatelliteEphemeris implements SatelliteEphemeris {

  101.         /** ID of the satellite. */
  102.         private final String id;

  104.         /** Gravitational parameter for the satellite, in m^3 / s^2. */
  105.         private final double mu;

  107.         /** The ephemeris data for the satellite. */
  108.         private final List<EphemeridesBlock> blocks;

  110.         /**
  111.          * Create a container for the set of ephemeris blocks in the file that pertain to
  112.          * a single satellite.
  113.          *
  114.          * @param id     of the satellite.
  115.          * @param mu     standard gravitational parameter used to create orbits for the
  116.          *               satellite, in m^3 / s^2.
  117.          * @param blocks containing ephemeris data for the satellite.
  118.          */
  119.         public OemSatelliteEphemeris(final String id,
  120.                                      final double mu,
  121.                                      final List<EphemeridesBlock> blocks) {
  122.             this.id = id;
  123.             this.mu = mu;
  124.             this.blocks = blocks;
  125.         }

  127.         /** {@inheritDoc} */
  128.         @Override
  129.         public String getId() {
  130.             return this.id;
  131.         }

  133.         /** {@inheritDoc} */
  134.         @Override
  135.         public double getMu() {
  136.             return this.mu;
  137.         }

  139.         /** {@inheritDoc} */
  140.         @Override
  141.         public List<EphemeridesBlock> getSegments() {
  142.             return Collections.unmodifiableList(blocks);
  143.         }

  145.         /** {@inheritDoc} */
  146.         @Override
  147.         public AbsoluteDate getStart() {
  148.             return blocks.get(0).getStart();
  149.         }

  151.         /** {@inheritDoc} */
  152.         @Override
  153.         public AbsoluteDate getStop() {
  154.             return blocks.get(blocks.size() - 1).getStop();
  155.         }

  157.     }

  159.     /** The Ephemerides Blocks class contain metadata, the list of ephemerides data
  160.      * lines and optional covariance matrices (and their metadata). The reason
  161.      * for which the ephemerides have been separated into blocks is that the
  162.      * ephemerides of two different blocks are not suited for interpolation.
  163.      * @author sports
  164.      */
  165.     public class EphemeridesBlock implements EphemerisSegment {

  167.         /** Meta-data for the block. */
  168.         private ODMMetaData metaData;

  170.         /** Start of total time span covered by ephemerides data and covariance
  171.          * data. */
  172.         private AbsoluteDate startTime;

  174.         /** End of total time span covered by ephemerides data and covariance
  175.          * data. */
  176.         private AbsoluteDate stopTime;

  178.         /** Start of useable time span covered by ephemerides data, it may be
  179.          * necessary to allow for proper interpolation. */
  180.         private AbsoluteDate useableStartTime;

  182.         /** End of useable time span covered by ephemerides data, it may be
  183.          * necessary to allow for proper interpolation. */
  184.         private AbsoluteDate useableStopTime;

  186.         /** The interpolation method to be used. */
  187.         private String interpolationMethod;

  189.         /** The interpolation degree. */
  190.         private int interpolationDegree;

  192.         /** List of ephemerides data lines. */
  193.         private List<TimeStampedPVCoordinates> ephemeridesDataLines;

  195.         /** True iff all data points in this block have acceleration data. */
  196.         private boolean hasAcceleration;

  198.         /** List of covariance matrices. */
  199.         private List<CovarianceMatrix> covarianceMatrices;

  201.         /** Tests whether the reference frame has an epoch associated to it. */
  202.         private boolean hasRefFrameEpoch;

  204.         /** Ephemerides Data Lines comments. The list contains a string for each
  205.          * line of comment. */
  206.         private List<String> ephemeridesDataLinesComment;

  208.         /** EphemeridesBlock constructor. */
  209.         public EphemeridesBlock() {
  210.             metaData = new ODMMetaData(OEMFile.this);
  211.             ephemeridesDataLines = new ArrayList<>();
  212.             covarianceMatrices = new ArrayList<CovarianceMatrix>();
  213.             hasAcceleration = true;
  214.         }

  216.         /** Get the list of Ephemerides data lines.
  217.          * @return a reference to the internal list of Ephemerides data lines
  218.          */
  219.         public List<TimeStampedPVCoordinates> getEphemeridesDataLines() {
  220.             return this.ephemeridesDataLines;
  221.         }

  223.         /** {@inheritDoc} */
  224.         @Override
  225.         public CartesianDerivativesFilter getAvailableDerivatives() {
  226.             return hasAcceleration ? CartesianDerivativesFilter.USE_PVA :
  227.                     CartesianDerivativesFilter.USE_PV;
  228.         }

  230.         /**
  231.          * Update the value of {@link #hasAcceleration}.
  232.          *
  233.          * @param pointHasAcceleration true if the current data point has acceleration
  234.          *                             data.
  235.          */
  236.         void updateHasAcceleration(final boolean pointHasAcceleration) {
  237.             this.hasAcceleration = this.hasAcceleration && pointHasAcceleration;
  238.         }

  240.         /** {@inheritDoc} */
  241.         @Override
  242.         public List<TimeStampedPVCoordinates> getCoordinates() {
  243.             return Collections.unmodifiableList(this.ephemeridesDataLines);
  244.         }

  246.         /** Get the list of Covariance Matrices.
  247.          * @return the list of Covariance Matrices
  248.          */
  249.         public List<CovarianceMatrix> getCovarianceMatrices() {
  250.             return covarianceMatrices;
  251.         }

  253.         /** Get the meta-data for the block.
  254.          * @return meta-data for the block
  255.          */
  256.         public ODMMetaData getMetaData() {
  257.             return metaData;
  258.         }

  260.         /** {@inheritDoc} */
  261.         @Override
  262.         public double getMu() {
  263.             return getMuUsed();
  264.         }

  266.         /** {@inheritDoc} */
  267.         @Override
  268.         public String getFrameCenterString() {
  269.             return this.getMetaData().getCenterName();
  270.         }

  272.         /** {@inheritDoc} */
  273.         @Override
  274.         public String getFrameString() {
  275.             return this.getMetaData().getFrameString();
  276.         }

  278.         /** {@inheritDoc} */
  279.         @Override
  280.         public Frame getFrame() {
  281.             return this.getMetaData().getFrame();
  282.         }

  284.         /** {@inheritDoc} */
  285.         @Override
  286.         public Frame getInertialFrame() {
  287.             final Frame frame = getFrame();
  288.             if (frame.isPseudoInertial()) {
  289.                 return frame;
  290.             }
  291.             return metaData.getODMFile().getDataContext().getFrames().getGCRF();
  292.         }

  294.         /** {@inheritDoc} */
  295.         @Override
  296.         public String getTimeScaleString() {
  297.             return this.getMetaData().getTimeSystem().toString();
  298.         }

  300.         /** {@inheritDoc} */
  301.         @Override
  302.         public TimeScale getTimeScale() {
  303.             return this.getMetaData().getTimeScale();
  304.         }

  306.         /** Get start of total time span covered by ephemerides data and
  307.          * covariance data.
  308.          * @return the start time
  309.          */
  310.         public AbsoluteDate getStartTime() {
  311.             return startTime;
  312.         }

  314.         /** Set start of total time span covered by ephemerides data and
  315.          * covariance data.
  316.          * @param startTime the time to be set
  317.          */
  318.         public void setStartTime(final AbsoluteDate startTime) {
  319.             this.startTime = startTime;
  320.         }

  322.         /** Get end of total time span covered by ephemerides data and covariance
  323.          * data.
  324.          * @return the stop time
  325.          */
  326.         public AbsoluteDate getStopTime() {
  327.             return stopTime;
  328.         }

  330.         /** Set end of total time span covered by ephemerides data and covariance
  331.          * data.
  332.          * @param stopTime the time to be set
  333.          */
  334.         public void setStopTime(final AbsoluteDate stopTime) {
  335.             this.stopTime = stopTime;
  336.         }

  338.         /** Get start of useable time span covered by ephemerides data, it may be
  339.          * necessary to allow for proper interpolation.
  340.          * @return the useable start time
  341.          */
  342.         public AbsoluteDate getUseableStartTime() {
  343.             return useableStartTime;
  344.         }

  346.         /** Set start of useable time span covered by ephemerides data, it may be
  347.          * necessary to allow for proper interpolation.
  348.          * @param useableStartTime the time to be set
  349.          */
  350.         public void setUseableStartTime(final AbsoluteDate useableStartTime) {
  351.             this.useableStartTime = useableStartTime;
  352.         }

  354.         /** Get end of useable time span covered by ephemerides data, it may be
  355.          * necessary to allow for proper interpolation.
  356.          * @return the useable stop time
  357.          */
  358.         public AbsoluteDate getUseableStopTime() {
  359.             return useableStopTime;
  360.         }

  362.         /** Set end of useable time span covered by ephemerides data, it may be
  363.          * necessary to allow for proper interpolation.
  364.          * @param useableStopTime the time to be set
  365.          */
  366.         public void setUseableStopTime(final AbsoluteDate useableStopTime) {
  367.             this.useableStopTime = useableStopTime;
  368.         }

  370.         /** {@inheritDoc} */
  371.         @Override
  372.         public AbsoluteDate getStart() {
  373.             // useable start time overrides start time if it is set
  374.             final AbsoluteDate start = this.getUseableStartTime();
  375.             if (start != null) {
  376.                 return start;
  377.             } else {
  378.                 return this.getStartTime();
  379.             }
  380.         }

  382.         /** {@inheritDoc} */
  383.         @Override
  384.         public AbsoluteDate getStop() {
  385.             // useable stop time overrides stop time if it is set
  386.             final AbsoluteDate stop = this.getUseableStopTime();
  387.             if (stop != null) {
  388.                 return stop;
  389.             } else {
  390.                 return this.getStopTime();
  391.             }
  392.         }

  394.         /** Get the interpolation method to be used.
  395.          * @return the interpolation method
  396.          */
  397.         public String getInterpolationMethod() {
  398.             return interpolationMethod;
  399.         }

  401.         /** Set the interpolation method to be used.
  402.          * @param interpolationMethod the interpolation method to be set
  403.          */
  404.         public void setInterpolationMethod(final String interpolationMethod) {
  405.             this.interpolationMethod = interpolationMethod;
  406.         }

  408.         /** Get the interpolation degree.
  409.          * @return the interpolation degree
  410.          */
  411.         public int getInterpolationDegree() {
  412.             return interpolationDegree;
  413.         }

  415.         /** Set the interpolation degree.
  416.          * @param interpolationDegree the interpolation degree to be set
  417.          */
  418.         public void setInterpolationDegree(final int interpolationDegree) {
  419.             this.interpolationDegree = interpolationDegree;
  420.         }

  422.         /** {@inheritDoc} */
  423.         @Override
  424.         public int getInterpolationSamples() {
  425.             // From the standard it is not entirely clear how to interpret the degree.
  426.             return getInterpolationDegree() + 1;
  427.         }

  429.         /** Get boolean testing whether the reference frame has an epoch associated to it.
  430.          * @return true if the reference frame has an epoch associated to it
  431.          *         false otherwise
  432.          */
  433.         public boolean getHasRefFrameEpoch() {
  434.             return hasRefFrameEpoch;
  435.         }

  437.         /** Set boolean testing whether the reference frame has an epoch associated to it.
  438.          * @param hasRefFrameEpoch the boolean to be set.
  439.          */
  440.         public void setHasRefFrameEpoch(final boolean hasRefFrameEpoch) {
  441.             this.hasRefFrameEpoch = hasRefFrameEpoch;
  442.         }

  444.         /** Get the ephemerides data lines comment.
  445.          * @return the comment
  446.          */
  447.         public List<String> getEphemeridesDataLinesComment() {
  448.             return ephemeridesDataLinesComment;
  449.         }

  451.         /** Set the ephemerides data lines comment.
  452.          * @param ephemeridesDataLinesComment the comment to be set
  453.          */
  454.         public void setEphemeridesDataLinesComment(final List<String> ephemeridesDataLinesComment) {
  455.             this.ephemeridesDataLinesComment = new ArrayList<String>(ephemeridesDataLinesComment);
  456.         }

  458.     }

  460.     /** The CovarianceMatrix class represents a covariance matrix and its
  461.      * metadata: epoch and frame.
  462.      * @author sports
  463.      */
  464.     public static class CovarianceMatrix {

  466.         /** Covariance matrix. */
  467.         private RealMatrix matrix;

  469.         /** Epoch relative to the covariance matrix. */
  470.         private AbsoluteDate epoch;

  472.         /** Coordinate system for covariance matrix, for Local Orbital Frames. */
  473.         private LOFType lofType;

  475.         /** Coordinate system for covariance matrix, for absolute frames.
  476.          * If not given it is set equal to refFrame. */
  477.         private Frame frame;

  479.         /** Covariance Matrix constructor.
  480.          * @param epoch the epoch
  481.          * @param lofType coordinate system for covariance matrix, for Local Orbital Frames
  482.          * @param frame coordinate system for covariance matrix, for absolute frames
  483.          * @param lastMatrix the covariance matrix
  484.          */
  485.         public CovarianceMatrix(final AbsoluteDate epoch,
  486.                                 final LOFType lofType, final Frame frame,
  487.                                 final RealMatrix lastMatrix) {
  488.             this.matrix  = lastMatrix;
  489.             this.epoch   = epoch;
  490.             this.lofType = lofType;
  491.             this.frame   = frame;
  492.         }

  494.         /** Get the covariance matrix.
  495.          * @return the covariance matrix
  496.          */
  497.         public RealMatrix getMatrix() {
  498.             return matrix;
  499.         }

  501.         /** Get the epoch relative to the covariance matrix.
  502.          * @return the epoch
  503.          */
  504.         public AbsoluteDate getEpoch() {
  505.             return epoch;
  506.         }

  508.         /** Get coordinate system for covariance matrix, for Local Orbital Frames.
  509.          * <p>
  510.          * The value returned is null if the covariance matrix is given in an
  511.          * absolute frame rather than a Local Orbital Frame. In this case, the
  512.          * method {@link #getFrame()} must be used instead.
  513.          * </p>
  514.          * @return the coordinate system for covariance matrix, or null if the
  515.          * covariance matrix is given in an absolute frame rather than a Local
  516.          * Orbital Frame
  517.          */
  518.         public LOFType getLofType() {
  519.             return lofType;
  520.         }

  522.         /** Get coordinate system for covariance matrix, for absolute frames.
  523.          * <p>
  524.          * The value returned is null if the covariance matrix is given in a
  525.          * Local Orbital Frame rather than an absolute frame. In this case, the
  526.          * method {@link #getLofType()} must be used instead.
  527.          * </p>
  528.          * @return the coordinate system for covariance matrix
  529.          */
  530.         public Frame getFrame() {
  531.             return frame;
  532.         }

  534.     }

  536. }
Created with JaCoCo 0.8.6.202009150832