TimeStampedPVCoordinates.java

  1. /* Copyright 2002-2024 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.utils;

  19. import java.io.Serializable;

  21. import org.hipparchus.analysis.differentiation.Derivative;
  22. import org.hipparchus.geometry.euclidean.threed.FieldVector3D;
  23. import org.hipparchus.geometry.euclidean.threed.Vector3D;
  24. import org.hipparchus.util.FastMath;
  25. import org.orekit.annotation.DefaultDataContext;
  26. import org.orekit.data.DataContext;
  27. import org.orekit.frames.Frame;
  28. import org.orekit.frames.StaticTransform;
  29. import org.orekit.frames.Transform;
  30. import org.orekit.time.AbsoluteDate;
  31. import org.orekit.time.TimeScale;
  32. import org.orekit.time.TimeStamped;

  34. /** {@link TimeStamped time-stamped} version of {@link PVCoordinates}.
  35.  * <p>Instances of this class are guaranteed to be immutable.</p>
  36.  * @author Luc Maisonobe
  37.  * @since 7.0
  38.  */
  39. public class TimeStampedPVCoordinates extends PVCoordinates implements TimeStamped {

  41.     /** Serializable UID. */
  42.     private static final long serialVersionUID = 20140723L;

  44.     /** The date. */
  45.     private final AbsoluteDate date;

  47.     /** Builds a TimeStampedPVCoordinates pair.
  48.      * @param date coordinates date
  49.      * @param position the position vector (m)
  50.      * @param velocity the velocity vector (m/s)
  51.      * @param acceleration the acceleration vector (m/s²)
  52.      */
  53.     public TimeStampedPVCoordinates(final AbsoluteDate date,
  54.                                     final Vector3D position, final Vector3D velocity, final Vector3D acceleration) {
  55.         super(position, velocity, acceleration);
  56.         this.date = date;
  57.     }

  59.     /**
  60.      * Build from position and velocity. Acceleration is set to zero.
  61.      *
  62.      * @param date coordinates date
  63.      * @param position the position vector (m)
  64.      * @param velocity the velocity vector (m/s)
  65.      */
  66.     public TimeStampedPVCoordinates(final AbsoluteDate date,
  67.                                     final Vector3D position,
  68.                                     final Vector3D velocity) {
  69.         this(date, position, velocity, Vector3D.ZERO);
  70.     }

  72.     /**
  73.      * Build from position velocity acceleration coordinates.
  74.      *
  75.      * @param date coordinates date
  76.      * @param pv position velocity, and acceleration coordinates, in meters and seconds.
  77.      */
  78.     public TimeStampedPVCoordinates(final AbsoluteDate date, final PVCoordinates pv) {
  79.         this(date, pv.getPosition(), pv.getVelocity(), pv.getAcceleration());
  80.     }

  82.     /** Multiplicative constructor
  83.      * <p>Build a TimeStampedPVCoordinates from another one and a scale factor.</p>
  84.      * <p>The TimeStampedPVCoordinates built will be a * pv</p>
  85.      * @param date date of the built coordinates
  86.      * @param a scale factor
  87.      * @param pv base (unscaled) PVCoordinates
  88.      */
  89.     public TimeStampedPVCoordinates(final AbsoluteDate date,
  90.                                     final double a, final PVCoordinates pv) {
  91.         super(new Vector3D(a, pv.getPosition()),
  92.               new Vector3D(a, pv.getVelocity()),
  93.               new Vector3D(a, pv.getAcceleration()));
  94.         this.date = date;
  95.     }

  97.     /** Subtractive constructor
  98.      * <p>Build a relative TimeStampedPVCoordinates from a start and an end position.</p>
  99.      * <p>The TimeStampedPVCoordinates built will be end - start.</p>
  100.      * @param date date of the built coordinates
  101.      * @param start Starting PVCoordinates
  102.      * @param end ending PVCoordinates
  103.      */
  104.     public TimeStampedPVCoordinates(final AbsoluteDate date,
  105.                                     final PVCoordinates start, final PVCoordinates end) {
  106.         super(end.getPosition().subtract(start.getPosition()),
  107.               end.getVelocity().subtract(start.getVelocity()),
  108.               end.getAcceleration().subtract(start.getAcceleration()));
  109.         this.date = date;
  110.     }

  112.     /** Linear constructor
  113.      * <p>Build a TimeStampedPVCoordinates from two other ones and corresponding scale factors.</p>
  114.      * <p>The TimeStampedPVCoordinates built will be a1 * u1 + a2 * u2</p>
  115.      * @param date date of the built coordinates
  116.      * @param a1 first scale factor
  117.      * @param pv1 first base (unscaled) PVCoordinates
  118.      * @param a2 second scale factor
  119.      * @param pv2 second base (unscaled) PVCoordinates
  120.      */
  121.     public TimeStampedPVCoordinates(final AbsoluteDate date,
  122.                                     final double a1, final PVCoordinates pv1,
  123.                                     final double a2, final PVCoordinates pv2) {
  124.         super(new Vector3D(a1, pv1.getPosition(),     a2, pv2.getPosition()),
  125.               new Vector3D(a1, pv1.getVelocity(),     a2, pv2.getVelocity()),
  126.               new Vector3D(a1, pv1.getAcceleration(), a2, pv2.getAcceleration()));
  127.         this.date = date;
  128.     }

  130.     /** Linear constructor
  131.      * <p>Build a TimeStampedPVCoordinates from three other ones and corresponding scale factors.</p>
  132.      * <p>The TimeStampedPVCoordinates built will be a1 * u1 + a2 * u2 + a3 * u3</p>
  133.      * @param date date of the built coordinates
  134.      * @param a1 first scale factor
  135.      * @param pv1 first base (unscaled) PVCoordinates
  136.      * @param a2 second scale factor
  137.      * @param pv2 second base (unscaled) PVCoordinates
  138.      * @param a3 third scale factor
  139.      * @param pv3 third base (unscaled) PVCoordinates
  140.      */
  141.     public TimeStampedPVCoordinates(final AbsoluteDate date,
  142.                                     final double a1, final PVCoordinates pv1,
  143.                                     final double a2, final PVCoordinates pv2,
  144.                                     final double a3, final PVCoordinates pv3) {
  145.         super(new Vector3D(a1, pv1.getPosition(),     a2, pv2.getPosition(),     a3, pv3.getPosition()),
  146.               new Vector3D(a1, pv1.getVelocity(),     a2, pv2.getVelocity(),     a3, pv3.getVelocity()),
  147.               new Vector3D(a1, pv1.getAcceleration(), a2, pv2.getAcceleration(), a3, pv3.getAcceleration()));
  148.         this.date = date;
  149.     }

  151.     /** Linear constructor
  152.      * <p>Build a TimeStampedPVCoordinates from four other ones and corresponding scale factors.</p>
  153.      * <p>The TimeStampedPVCoordinates built will be a1 * u1 + a2 * u2 + a3 * u3 + a4 * u4</p>
  154.      * @param date date of the built coordinates
  155.      * @param a1 first scale factor
  156.      * @param pv1 first base (unscaled) PVCoordinates
  157.      * @param a2 second scale factor
  158.      * @param pv2 second base (unscaled) PVCoordinates
  159.      * @param a3 third scale factor
  160.      * @param pv3 third base (unscaled) PVCoordinates
  161.      * @param a4 fourth scale factor
  162.      * @param pv4 fourth base (unscaled) PVCoordinates
  163.      */
  164.     public TimeStampedPVCoordinates(final AbsoluteDate date,
  165.                                     final double a1, final PVCoordinates pv1,
  166.                                     final double a2, final PVCoordinates pv2,
  167.                                     final double a3, final PVCoordinates pv3,
  168.                                     final double a4, final PVCoordinates pv4) {
  169.         super(new Vector3D(a1, pv1.getPosition(),     a2, pv2.getPosition(),     a3, pv3.getPosition(),     a4, pv4.getPosition()),
  170.               new Vector3D(a1, pv1.getVelocity(),     a2, pv2.getVelocity(),     a3, pv3.getVelocity(),     a4, pv4.getVelocity()),
  171.               new Vector3D(a1, pv1.getAcceleration(), a2, pv2.getAcceleration(), a3, pv3.getAcceleration(), a4, pv4.getAcceleration()));
  172.         this.date = date;
  173.     }

  175.     /** Builds a TimeStampedPVCoordinates triplet from  a {@link FieldVector3D}&lt;{@link Derivative}&gt;.
  176.      * <p>
  177.      * The vector components must have time as their only derivation parameter and
  178.      * have consistent derivation orders.
  179.      * </p>
  180.      * @param date date of the built coordinates
  181.      * @param p vector with time-derivatives embedded within the coordinates
  182.      * @param <U> type of the derivative
  183.      */
  184.     public <U extends Derivative<U>> TimeStampedPVCoordinates(final AbsoluteDate date, final FieldVector3D<U> p) {
  185.         super(p);
  186.         this.date = date;
  187.     }

  189.     /** {@inheritDoc} */
  190.     public AbsoluteDate getDate() {
  191.         return date;
  192.     }

  194.     /** Get a time-shifted state.
  195.      * <p>
  196.      * The state can be slightly shifted to close dates. This shift is based on
  197.      * a simple Taylor expansion. It is <em>not</em> intended as a replacement for
  198.      * proper orbit propagation (it is not even Keplerian!) but should be sufficient
  199.      * for either small time shifts or coarse accuracy.
  200.      * </p>
  201.      * @param dt time shift in seconds
  202.      * @return a new state, shifted with respect to the instance (which is immutable)
  203.      */
  204.     public TimeStampedPVCoordinates shiftedBy(final double dt) {
  205.         final PVCoordinates spv = super.shiftedBy(dt);
  206.         return new TimeStampedPVCoordinates(date.shiftedBy(dt),
  207.                                             spv.getPosition(), spv.getVelocity(), spv.getAcceleration());
  208.     }

  210.     /** Create a local provider using simply Taylor expansion through {@link #shiftedBy(double)}.
  211.      * <p>
  212.      * The time evolution is based on a simple Taylor expansion. It is <em>not</em> intended as a
  213.      * replacement for proper orbit propagation (it is not even Keplerian!) but should be sufficient
  214.      * for either small time shifts or coarse accuracy.
  215.      * </p>
  216.      * @param instanceFrame frame in which the instance is defined
  217.      * @return provider based on Taylor expansion, for small time shifts around instance date
  218.      */
  219.     public PVCoordinatesProvider toTaylorProvider(final Frame instanceFrame) {
  220.         return new PVCoordinatesProvider() {
  221.             /** {@inheritDoc} */
  222.             public Vector3D getPosition(final AbsoluteDate d,  final Frame f) {
  223.                 final TimeStampedPVCoordinates shifted   = shiftedBy(d.durationFrom(getDate()));
  224.                 final StaticTransform          transform = instanceFrame.getStaticTransformTo(f, d);
  225.                 return transform.transformPosition(shifted.getPosition());
  226.             }
  227.             /** {@inheritDoc} */
  228.             public TimeStampedPVCoordinates getPVCoordinates(final AbsoluteDate d,  final Frame f) {
  229.                 final TimeStampedPVCoordinates shifted   = shiftedBy(d.durationFrom(date));
  230.                 final Transform                transform = instanceFrame.getTransformTo(f, d);
  231.                 return transform.transformPVCoordinates(shifted);
  232.             }
  233.         };
  234.     }

  236.     /** Return a string representation of this date, position, velocity, and acceleration.
  237.      *
  238.      * <p>This method uses the {@link DataContext#getDefault() default data context}.
  239.      *
  240.      * @return string representation of this.
  241.      */
  242.     @Override
  243.     @DefaultDataContext
  244.     public String toString() {
  245.         return toString(DataContext.getDefault().getTimeScales().getUTC());
  246.     }

  248.     /**
  249.      * Return a string representation of this date, position, velocity, and acceleration.
  250.      *
  251.      * @param utc time scale used to print the date.
  252.      * @return string representation of this.
  253.      */
  254.     public String toString(final TimeScale utc) {
  255.         final String comma = ", ";
  256.         return new StringBuilder().append('{').
  257.                                   append(date.toString(utc)).append(", P(").
  258.                                   append(getPosition().getX()).append(comma).
  259.                                   append(getPosition().getY()).append(comma).
  260.                                   append(getPosition().getZ()).append("), V(").
  261.                                   append(getVelocity().getX()).append(comma).
  262.                                   append(getVelocity().getY()).append(comma).
  263.                                   append(getVelocity().getZ()).append("), A(").
  264.                                   append(getAcceleration().getX()).append(comma).
  265.                                   append(getAcceleration().getY()).append(comma).
  266.                                   append(getAcceleration().getZ()).append(")}").toString();
  267.     }

  269.     /** Replace the instance with a data transfer object for serialization.
  270.      * @return data transfer object that will be serialized
  271.      */
  272.     @DefaultDataContext
  273.     private Object writeReplace() {
  274.         return new DTO(this);
  275.     }

  277.     /** Internal class used only for serialization. */
  278.     @DefaultDataContext
  279.     private static class DTO implements Serializable {

  281.         /** Serializable UID. */
  282.         private static final long serialVersionUID = 20140723L;

  284.         /** Double values. */
  285.         private double[] d;

  287.         /** Simple constructor.
  288.          * @param pv instance to serialize
  289.          */
  290.         private DTO(final TimeStampedPVCoordinates pv) {

  292.             // decompose date
  293.             final AbsoluteDate j2000Epoch =
  294.                     DataContext.getDefault().getTimeScales().getJ2000Epoch();
  295.             final double epoch  = FastMath.floor(pv.getDate().durationFrom(j2000Epoch));
  296.             final double offset = pv.getDate().durationFrom(j2000Epoch.shiftedBy(epoch));

  298.             this.d = new double[] {
  299.                 epoch, offset,
  300.                 pv.getPosition().getX(),     pv.getPosition().getY(),     pv.getPosition().getZ(),
  301.                 pv.getVelocity().getX(),     pv.getVelocity().getY(),     pv.getVelocity().getZ(),
  302.                 pv.getAcceleration().getX(), pv.getAcceleration().getY(), pv.getAcceleration().getZ()
  303.             };

  305.         }

  307.         /** Replace the deserialized data transfer object with a {@link TimeStampedPVCoordinates}.
  308.          * @return replacement {@link TimeStampedPVCoordinates}
  309.          */
  310.         private Object readResolve() {
  311.             final AbsoluteDate j2000Epoch =
  312.                     DataContext.getDefault().getTimeScales().getJ2000Epoch();
  313.             return new TimeStampedPVCoordinates(j2000Epoch.shiftedBy(d[0]).shiftedBy(d[1]),
  314.                                                 new Vector3D(d[2], d[3], d[ 4]),
  315.                                                 new Vector3D(d[5], d[6], d[ 7]),
  316.                                                 new Vector3D(d[8], d[9], d[10]));
  317.         }

  319.     }

  321. }
Created with JaCoCo 0.8.12.202403310830