CPF.java

  1. /* Copyright 2002-2023 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.  */
  17. package org.orekit.files.ilrs;

  19. import java.util.ArrayList;
  20. import java.util.Collections;
  21. import java.util.List;
  22. import java.util.Map;
  23. import java.util.concurrent.ConcurrentHashMap;

  25. import org.hipparchus.geometry.euclidean.threed.Vector3D;
  26. import org.orekit.attitudes.AttitudeProvider;
  27. import org.orekit.files.general.EphemerisFile;
  28. import org.orekit.frames.Frame;
  29. import org.orekit.propagation.BoundedPropagator;
  30. import org.orekit.time.AbsoluteDate;
  31. import org.orekit.time.TimeScale;
  32. import org.orekit.utils.CartesianDerivativesFilter;
  33. import org.orekit.utils.TimeStampedPVCoordinates;

  35. /**
  36.  * This class stores all the information of the Consolidated laser ranging Prediction File (CPF) parsed
  37.  * by CPFParser. It contains the header and a list of ephemeris entry.
  38.  * @author Bryan Cazabonne
  39.  * @since 10.3
  40.  */
  41. public class CPF implements EphemerisFile<CPF.CPFCoordinate, CPF.CPFEphemeris> {

  43.     /** Default satellite ID, used if header is null when initializing the ephemeris. */
  44.     public static final String DEFAULT_ID = "9999999";

  46.     /** Gravitational coefficient. */
  47.     private double mu;

  49.     /** The interpolation sample. */
  50.     private int interpolationSample;

  52.     /** Time scale of dates in the ephemeris file. */
  53.     private TimeScale timeScale;

  55.     /** Indicates if data contains velocity or not. */
  56.     private CartesianDerivativesFilter filter;

  58.     /** CPF file header. */
  59.     private CPFHeader header;

  61.     /** Map containing satellite information. */
  62.     private Map<String, CPFEphemeris> ephemeris;

  64.     /** List of comments contained in the file. */
  65.     private List<String> comments;

  67.     /**
  68.      * Constructor.
  69.      */
  70.     public CPF() {
  71.         this.mu        = Double.NaN;
  72.         this.ephemeris = new ConcurrentHashMap<>();
  73.         this.header    = new CPFHeader();
  74.         this.comments  = new ArrayList<>();
  75.     }

  77.     /** {@inheritDoc}
  78.      * First key corresponds to String value of {@link CPFHeader#getIlrsSatelliteId()}
  79.      */
  80.     @Override
  81.     public Map<String, CPFEphemeris> getSatellites() {
  82.         // Return the map
  83.         return Collections.unmodifiableMap(ephemeris);
  84.     }

  86.     /**
  87.      * Get the CPF file header.
  88.      * @return the CPF file header
  89.      */
  90.     public CPFHeader getHeader() {
  91.         return header;
  92.     }

  94.     /**
  95.      * Get the time scale used in CPF file.
  96.      * @return the time scale used to parse epochs in CPF file.
  97.      */
  98.     public TimeScale getTimeScale() {
  99.         return timeScale;
  100.     }

  102.     /**
  103.      * Get the comments contained in the file.
  104.      * @return the comments contained in the file
  105.      */
  106.     public List<String> getComments() {
  107.         return comments;
  108.     }

  110.     /**
  111.      * Adds a set of P/V coordinates to the satellite.
  112.      * @param id satellite ILRS identifier
  113.      * @param coord set of coordinates
  114.      * @since 11.0.1
  115.      */
  116.     public void addSatelliteCoordinates(final String id, final List<CPFCoordinate> coord) {
  117.         createIfNeeded(id);
  118.         ephemeris.get(id).coordinates.addAll(coord);
  119.     }

  121.     /**
  122.      * Add a new P/V coordinates to the satellite.
  123.      * @param id satellite ILRS identifier
  124.      * @param coord the P/V coordinate of the satellite
  125.      * @since 11.0.1
  126.      */
  127.     public void addSatelliteCoordinate(final String id, final CPFCoordinate coord) {
  128.         createIfNeeded(id);
  129.         ephemeris.get(id).coordinates.add(coord);
  130.     }

  132.     /**
  133.      * Add the velocity to the last CPF coordinate entry.
  134.      * @param id satellite ILRS identifier
  135.      * @param velocity the velocity vector of the satellite
  136.      * @since 11.2
  137.      */
  138.     public void addSatelliteVelocityToCPFCoordinate(final String id, final Vector3D velocity) {
  139.         // Get the last coordinate entry, which contains the position vector
  140.         final CPFCoordinate lastCoordinate = ephemeris.get(id).coordinates.get(ephemeris.get(id).coordinates.size() - 1);

  142.         // Create a new CPFCoordinate object with both position and velocity information
  143.         final CPFCoordinate CPFCoordUpdated = new CPFCoordinate(lastCoordinate.getDate(),
  144.                 lastCoordinate.getPosition(),
  145.                 velocity,
  146.                 lastCoordinate.getLeap());

  148.         // Patch the last record
  149.         ephemeris.get(id).coordinates.set(ephemeris.get(id).coordinates.size() - 1, CPFCoordUpdated);
  150.     }

  152.     /**
  153.      * Set the interpolation sample.
  154.      * @param interpolationSample interpolation sample
  155.      */
  156.     public void setInterpolationSample(final int interpolationSample) {
  157.         this.interpolationSample = interpolationSample;
  158.     }

  160.     /**
  161.      * Set the gravitational coefficient.
  162.      * @param mu the coefficient to be set
  163.      */
  164.     public void setMu(final double mu) {
  165.         this.mu = mu;
  166.     }

  168.     /**
  169.      * Set the time scale.
  170.      * @param timeScale use to parse dates in this file.
  171.      */
  172.     public void setTimeScale(final TimeScale timeScale) {
  173.         this.timeScale = timeScale;
  174.     }

  176.     /**
  177.      * Set the derivatives filter.
  178.      * @param filter that indicates which derivatives of position are available.
  179.      */
  180.     public void setFilter(final CartesianDerivativesFilter filter) {
  181.         this.filter = filter;
  182.     }

  184.     /**
  185.      * Create the satellite ephemeris corresponding to the given ID (if needed).
  186.      * @param id satellite ILRS identifier
  187.      */
  188.     private void createIfNeeded(final String id) {
  189.         if (ephemeris.get(id) == null) {
  190.             ephemeris.put(id, new CPFEphemeris(id));
  191.         }
  192.     }

  194.     /** An ephemeris entry  for a single satellite contains in a CPF file. */
  195.     public class CPFEphemeris
  196.         implements EphemerisFile.SatelliteEphemeris<CPFCoordinate, CPFEphemeris>,
  197.                    EphemerisFile.EphemerisSegment<CPFCoordinate> {

  199.         /** Satellite ID. */
  200.         private final String id;

  202.         /** Ephemeris Data. */
  203.         private final List<CPFCoordinate> coordinates;

  205.         /**
  206.          * Constructor.
  207.          * @param id satellite ID
  208.          */
  209.         public CPFEphemeris(final String id) {
  210.             this.id          = id;
  211.             this.coordinates = new ArrayList<>();
  212.         }


  215.         /** {@inheritDoc} */
  216.         @Override
  217.         public Frame getFrame() {
  218.             return header.getRefFrame();
  219.         }

  221.         /** {@inheritDoc} */
  222.         @Override
  223.         public int getInterpolationSamples() {
  224.             return interpolationSample;
  225.         }

  227.         /** {@inheritDoc} */
  228.         @Override
  229.         public CartesianDerivativesFilter getAvailableDerivatives() {
  230.             return filter;
  231.         }

  233.         /** {@inheritDoc} */
  234.         @Override
  235.         public List<CPFCoordinate> getCoordinates() {
  236.             return Collections.unmodifiableList(this.coordinates);
  237.         }

  239.         /** {@inheritDoc} */
  240.         @Override
  241.         public String getId() {
  242.             return id == null ? DEFAULT_ID : id;
  243.         }

  245.         /** {@inheritDoc} */
  246.         @Override
  247.         public double getMu() {
  248.             return mu;
  249.         }

  251.         /** Returns a list containing only {@code this}. */
  252.         @Override
  253.         public List<CPFEphemeris> getSegments() {
  254.             return Collections.singletonList(this);
  255.         }

  257.         /** {@inheritDoc} */
  258.         @Override
  259.         public AbsoluteDate getStart() {
  260.             return coordinates.get(0).getDate();
  261.         }

  263.         /** {@inheritDoc} */
  264.         @Override
  265.         public AbsoluteDate getStop() {
  266.             return coordinates.get(coordinates.size() - 1).getDate();
  267.         }

  269.         /** {@inheritDoc} */
  270.         @Override
  271.         public BoundedPropagator getPropagator() {
  272.             return EphemerisSegment.super.getPropagator();
  273.         }

  275.         /** {@inheritDoc} */
  276.         @Override
  277.         public BoundedPropagator getPropagator(final AttitudeProvider attitudeProvider) {
  278.             return EphemerisSegment.super.getPropagator(attitudeProvider);
  279.         }

  281.         /** Get the list of Ephemerides data lines.
  282.          * @return a reference to the internal list of Ephemerides data lines
  283.          */
  284.         public List<CPFCoordinate> getEphemeridesDataLines() {
  285.             return this.coordinates;
  286.         }

  288.     }

  290.     /** A single record of position and possibility velocity in an SP3 file. */
  291.     public static class CPFCoordinate extends TimeStampedPVCoordinates {

  293.         /** Serializable UID. */
  294.         private static final long serialVersionUID = 20201016L;

  296.         /** Leap second flag. */
  297.         private final int leap;

  299.         /**
  300.          * Constructor with null velocity vector.
  301.          * @param date date of coordinates validity
  302.          * @param position position vector
  303.          * @param leap leap second flag (= 0 or the value of the new leap second)
  304.          */
  305.         public CPFCoordinate(final AbsoluteDate date,
  306.                              final Vector3D position,
  307.                              final int leap) {
  308.             this(date, position, Vector3D.ZERO, leap);
  309.         }

  311.         /**
  312.          * Constructor.
  313.          * @param date date of coordinates validity
  314.          * @param position position vector
  315.          * @param velocity velocity vector
  316.          * @param leap leap second flag (= 0 or the value of the new leap second)
  317.          */
  318.         public CPFCoordinate(final AbsoluteDate date,
  319.                              final Vector3D position,
  320.                              final Vector3D velocity,
  321.                              final int leap) {
  322.             super(date, position, velocity);
  323.             this.leap = leap;
  324.         }

  326.         /**
  327.          * Get the leap second flag (= 0 or the value of the new leap second).
  328.          * @return the leap second flag
  329.          */
  330.         public int getLeap() {
  331.             return leap;
  332.         }

  334.     }

  336. }
Created with JaCoCo 0.8.11.202310140853