GroundStation.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.  */
  17. package org.orekit.estimation.measurements;

  19. import java.util.Map;

  21. import org.hipparchus.Field;
  22. import org.hipparchus.analysis.differentiation.DSFactory;
  23. import org.hipparchus.analysis.differentiation.DerivativeStructure;
  24. import org.hipparchus.analysis.differentiation.Gradient;
  25. import org.hipparchus.geometry.euclidean.threed.FieldRotation;
  26. import org.hipparchus.geometry.euclidean.threed.FieldVector3D;
  27. import org.hipparchus.geometry.euclidean.threed.Rotation;
  28. import org.hipparchus.geometry.euclidean.threed.Vector3D;
  29. import org.hipparchus.util.FastMath;
  30. import org.orekit.bodies.BodyShape;
  31. import org.orekit.bodies.FieldGeodeticPoint;
  32. import org.orekit.bodies.GeodeticPoint;
  33. import org.orekit.data.BodiesElements;
  34. import org.orekit.data.FundamentalNutationArguments;
  35. import org.orekit.errors.OrekitException;
  36. import org.orekit.errors.OrekitMessages;
  37. import org.orekit.frames.EOPHistory;
  38. import org.orekit.frames.FieldTransform;
  39. import org.orekit.frames.Frame;
  40. import org.orekit.frames.FramesFactory;
  41. import org.orekit.frames.TopocentricFrame;
  42. import org.orekit.frames.Transform;
  43. import org.orekit.models.earth.displacement.StationDisplacement;
  44. import org.orekit.time.AbsoluteDate;
  45. import org.orekit.time.FieldAbsoluteDate;
  46. import org.orekit.time.UT1Scale;
  47. import org.orekit.utils.ParameterDriver;

  49. /** Class modeling a ground station that can perform some measurements.
  50.  * <p>
  51.  * This class adds a position offset parameter to a base {@link TopocentricFrame
  52.  * topocentric frame}.
  53.  * </p>
  54.  * <p>
  55.  * Since 9.0, this class also adds parameters for an additional polar motion
  56.  * and an additional prime meridian orientation. Since these parameters will
  57.  * have the same name for all ground stations, they will be managed consistently
  58.  * and allow to estimate Earth orientation precisely (this is needed for precise
  59.  * orbit determination). The polar motion and prime meridian orientation will
  60.  * be applied <em>after</em> regular Earth orientation parameters, so the value
  61.  * of the estimated parameters will be correction to EOP, they will not be the
  62.  * complete EOP values by themselves. Basically, this means that for Earth, the
  63.  * following transforms are applied in order, between inertial frame and ground
  64.  * station frame (for non-Earth based ground stations, different precession nutation
  65.  * models and associated planet oritentation parameters would be applied, if available):
  66.  * </p>
  67.  * <p>
  68.  * Since 9.3, this class also adds a station clock offset parameter, which manages
  69.  * the value that must be subtracted from the observed measurement date to get the real
  70.  * physical date at which the measurement was performed (i.e. the offset is negative
  71.  * if the ground station clock is slow and positive if it is fast).
  72.  * </p>
  73.  * <ol>
  74.  *   <li>precession/nutation, as theoretical model plus celestial pole EOP parameters</li>
  75.  *   <li>body rotation, as theoretical model plus prime meridian EOP parameters</li>
  76.  *   <li>polar motion, which is only from EOP parameters (no theoretical models)</li>
  77.  *   <li>additional body rotation, controlled by {@link #getPrimeMeridianOffsetDriver()} and {@link #getPrimeMeridianDriftDriver()}</li>
  78.  *   <li>additional polar motion, controlled by {@link #getPolarOffsetXDriver()}, {@link #getPolarDriftXDriver()},
  79.  *   {@link #getPolarOffsetYDriver()} and {@link #getPolarDriftYDriver()}</li>
  80.  *   <li>station clock offset, controlled by {@link #getClockOffsetDriver()}</li>
  81.  *   <li>station position offset, controlled by {@link #getEastOffsetDriver()},
  82.  *   {@link #getNorthOffsetDriver()} and {@link #getZenithOffsetDriver()}</li>
  83.  * </ol>
  84.  * @author Luc Maisonobe
  85.  * @since 8.0
  86.  */
  87. public class GroundStation {

  89.     /** Suffix for ground station position and clock offset parameters names. */
  90.     public static final String OFFSET_SUFFIX = "-offset";

  92.     /** Suffix for ground clock drift parameters name. */
  93.     public static final String DRIFT_SUFFIX = "-drift-clock";

  95.     /** Suffix for ground station intermediate frame name. */
  96.     public static final String INTERMEDIATE_SUFFIX = "-intermediate";

  98.     /** Clock offset scaling factor.
  99.      * <p>
  100.      * We use a power of 2 to avoid numeric noise introduction
  101.      * in the multiplications/divisions sequences.
  102.      * </p>
  103.      */
  104.     private static final double CLOCK_OFFSET_SCALE = FastMath.scalb(1.0, -10);

  106.     /** Position offsets scaling factor.
  107.      * <p>
  108.      * We use a power of 2 (in fact really 1.0 here) to avoid numeric noise introduction
  109.      * in the multiplications/divisions sequences.
  110.      * </p>
  111.      */
  112.     private static final double POSITION_OFFSET_SCALE = FastMath.scalb(1.0, 0);

  114.     /** Provider for Earth frame whose EOP parameters can be estimated. */
  115.     private final EstimatedEarthFrameProvider estimatedEarthFrameProvider;

  117.     /** Earth frame whose EOP parameters can be estimated. */
  118.     private final Frame estimatedEarthFrame;

  120.     /** Base frame associated with the station. */
  121.     private final TopocentricFrame baseFrame;

  123.     /** Fundamental nutation arguments. */
  124.     private final FundamentalNutationArguments arguments;

  126.     /** Displacement models. */
  127.     private final StationDisplacement[] displacements;

  129.     /** Driver for clock offset. */
  130.     private final ParameterDriver clockOffsetDriver;

  132.     /** Driver for clock drift. */
  133.     private final ParameterDriver clockDriftDriver;

  135.     /** Driver for position offset along the East axis. */
  136.     private final ParameterDriver eastOffsetDriver;

  138.     /** Driver for position offset along the North axis. */
  139.     private final ParameterDriver northOffsetDriver;

  141.     /** Driver for position offset along the zenith axis. */
  142.     private final ParameterDriver zenithOffsetDriver;

  144.     /** Build a ground station ignoring {@link StationDisplacement station displacements}.
  145.      * <p>
  146.      * The initial values for the pole and prime meridian parametric linear models
  147.      * ({@link #getPrimeMeridianOffsetDriver()}, {@link #getPrimeMeridianDriftDriver()},
  148.      * {@link #getPolarOffsetXDriver()}, {@link #getPolarDriftXDriver()},
  149.      * {@link #getPolarOffsetXDriver()}, {@link #getPolarDriftXDriver()}) are set to 0.
  150.      * The initial values for the station offset model ({@link #getClockOffsetDriver()},
  151.      * {@link #getEastOffsetDriver()}, {@link #getNorthOffsetDriver()},
  152.      * {@link #getZenithOffsetDriver()}) are set to 0.
  153.      * This implies that as long as these values are not changed, the offset frame is
  154.      * the same as the {@link #getBaseFrame() base frame}. As soon as some of these models
  155.      * are changed, the offset frame moves away from the {@link #getBaseFrame() base frame}.
  156.      * </p>
  157.      * @param baseFrame base frame associated with the station, without *any* parametric
  158.      * model (no station offset, no polar motion, no meridian shift)
  159.      * @see #GroundStation(TopocentricFrame, EOPHistory, StationDisplacement...)
  160.      */
  161.     public GroundStation(final TopocentricFrame baseFrame) {
  162.         this(baseFrame, FramesFactory.findEOP(baseFrame), new StationDisplacement[0]);
  163.     }

  165.     /** Simple constructor.
  166.      * <p>
  167.      * The initial values for the pole and prime meridian parametric linear models
  168.      * ({@link #getPrimeMeridianOffsetDriver()}, {@link #getPrimeMeridianDriftDriver()},
  169.      * {@link #getPolarOffsetXDriver()}, {@link #getPolarDriftXDriver()},
  170.      * {@link #getPolarOffsetXDriver()}, {@link #getPolarDriftXDriver()}) are set to 0.
  171.      * The initial values for the station offset model ({@link #getClockOffsetDriver()},
  172.      * {@link #getEastOffsetDriver()}, {@link #getNorthOffsetDriver()},
  173.      * {@link #getZenithOffsetDriver()}, {@link #getClockOffsetDriver()}) are set to 0.
  174.      * This implies that as long as these values are not changed, the offset frame is
  175.      * the same as the {@link #getBaseFrame() base frame}. As soon as some of these models
  176.      * are changed, the offset frame moves away from the {@link #getBaseFrame() base frame}.
  177.      * </p>
  178.      * @param baseFrame base frame associated with the station, without *any* parametric
  179.      * model (no station offset, no polar motion, no meridian shift)
  180.      * @param eopHistory EOP history associated with Earth frames
  181.      * @param displacements ground station displacement model (tides, ocean loading,
  182.      * atmospheric loading, thermal effects...)
  183.      * @since 9.1
  184.      */
  185.     public GroundStation(final TopocentricFrame baseFrame, final EOPHistory eopHistory,
  186.                          final StationDisplacement... displacements) {

  188.         this.baseFrame = baseFrame;

  190.         if (eopHistory == null) {
  191.             throw new OrekitException(OrekitMessages.NO_EARTH_ORIENTATION_PARAMETERS);
  192.         }

  194.         final UT1Scale baseUT1 = eopHistory.getTimeScales()
  195.                 .getUT1(eopHistory.getConventions(), eopHistory.isSimpleEop());
  196.         this.estimatedEarthFrameProvider = new EstimatedEarthFrameProvider(baseUT1);
  197.         this.estimatedEarthFrame = new Frame(baseFrame.getParent(), estimatedEarthFrameProvider,
  198.                                              baseFrame.getParent() + "-estimated");

  200.         if (displacements.length == 0) {
  201.             arguments = null;
  202.         } else {
  203.             arguments = eopHistory.getConventions().getNutationArguments(
  204.                     estimatedEarthFrameProvider.getEstimatedUT1(),
  205.                     eopHistory.getTimeScales());
  206.         }

  208.         this.displacements = displacements.clone();

  210.         this.clockOffsetDriver = new ParameterDriver(baseFrame.getName() + OFFSET_SUFFIX + "-clock",
  211.                                                      0.0, CLOCK_OFFSET_SCALE,
  212.                                                      Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY);

  214.         this.clockDriftDriver = new ParameterDriver(baseFrame.getName() + DRIFT_SUFFIX,
  215.                                                     0.0, CLOCK_OFFSET_SCALE,
  216.                                                     Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY);

  218.         this.eastOffsetDriver = new ParameterDriver(baseFrame.getName() + OFFSET_SUFFIX + "-East",
  219.                                                     0.0, POSITION_OFFSET_SCALE,
  220.                                                     Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY);

  222.         this.northOffsetDriver = new ParameterDriver(baseFrame.getName() + OFFSET_SUFFIX + "-North",
  223.                                                      0.0, POSITION_OFFSET_SCALE,
  224.                                                      Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY);

  226.         this.zenithOffsetDriver = new ParameterDriver(baseFrame.getName() + OFFSET_SUFFIX + "-Zenith",
  227.                                                       0.0, POSITION_OFFSET_SCALE,
  228.                                                       Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY);

  230.     }

  232.     /** Get the displacement models.
  233.      * @return displacement models (empty if no model has been set up)
  234.      * @since 9.1
  235.      */
  236.     public StationDisplacement[] getDisplacements() {
  237.         return displacements.clone();
  238.     }

  240.     /** Get a driver allowing to change station clock (which is related to measurement date).
  241.      * @return driver for station clock offset
  242.      * @since 9.3
  243.      */
  244.     public ParameterDriver getClockOffsetDriver() {
  245.         return clockOffsetDriver;
  246.     }

  248.     /** Get a driver allowing to change station clock drift (which is related to measurement date).
  249.      * @return driver for station clock drift
  250.      * @since 10.3
  251.      */
  252.     public ParameterDriver getClockDriftDriver() {
  253.         return clockDriftDriver;
  254.     }

  256.     /** Get a driver allowing to change station position along East axis.
  257.      * @return driver for station position offset along East axis
  258.      */
  259.     public ParameterDriver getEastOffsetDriver() {
  260.         return eastOffsetDriver;
  261.     }

  263.     /** Get a driver allowing to change station position along North axis.
  264.      * @return driver for station position offset along North axis
  265.      */
  266.     public ParameterDriver getNorthOffsetDriver() {
  267.         return northOffsetDriver;
  268.     }

  270.     /** Get a driver allowing to change station position along Zenith axis.
  271.      * @return driver for station position offset along Zenith axis
  272.      */
  273.     public ParameterDriver getZenithOffsetDriver() {
  274.         return zenithOffsetDriver;
  275.     }

  277.     /** Get a driver allowing to add a prime meridian rotation.
  278.      * <p>
  279.      * The parameter is an angle in radians. In order to convert this
  280.      * value to a DUT1 in seconds, the value must be divided by
  281.      * {@code ave = 7.292115146706979e-5} (which is the nominal Angular Velocity
  282.      * of Earth from the TIRF model).
  283.      * </p>
  284.      * @return driver for prime meridian rotation
  285.      */
  286.     public ParameterDriver getPrimeMeridianOffsetDriver() {
  287.         return estimatedEarthFrameProvider.getPrimeMeridianOffsetDriver();
  288.     }

  290.     /** Get a driver allowing to add a prime meridian rotation rate.
  291.      * <p>
  292.      * The parameter is an angle rate in radians per second. In order to convert this
  293.      * value to a LOD in seconds, the value must be multiplied by -86400 and divided by
  294.      * {@code ave = 7.292115146706979e-5} (which is the nominal Angular Velocity
  295.      * of Earth from the TIRF model).
  296.      * </p>
  297.      * @return driver for prime meridian rotation rate
  298.      */
  299.     public ParameterDriver getPrimeMeridianDriftDriver() {
  300.         return estimatedEarthFrameProvider.getPrimeMeridianDriftDriver();
  301.     }

  303.     /** Get a driver allowing to add a polar offset along X.
  304.      * <p>
  305.      * The parameter is an angle in radians
  306.      * </p>
  307.      * @return driver for polar offset along X
  308.      */
  309.     public ParameterDriver getPolarOffsetXDriver() {
  310.         return estimatedEarthFrameProvider.getPolarOffsetXDriver();
  311.     }

  313.     /** Get a driver allowing to add a polar drift along X.
  314.      * <p>
  315.      * The parameter is an angle rate in radians per second
  316.      * </p>
  317.      * @return driver for polar drift along X
  318.      */
  319.     public ParameterDriver getPolarDriftXDriver() {
  320.         return estimatedEarthFrameProvider.getPolarDriftXDriver();
  321.     }

  323.     /** Get a driver allowing to add a polar offset along Y.
  324.      * <p>
  325.      * The parameter is an angle in radians
  326.      * </p>
  327.      * @return driver for polar offset along Y
  328.      */
  329.     public ParameterDriver getPolarOffsetYDriver() {
  330.         return estimatedEarthFrameProvider.getPolarOffsetYDriver();
  331.     }

  333.     /** Get a driver allowing to add a polar drift along Y.
  334.      * <p>
  335.      * The parameter is an angle rate in radians per second
  336.      * </p>
  337.      * @return driver for polar drift along Y
  338.      */
  339.     public ParameterDriver getPolarDriftYDriver() {
  340.         return estimatedEarthFrameProvider.getPolarDriftYDriver();
  341.     }

  343.     /** Get the base frame associated with the station.
  344.      * <p>
  345.      * The base frame corresponds to a null position offset, null
  346.      * polar motion, null meridian shift
  347.      * </p>
  348.      * @return base frame associated with the station
  349.      */
  350.     public TopocentricFrame getBaseFrame() {
  351.         return baseFrame;
  352.     }

  354.     /** Get the estimated Earth frame, including the estimated linear models for pole and prime meridian.
  355.      * <p>
  356.      * This frame is bound to the {@link #getPrimeMeridianOffsetDriver() driver for prime meridian offset},
  357.      * {@link #getPrimeMeridianDriftDriver() driver prime meridian drift},
  358.      * {@link #getPolarOffsetXDriver() driver for polar offset along X},
  359.      * {@link #getPolarDriftXDriver() driver for polar drift along X},
  360.      * {@link #getPolarOffsetYDriver() driver for polar offset along Y},
  361.      * {@link #getPolarDriftYDriver() driver for polar drift along Y}, so its orientation changes when
  362.      * the {@link ParameterDriver#setValue(double) setValue} methods of the drivers are called.
  363.      * </p>
  364.      * @return estimated Earth frame
  365.      * @since 9.1
  366.      */
  367.     public Frame getEstimatedEarthFrame() {
  368.         return estimatedEarthFrame;
  369.     }

  371.     /** Get the estimated UT1 scale, including the estimated linear models for prime meridian.
  372.      * <p>
  373.      * This time scale is bound to the {@link #getPrimeMeridianOffsetDriver() driver for prime meridian offset},
  374.      * and {@link #getPrimeMeridianDriftDriver() driver prime meridian drift}, so its offset from UTC changes when
  375.      * the {@link ParameterDriver#setValue(double) setValue} methods of the drivers are called.
  376.      * </p>
  377.      * @return estimated Earth frame
  378.      * @since 9.1
  379.      */
  380.     public UT1Scale getEstimatedUT1() {
  381.         return estimatedEarthFrameProvider.getEstimatedUT1();
  382.     }

  384.     /** Get the station displacement.
  385.      * @param date current date
  386.      * @param position raw position of the station in Earth frame
  387.      * before displacement is applied
  388.      * @return station displacement
  389.      * @since 9.1
  390.      */
  391.     private Vector3D computeDisplacement(final AbsoluteDate date, final Vector3D position) {
  392.         Vector3D displacement = Vector3D.ZERO;
  393.         if (arguments != null) {
  394.             final BodiesElements elements = arguments.evaluateAll(date);
  395.             for (final StationDisplacement sd : displacements) {
  396.                 // we consider all displacements apply to the same initial position,
  397.                 // i.e. they apply simultaneously, not according to some order
  398.                 displacement = displacement.add(sd.displacement(elements, estimatedEarthFrame, position));
  399.             }
  400.         }
  401.         return displacement;
  402.     }

  404.     /** Get the geodetic point at the center of the offset frame.
  405.      * @param date current date (may be null if displacements are ignored)
  406.      * @return geodetic point at the center of the offset frame
  407.      * @since 9.1
  408.      */
  409.     public GeodeticPoint getOffsetGeodeticPoint(final AbsoluteDate date) {

  411.         // take station offset into account
  412.         final double    x          = eastOffsetDriver.getValue();
  413.         final double    y          = northOffsetDriver.getValue();
  414.         final double    z          = zenithOffsetDriver.getValue();
  415.         final BodyShape baseShape  = baseFrame.getParentShape();
  416.         final Transform baseToBody = baseFrame.getTransformTo(baseShape.getBodyFrame(), date);
  417.         Vector3D        origin     = baseToBody.transformPosition(new Vector3D(x, y, z));

  419.         if (date != null) {
  420.             origin = origin.add(computeDisplacement(date, origin));
  421.         }

  423.         return baseShape.transform(origin, baseShape.getBodyFrame(), null);

  425.     }

  427.     /** Get the transform between offset frame and inertial frame.
  428.      * <p>
  429.      * The offset frame takes the <em>current</em> position offset,
  430.      * polar motion and the meridian shift into account. The frame
  431.      * returned is disconnected from later changes in the parameters.
  432.      * When the {@link ParameterDriver parameters} managing these
  433.      * offsets are changed, the method must be called again to retrieve
  434.      * a new offset frame.
  435.      * </p>
  436.      * @param inertial inertial frame to transform to
  437.      * @param clockDate date of the transform as read by the ground station clock (i.e. clock offset <em>not</em> compensated)
  438.      * @return transform between offset frame and inertial frame, at <em>real</em> measurement
  439.      * date (i.e. with clock, Earth and station offsets applied)
  440.      */
  441.     public Transform getOffsetToInertial(final Frame inertial, final AbsoluteDate clockDate) {

  443.         // take clock offset into account
  444.         final double offset = clockOffsetDriver.getValue();
  445.         final AbsoluteDate offsetCompensatedDate = new AbsoluteDate(clockDate, -offset);

  447.         // take Earth offsets into account
  448.         final Transform intermediateToBody = estimatedEarthFrameProvider.getTransform(offsetCompensatedDate).getInverse();

  450.         // take station offsets into account
  451.         final double    x          = eastOffsetDriver.getValue();
  452.         final double    y          = northOffsetDriver.getValue();
  453.         final double    z          = zenithOffsetDriver.getValue();
  454.         final BodyShape baseShape  = baseFrame.getParentShape();
  455.         final Transform baseToBody = baseFrame.getTransformTo(baseShape.getBodyFrame(), offsetCompensatedDate);
  456.         Vector3D        origin     = baseToBody.transformPosition(new Vector3D(x, y, z));
  457.         origin = origin.add(computeDisplacement(offsetCompensatedDate, origin));

  459.         final GeodeticPoint originGP = baseShape.transform(origin, baseShape.getBodyFrame(), offsetCompensatedDate);
  460.         final Transform offsetToIntermediate =
  461.                         new Transform(offsetCompensatedDate,
  462.                                       new Transform(offsetCompensatedDate,
  463.                                                     new Rotation(Vector3D.PLUS_I, Vector3D.PLUS_K,
  464.                                                                  originGP.getEast(), originGP.getZenith()),
  465.                                                     Vector3D.ZERO),
  466.                                       new Transform(offsetCompensatedDate, origin));

  468.         // combine all transforms together
  469.         final Transform bodyToInert        = baseFrame.getParent().getTransformTo(inertial, offsetCompensatedDate);

  471.         return new Transform(offsetCompensatedDate, offsetToIntermediate, new Transform(offsetCompensatedDate, intermediateToBody, bodyToInert));

  473.     }

  475.     /** Get the transform between offset frame and inertial frame with derivatives.
  476.      * <p>
  477.      * As the East and North vectors are not well defined at pole, the derivatives
  478.      * of these two vectors diverge to infinity as we get closer to the pole.
  479.      * So this method should not be used for stations less than 0.0001 degree from
  480.      * either poles.
  481.      * </p>
  482.      * @param inertial inertial frame to transform to
  483.      * @param clockDate date of the transform as read by the ground station clock (i.e. clock offset <em>not</em> compensated)
  484.      * @param factory factory for the derivatives
  485.      * @param indices indices of the estimated parameters in derivatives computations
  486.      * @return transform between offset frame and inertial frame, at <em>real</em> measurement
  487.      * date (i.e. with clock, Earth and station offsets applied)
  488.      * @see #getOffsetToInertial(Frame, FieldAbsoluteDate, DSFactory, Map)
  489.      * @since 9.3
  490.      * @deprecated as of 10.2, replaced by {@link #getOffsetToInertial(Frame, AbsoluteDate, int, Map)}
  491.      */
  492.     @Deprecated
  493.     public FieldTransform<DerivativeStructure> getOffsetToInertial(final Frame inertial,
  494.                                                                    final AbsoluteDate clockDate,
  495.                                                                    final DSFactory factory,
  496.                                                                    final Map<String, Integer> indices) {
  497.         // take clock offset into account
  498.         final DerivativeStructure offset = clockOffsetDriver.getValue(factory, indices);
  499.         final FieldAbsoluteDate<DerivativeStructure> offsetCompensatedDate =
  500.                         new FieldAbsoluteDate<DerivativeStructure>(clockDate, offset.negate());

  502.         return getOffsetToInertial(inertial, offsetCompensatedDate, factory, indices);
  503.     }

  505.     /** Get the transform between offset frame and inertial frame with derivatives.
  506.      * <p>
  507.      * As the East and North vectors are not well defined at pole, the derivatives
  508.      * of these two vectors diverge to infinity as we get closer to the pole.
  509.      * So this method should not be used for stations less than 0.0001 degree from
  510.      * either poles.
  511.      * </p>
  512.      * @param inertial inertial frame to transform to
  513.      * @param offsetCompensatedDate date of the transform, clock offset and its derivatives already compensated
  514.      * @param factory factory for the derivatives
  515.      * @param indices indices of the estimated parameters in derivatives computations
  516.      * @return transform between offset frame and inertial frame, at specified date
  517.      * @see #getOffsetToInertial(Frame, AbsoluteDate, DSFactory, Map)
  518.      * @since 9.0
  519.      * @deprecated as of 10.2, replaced by {@link #getOffsetToInertial(Frame, FieldAbsoluteDate, int, Map)}
  520.      */
  521.     @Deprecated
  522.     public FieldTransform<DerivativeStructure> getOffsetToInertial(final Frame inertial,
  523.                                                                    final FieldAbsoluteDate<DerivativeStructure> offsetCompensatedDate,
  524.                                                                    final DSFactory factory,
  525.                                                                    final Map<String, Integer> indices) {

  527.         final Field<DerivativeStructure>         field = factory.getDerivativeField();
  528.         final FieldVector3D<DerivativeStructure> zero  = FieldVector3D.getZero(field);
  529.         final FieldVector3D<DerivativeStructure> plusI = FieldVector3D.getPlusI(field);
  530.         final FieldVector3D<DerivativeStructure> plusK = FieldVector3D.getPlusK(field);

  532.         // take Earth offsets into account
  533.         final FieldTransform<DerivativeStructure> intermediateToBody =
  534.                         estimatedEarthFrameProvider.getTransform(offsetCompensatedDate, factory, indices).getInverse();

  536.         // take station offsets into account
  537.         final DerivativeStructure  x          = eastOffsetDriver.getValue(factory, indices);
  538.         final DerivativeStructure  y          = northOffsetDriver.getValue(factory, indices);
  539.         final DerivativeStructure  z          = zenithOffsetDriver.getValue(factory, indices);
  540.         final BodyShape            baseShape  = baseFrame.getParentShape();
  541.         final Transform            baseToBody = baseFrame.getTransformTo(baseShape.getBodyFrame(), (AbsoluteDate) null);

  543.         FieldVector3D<DerivativeStructure>            origin   = baseToBody.transformPosition(new FieldVector3D<>(x, y, z));
  544.         origin = origin.add(computeDisplacement(offsetCompensatedDate.toAbsoluteDate(), origin.toVector3D()));
  545.         final FieldGeodeticPoint<DerivativeStructure> originGP = baseShape.transform(origin, baseShape.getBodyFrame(), offsetCompensatedDate);
  546.         final FieldTransform<DerivativeStructure> offsetToIntermediate =
  547.                         new FieldTransform<>(offsetCompensatedDate,
  548.                                              new FieldTransform<>(offsetCompensatedDate,
  549.                                                                   new FieldRotation<>(plusI, plusK,
  550.                                                                                       originGP.getEast(), originGP.getZenith()),
  551.                                                                   zero),
  552.                                              new FieldTransform<>(offsetCompensatedDate, origin));

  554.         // combine all transforms together
  555.         final FieldTransform<DerivativeStructure> bodyToInert        = baseFrame.getParent().getTransformTo(inertial, offsetCompensatedDate);

  557.         return new FieldTransform<>(offsetCompensatedDate,
  558.                                     offsetToIntermediate,
  559.                                     new FieldTransform<>(offsetCompensatedDate, intermediateToBody, bodyToInert));

  561.     }

  563.     /** Get the transform between offset frame and inertial frame with derivatives.
  564.      * <p>
  565.      * As the East and North vectors are not well defined at pole, the derivatives
  566.      * of these two vectors diverge to infinity as we get closer to the pole.
  567.      * So this method should not be used for stations less than 0.0001 degree from
  568.      * either poles.
  569.      * </p>
  570.      * @param inertial inertial frame to transform to
  571.      * @param clockDate date of the transform as read by the ground station clock (i.e. clock offset <em>not</em> compensated)
  572.      * @param freeParameters total number of free parameters in the gradient
  573.      * @param indices indices of the estimated parameters in derivatives computations
  574.      * @return transform between offset frame and inertial frame, at <em>real</em> measurement
  575.      * date (i.e. with clock, Earth and station offsets applied)
  576.      * @see #getOffsetToInertial(Frame, FieldAbsoluteDate, DSFactory, Map)
  577.      * @since 10.2
  578.      */
  579.     public FieldTransform<Gradient> getOffsetToInertial(final Frame inertial,
  580.                                                         final AbsoluteDate clockDate,
  581.                                                         final int freeParameters,
  582.                                                         final Map<String, Integer> indices) {
  583.         // take clock offset into account
  584.         final Gradient offset = clockOffsetDriver.getValue(freeParameters, indices);
  585.         final FieldAbsoluteDate<Gradient> offsetCompensatedDate =
  586.                         new FieldAbsoluteDate<>(clockDate, offset.negate());

  588.         return getOffsetToInertial(inertial, offsetCompensatedDate, freeParameters, indices);
  589.     }

  591.     /** Get the transform between offset frame and inertial frame with derivatives.
  592.      * <p>
  593.      * As the East and North vectors are not well defined at pole, the derivatives
  594.      * of these two vectors diverge to infinity as we get closer to the pole.
  595.      * So this method should not be used for stations less than 0.0001 degree from
  596.      * either poles.
  597.      * </p>
  598.      * @param inertial inertial frame to transform to
  599.      * @param offsetCompensatedDate date of the transform, clock offset and its derivatives already compensated
  600.      * @param freeParameters total number of free parameters in the gradient
  601.      * @param indices indices of the estimated parameters in derivatives computations
  602.      * @return transform between offset frame and inertial frame, at specified date
  603.      * @see #getOffsetToInertial(Frame, AbsoluteDate, DSFactory, Map)
  604.      * @since 10.2
  605.      */
  606.     public FieldTransform<Gradient> getOffsetToInertial(final Frame inertial,
  607.                                                         final FieldAbsoluteDate<Gradient> offsetCompensatedDate,
  608.                                                         final int freeParameters,
  609.                                                         final Map<String, Integer> indices) {

  611.         final Field<Gradient>         field = offsetCompensatedDate.getField();
  612.         final FieldVector3D<Gradient> zero  = FieldVector3D.getZero(field);
  613.         final FieldVector3D<Gradient> plusI = FieldVector3D.getPlusI(field);
  614.         final FieldVector3D<Gradient> plusK = FieldVector3D.getPlusK(field);

  616.         // take Earth offsets into account
  617.         final FieldTransform<Gradient> intermediateToBody =
  618.                         estimatedEarthFrameProvider.getTransform(offsetCompensatedDate, freeParameters, indices).getInverse();

  620.         // take station offsets into account
  621.         final Gradient  x          = eastOffsetDriver.getValue(freeParameters, indices);
  622.         final Gradient  y          = northOffsetDriver.getValue(freeParameters, indices);
  623.         final Gradient  z          = zenithOffsetDriver.getValue(freeParameters, indices);
  624.         final BodyShape            baseShape  = baseFrame.getParentShape();
  625.         final Transform            baseToBody = baseFrame.getTransformTo(baseShape.getBodyFrame(), (AbsoluteDate) null);

  627.         FieldVector3D<Gradient> origin = baseToBody.transformPosition(new FieldVector3D<>(x, y, z));
  628.         origin = origin.add(computeDisplacement(offsetCompensatedDate.toAbsoluteDate(), origin.toVector3D()));
  629.         final FieldGeodeticPoint<Gradient> originGP = baseShape.transform(origin, baseShape.getBodyFrame(), offsetCompensatedDate);
  630.         final FieldTransform<Gradient> offsetToIntermediate =
  631.                         new FieldTransform<>(offsetCompensatedDate,
  632.                                              new FieldTransform<>(offsetCompensatedDate,
  633.                                                                   new FieldRotation<>(plusI, plusK,
  634.                                                                                       originGP.getEast(), originGP.getZenith()),
  635.                                                                   zero),
  636.                                              new FieldTransform<>(offsetCompensatedDate, origin));

  638.         // combine all transforms together
  639.         final FieldTransform<Gradient> bodyToInert = baseFrame.getParent().getTransformTo(inertial, offsetCompensatedDate);

  641.         return new FieldTransform<>(offsetCompensatedDate,
  642.                                     offsetToIntermediate,
  643.                                     new FieldTransform<>(offsetCompensatedDate, intermediateToBody, bodyToInert));

  645.     }

  647. }
Created with JaCoCo 0.8.6.202009150832