TurnAroundRangeTroposphericDelayModifier.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.modifiers;

  19. import java.util.Arrays;
  20. import java.util.List;

  22. import org.hipparchus.Field;
  23. import org.hipparchus.RealFieldElement;
  24. import org.hipparchus.analysis.differentiation.DerivativeStructure;
  25. import org.hipparchus.geometry.euclidean.threed.FieldVector3D;
  26. import org.hipparchus.geometry.euclidean.threed.Vector3D;
  27. import org.orekit.attitudes.InertialProvider;
  28. import org.orekit.estimation.measurements.EstimatedMeasurement;
  29. import org.orekit.estimation.measurements.EstimationModifier;
  30. import org.orekit.estimation.measurements.GroundStation;
  31. import org.orekit.estimation.measurements.TurnAroundRange;
  32. import org.orekit.models.earth.troposphere.DiscreteTroposphericModel;
  33. import org.orekit.propagation.FieldSpacecraftState;
  34. import org.orekit.propagation.SpacecraftState;
  35. import org.orekit.utils.Differentiation;
  36. import org.orekit.utils.ParameterDriver;
  37. import org.orekit.utils.ParameterFunction;

  39. /** Class modifying theoretical turn-around TurnAroundRange measurement with tropospheric delay.
  40.  * The effect of tropospheric correction on the TurnAroundRange is directly computed
  41.  * through the computation of the tropospheric delay.
  42.  *
  43.  * In general, for GNSS, VLBI, ... there is hardly any frequency dependence in the delay.
  44.  * For SLR techniques however, the frequency dependence is sensitive.
  45.  *
  46.  * @author Maxime Journot
  47.  * @since 9.0
  48.  */
  49. public class TurnAroundRangeTroposphericDelayModifier implements EstimationModifier<TurnAroundRange> {

  51.     /** Tropospheric delay model. */
  52.     private final DiscreteTroposphericModel tropoModel;

  54.     /** Constructor.
  55.      *
  56.      * @param model  Tropospheric delay model appropriate for the current TurnAroundRange measurement method.
  57.      */
  58.     public TurnAroundRangeTroposphericDelayModifier(final DiscreteTroposphericModel model) {
  59.         tropoModel = model;
  60.     }

  62.     /** Get the station height above mean sea level.
  63.      *
  64.      * @param station  ground station (or measuring station)
  65.      * @return the measuring station height above sea level, m
  66.      */
  67.     private double getStationHeightAMSL(final GroundStation station) {
  68.         // FIXME height should be computed with respect to geoid WGS84+GUND = EGM2008 for example
  69.         final double height = station.getBaseFrame().getPoint().getAltitude();
  70.         return height;
  71.     }

  73.     /** Get the station height above mean sea level.
  74.     * @param <T> type of the elements
  75.     * @param field field of the elements
  76.     * @param station  ground station (or measuring station)
  77.     * @return the measuring station height above sea level, m
  78.     */
  79.     private <T extends RealFieldElement<T>> T getStationHeightAMSL(final Field<T> field,
  80.                                                                    final GroundStation station) {
  81.         // FIXME heigth should be computed with respect to geoid WGS84+GUND = EGM2008 for example
  82.         final T height = station.getBaseFrame().getPoint(field).getAltitude();
  83.         return height;
  84.     }

  86.     /** Compute the measurement error due to Troposphere.
  87.      * @param station station
  88.      * @param state spacecraft state
  89.      * @return the measurement error due to Troposphere
  90.      */
  91.     private double rangeErrorTroposphericModel(final GroundStation station, final SpacecraftState state) {
  92.         //
  93.         final Vector3D position = state.getPVCoordinates().getPosition();

  95.         // elevation
  96.         final double elevation = station.getBaseFrame().getElevation(position,
  97.                                                                      state.getFrame(),
  98.                                                                      state.getDate());

  100.         // only consider measures above the horizon
  101.         if (elevation > 0) {
  102.             // altitude AMSL in meters
  103.             final double height = getStationHeightAMSL(station);

  105.             // Delay in meters
  106.             final double delay = tropoModel.pathDelay(elevation, height, tropoModel.getParameters(), state.getDate());

  108.             return delay;
  109.         }

  111.         return 0;
  112.     }

  114.     /** Compute the measurement error due to Troposphere.
  115.      * @param <T> type of the element
  116.      * @param station station
  117.      * @param state spacecraft state
  118.      * @param parameters tropospheric model parameters
  119.      * @return the measurement error due to Troposphere
  120.      */
  121.     private <T extends RealFieldElement<T>> T rangeErrorTroposphericModel(final GroundStation station,
  122.                                                                           final FieldSpacecraftState<T> state,
  123.                                                                           final T[] parameters) {
  124.         // Field
  125.         final Field<T> field = state.getDate().getField();
  126.         final T zero         = field.getZero();

  128.         //
  129.         final FieldVector3D<T> position = state.getPVCoordinates().getPosition();
  130.         final T dsElevation             = station.getBaseFrame().getElevation(position,
  131.                                                                               state.getFrame(),
  132.                                                                               state.getDate());

  134.         // only consider measures above the horizon
  135.         if (dsElevation.getReal() > 0) {
  136.             // altitude AMSL in meters
  137.             final T height = getStationHeightAMSL(field, station);

  139.             // Delay in meters
  140.             final T delay = tropoModel.pathDelay(dsElevation, height, parameters, state.getDate());

  142.             return delay;
  143.         }

  145.         return zero;
  146.     }

  148.     /** Compute the Jacobian of the delay term wrt state using
  149.     * automatic differentiation.
  150.     *
  151.     * @param derivatives tropospheric delay derivatives
  152.     * @param freeStateParameters dimension of the state.
  153.     *
  154.     * @return Jacobian of the delay wrt state
  155.     */
  156.     private double[][] rangeErrorJacobianState(final double[] derivatives, final int freeStateParameters) {
  157.         final double[][] finiteDifferencesJacobian = new double[1][6];
  158.         for (int i = 0; i < freeStateParameters; i++) {
  159.             // First element is the value of the delay
  160.             finiteDifferencesJacobian[0][i] = derivatives[i + 1];
  161.         }
  162.         return finiteDifferencesJacobian;
  163.     }


  166.     /** Compute the derivative of the delay term wrt parameters.
  167.      *
  168.      * @param station ground station
  169.      * @param driver driver for the station offset parameter
  170.      * @param state spacecraft state
  171.      * @return derivative of the delay wrt station offset parameter
  172.      */
  173.     private double rangeErrorParameterDerivative(final GroundStation station,
  174.                                                  final ParameterDriver driver,
  175.                                                  final SpacecraftState state) {

  177.         final ParameterFunction rangeError = new ParameterFunction() {
  178.             /** {@inheritDoc} */
  179.             @Override
  180.             public double value(final ParameterDriver parameterDriver) {
  181.                 return rangeErrorTroposphericModel(station, state);
  182.             }
  183.         };

  185.         final ParameterFunction rangeErrorDerivative = Differentiation.differentiate(rangeError, 3, 10.0 * driver.getScale());

  187.         return rangeErrorDerivative.value(driver);

  189.     }

  191.     /** Compute the derivative of the delay term wrt parameters using
  192.     * automatic differentiation.
  193.     *
  194.     * @param derivatives tropospheric delay derivatives
  195.     * @param freeStateParameters dimension of the state.
  196.     * @return derivative of the delay wrt tropospheric model parameters
  197.     */
  198.     private double[] rangeErrorParameterDerivative(final double[] derivatives, final int freeStateParameters) {
  199.         // 0                               -> value of the delay
  200.         // 1 ... freeStateParameters       -> derivatives of the delay wrt state
  201.         // freeStateParameters + 1 ... n   -> derivatives of the delay wrt tropospheric parameters
  202.         final int dim = derivatives.length - 1 - freeStateParameters;
  203.         final double[] rangeError = new double[dim];

  205.         for (int i = 0; i < dim; i++) {
  206.             rangeError[i] = derivatives[1 + freeStateParameters + i];
  207.         }

  209.         return rangeError;
  210.     }

  212.     /** {@inheritDoc} */
  213.     @Override
  214.     public List<ParameterDriver> getParametersDrivers() {
  215.         return tropoModel.getParametersDrivers();
  216.     }

  218.     /** {@inheritDoc} */
  219.     @Override
  220.     public void modify(final EstimatedMeasurement<TurnAroundRange> estimated) {
  221.         final TurnAroundRange measurement   = estimated.getObservedMeasurement();
  222.         final GroundStation   masterStation = measurement.getMasterStation();
  223.         final GroundStation   slaveStation  = measurement.getSlaveStation();
  224.         final SpacecraftState state         = estimated.getStates()[0];

  226.         final double[] oldValue = estimated.getEstimatedValue();

  228.         // Update estimated derivatives with Jacobian of the measure wrt state
  229.         final TroposphericDSConverter converter =
  230.                 new TroposphericDSConverter(state, 6, new InertialProvider(state.getFrame()));
  231.         final FieldSpacecraftState<DerivativeStructure> dsState = converter.getState(tropoModel);
  232.         final DerivativeStructure[] dsParameters = converter.getParameters(dsState, tropoModel);
  233.         final DerivativeStructure masterDSDelay = rangeErrorTroposphericModel(masterStation, dsState, dsParameters);
  234.         final DerivativeStructure slaveDSDelay = rangeErrorTroposphericModel(slaveStation, dsState, dsParameters);
  235.         final double[] masterDerivatives = masterDSDelay.getAllDerivatives();
  236.         final double[] slaveDerivatives  = masterDSDelay.getAllDerivatives();

  238.         final double[][] masterDjac = rangeErrorJacobianState(masterDerivatives, converter.getFreeStateParameters());
  239.         final double[][] slaveDjac  = rangeErrorJacobianState(slaveDerivatives, converter.getFreeStateParameters());
  240.         final double[][] stateDerivatives = estimated.getStateDerivatives(0);
  241.         for (int irow = 0; irow < stateDerivatives.length; ++irow) {
  242.             for (int jcol = 0; jcol < stateDerivatives[0].length; ++jcol) {
  243.                 stateDerivatives[irow][jcol] += masterDjac[irow][jcol] + slaveDjac[irow][jcol];
  244.             }
  245.         }
  246.         estimated.setStateDerivatives(0, stateDerivatives);

  248.         int indexMaster = 0;
  249.         for (final ParameterDriver driver : getParametersDrivers()) {
  250.             if (driver.isSelected()) {
  251.                 // update estimated derivatives with derivative of the modification wrt tropospheric parameters
  252.                 double parameterDerivative = estimated.getParameterDerivatives(driver)[0];
  253.                 final double[] derivatives = rangeErrorParameterDerivative(masterDerivatives, converter.getFreeStateParameters());
  254.                 parameterDerivative += derivatives[indexMaster];
  255.                 estimated.setParameterDerivatives(driver, parameterDerivative);
  256.                 indexMaster += 1;
  257.             }

  259.         }

  261.         int indexSlave = 0;
  262.         for (final ParameterDriver driver : getParametersDrivers()) {
  263.             if (driver.isSelected()) {
  264.                 // update estimated derivatives with derivative of the modification wrt tropospheric parameters
  265.                 double parameterDerivative = estimated.getParameterDerivatives(driver)[0];
  266.                 final double[] derivatives = rangeErrorParameterDerivative(slaveDerivatives, converter.getFreeStateParameters());
  267.                 parameterDerivative += derivatives[indexSlave];
  268.                 estimated.setParameterDerivatives(driver, parameterDerivative);
  269.                 indexSlave += 1;
  270.             }

  272.         }

  274.         // Update derivatives with respect to master station position
  275.         for (final ParameterDriver driver : Arrays.asList(masterStation.getClockOffsetDriver(),
  276.                                                           masterStation.getEastOffsetDriver(),
  277.                                                           masterStation.getNorthOffsetDriver(),
  278.                                                           masterStation.getZenithOffsetDriver())) {
  279.             if (driver.isSelected()) {
  280.                 double parameterDerivative = estimated.getParameterDerivatives(driver)[0];
  281.                 parameterDerivative += rangeErrorParameterDerivative(masterStation, driver, state);
  282.                 estimated.setParameterDerivatives(driver, parameterDerivative);
  283.             }
  284.         }

  286.         // Update derivatives with respect to slave station position
  287.         for (final ParameterDriver driver : Arrays.asList(slaveStation.getEastOffsetDriver(),
  288.                                                           slaveStation.getNorthOffsetDriver(),
  289.                                                           slaveStation.getZenithOffsetDriver())) {
  290.             if (driver.isSelected()) {
  291.                 double parameterDerivative = estimated.getParameterDerivatives(driver)[0];
  292.                 parameterDerivative += rangeErrorParameterDerivative(slaveStation, driver, state);
  293.                 estimated.setParameterDerivatives(driver, parameterDerivative);
  294.             }
  295.         }

  297.         // Update estimated value taking into account the tropospheric delay.
  298.         // The tropospheric delay is directly added to the TurnAroundRange.
  299.         final double[] newValue = oldValue.clone();
  300.         newValue[0] = newValue[0] + masterDSDelay.getReal() + slaveDSDelay.getReal();
  301.         estimated.setEstimatedValue(newValue);

  303.     }

  305. }
Created with JaCoCo 0.8.5.201910111838