IonosphericDSConverter.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.ArrayList;
  20. import java.util.List;

  22. import org.hipparchus.analysis.differentiation.DSFactory;
  23. import org.hipparchus.analysis.differentiation.DerivativeStructure;
  24. import org.hipparchus.geometry.euclidean.threed.FieldRotation;
  25. import org.hipparchus.geometry.euclidean.threed.FieldVector3D;
  26. import org.hipparchus.geometry.euclidean.threed.Vector3D;
  27. import org.orekit.attitudes.AttitudeProvider;
  28. import org.orekit.attitudes.FieldAttitude;
  29. import org.orekit.models.earth.ionosphere.IonosphericModel;
  30. import org.orekit.orbits.FieldCartesianOrbit;
  31. import org.orekit.orbits.FieldOrbit;
  32. import org.orekit.propagation.FieldSpacecraftState;
  33. import org.orekit.propagation.SpacecraftState;
  34. import org.orekit.utils.FieldAngularCoordinates;
  35. import org.orekit.utils.FieldPVCoordinates;
  36. import org.orekit.utils.ParameterDriver;
  37. import org.orekit.utils.TimeStampedFieldAngularCoordinates;
  38. import org.orekit.utils.TimeStampedFieldPVCoordinates;

  40. /** Converter for states and parameters arrays.
  41.  * @author Bryan Cazabonne
  42.  * @deprecated as of 10.2, replaced by {@link IonosphericGradientConverter}
  43.  * @since 10.0
  44.  */
  45. @Deprecated
  46. public class IonosphericDSConverter {

  48.     /** Dimension of the state. */
  49.     private final int freeStateParameters;

  51.     /** States with various number of additional parameters for ionospheric models. */
  52.     private final List<FieldSpacecraftState<DerivativeStructure>> dsStates;

  54.     /** Simple constructor.
  55.      * @param state regular state
  56.      * @param freeStateParameters number of free parameters, either 3 (position) or 6 (position-velocity)
  57.      * @param provider provider to use if attitude needs to be recomputed
  58.      */
  59.     public IonosphericDSConverter(final SpacecraftState state, final int freeStateParameters, final AttitudeProvider provider) {

  61.         this.freeStateParameters = freeStateParameters;

  63.         // prepare derivation variables, position, optionally velocity
  64.         final DSFactory factory = new DSFactory(freeStateParameters, 1);

  66.         // position always has derivatives
  67.         final Vector3D pos = state.getPVCoordinates().getPosition();
  68.         final FieldVector3D<DerivativeStructure> posDS = new FieldVector3D<>(factory.variable(0, pos.getX()),
  69.                                                                              factory.variable(1, pos.getY()),
  70.                                                                              factory.variable(2, pos.getZ()));

  72.         // velocity may have derivatives or not
  73.         final Vector3D vel = state.getPVCoordinates().getVelocity();
  74.         final FieldVector3D<DerivativeStructure> velDS;
  75.         if (freeStateParameters > 3) {
  76.             velDS = new FieldVector3D<>(factory.variable(3, vel.getX()),
  77.                                         factory.variable(4, vel.getY()),
  78.                                         factory.variable(5, vel.getZ()));
  79.         } else {
  80.             velDS = new FieldVector3D<>(factory.constant(vel.getX()),
  81.                                         factory.constant(vel.getY()),
  82.                                         factory.constant(vel.getZ()));
  83.         }

  85.         // acceleration never has derivatives
  86.         final Vector3D acc = state.getPVCoordinates().getAcceleration();
  87.         final FieldVector3D<DerivativeStructure> accDS = new FieldVector3D<>(factory.constant(acc.getX()),
  88.                                                                              factory.constant(acc.getY()),
  89.                                                                              factory.constant(acc.getZ()));

  91.         // mass never has derivatives
  92.         final DerivativeStructure dsM = factory.constant(state.getMass());

  94.         final FieldOrbit<DerivativeStructure> dsOrbit =
  95.                         new FieldCartesianOrbit<>(new TimeStampedFieldPVCoordinates<>(state.getDate(), posDS, velDS, accDS),
  96.                                                   state.getFrame(),
  97.                                                   factory.getDerivativeField().getZero().add(state.getMu()));

  99.         final FieldAttitude<DerivativeStructure> dsAttitude;
  100.         if (freeStateParameters > 3) {
  101.             // compute attitude partial derivatives with respect to position/velocity
  102.             dsAttitude = provider.getAttitude(dsOrbit, dsOrbit.getDate(), dsOrbit.getFrame());
  103.         } else {
  104.             // force model does not depend on attitude, don't bother recomputing it
  105.             dsAttitude = new FieldAttitude<>(factory.getDerivativeField(), state.getAttitude());
  106.         }

  108.         // initialize the list with the state having 0 formce model parameters
  109.         dsStates = new ArrayList<>();
  110.         dsStates.add(new FieldSpacecraftState<>(dsOrbit, dsAttitude, dsM));

  112.     }

  114.     /** Get the number of free state parameters.
  115.      * @return number of free state parameters
  116.      */
  117.     public int getFreeStateParameters() {
  118.         return freeStateParameters;
  119.     }

  121.     /** Get the state with the number of parameters consistent with ionospheric model.
  122.      * @param ionoModel ionospheric model
  123.      * @return state with the number of parameters consistent with ionospheric model
  124.      */
  125.     public FieldSpacecraftState<DerivativeStructure> getState(final IonosphericModel ionoModel) {

  127.         // count the required number of parameters
  128.         int nbParams = 0;
  129.         for (final ParameterDriver driver : ionoModel.getParametersDrivers()) {
  130.             if (driver.isSelected()) {
  131.                 ++nbParams;
  132.             }
  133.         }

  135.         // fill in intermediate slots
  136.         while (dsStates.size() < nbParams + 1) {
  137.             dsStates.add(null);
  138.         }

  140.         if (dsStates.get(nbParams) == null) {
  141.             // it is the first time we need this number of parameters
  142.             // we need to create the state
  143.             final DSFactory factory = new DSFactory(freeStateParameters + nbParams, 1);
  144.             final FieldSpacecraftState<DerivativeStructure> s0 = dsStates.get(0);

  146.             // orbit
  147.             final FieldPVCoordinates<DerivativeStructure> pv0 = s0.getPVCoordinates();
  148.             final FieldOrbit<DerivativeStructure> dsOrbit =
  149.                             new FieldCartesianOrbit<>(new TimeStampedFieldPVCoordinates<>(s0.getDate().toAbsoluteDate(),
  150.                                                                                           extend(pv0.getPosition(),     factory),
  151.                                                                                           extend(pv0.getVelocity(),     factory),
  152.                                                                                           extend(pv0.getAcceleration(), factory)),
  153.                                                       s0.getFrame(), extend(s0.getMu(), factory));

  155.             // attitude
  156.             final FieldAngularCoordinates<DerivativeStructure> ac0 = s0.getAttitude().getOrientation();
  157.             final FieldAttitude<DerivativeStructure> dsAttitude =
  158.                             new FieldAttitude<>(s0.getAttitude().getReferenceFrame(),
  159.                                                 new TimeStampedFieldAngularCoordinates<>(dsOrbit.getDate(),
  160.                                                                                          extend(ac0.getRotation(), factory),
  161.                                                                                          extend(ac0.getRotationRate(), factory),
  162.                                                                                          extend(ac0.getRotationAcceleration(), factory)));

  164.             // mass
  165.             final DerivativeStructure dsM = extend(s0.getMass(), factory);

  167.             dsStates.set(nbParams, new FieldSpacecraftState<>(dsOrbit, dsAttitude, dsM));

  169.         }

  171.         return dsStates.get(nbParams);

  173.     }

  175.     /** Add zero derivatives.
  176.      * @param original original scalar
  177.      * @param factory factory for the extended derivatives
  178.      * @return extended scalar
  179.      */
  180.     private DerivativeStructure extend(final DerivativeStructure original, final DSFactory factory) {
  181.         final double[] originalDerivatives = original.getAllDerivatives();
  182.         final double[] extendedDerivatives = new double[factory.getCompiler().getSize()];
  183.         System.arraycopy(originalDerivatives, 0, extendedDerivatives, 0, originalDerivatives.length);
  184.         return factory.build(extendedDerivatives);
  185.     }

  187.     /** Add zero derivatives.
  188.      * @param original original vector
  189.      * @param factory factory for the extended derivatives
  190.      * @return extended vector
  191.      */
  192.     private FieldVector3D<DerivativeStructure> extend(final FieldVector3D<DerivativeStructure> original, final DSFactory factory) {
  193.         return new FieldVector3D<>(extend(original.getX(), factory),
  194.                         extend(original.getY(), factory),
  195.                         extend(original.getZ(), factory));
  196.     }

  198.     /** Add zero derivatives.
  199.      * @param original original rotation
  200.      * @param factory factory for the extended derivatives
  201.      * @return extended rotation
  202.      */
  203.     private FieldRotation<DerivativeStructure> extend(final FieldRotation<DerivativeStructure> original, final DSFactory factory) {
  204.         return new FieldRotation<>(extend(original.getQ0(), factory),
  205.                         extend(original.getQ1(), factory),
  206.                         extend(original.getQ2(), factory),
  207.                         extend(original.getQ3(), factory),
  208.                         false);
  209.     }

  211.     /** Get the ionospheric model parameters.
  212.      * @param state state as returned by {@link #getState(IonosphericModel)}
  213.      * @param ionoModel ionospheric model associated with the parameters
  214.      * @return ionospheric model parameters
  215.      */
  216.     public DerivativeStructure[] getParameters(final FieldSpacecraftState<DerivativeStructure> state,
  217.                                                final IonosphericModel ionoModel) {
  218.         final DSFactory factory = state.getMass().getFactory();
  219.         final List<ParameterDriver> drivers = ionoModel.getParametersDrivers();
  220.         final DerivativeStructure[] parameters = new DerivativeStructure[drivers.size()];
  221.         int index = freeStateParameters;
  222.         for (int i = 0; i < drivers.size(); ++i) {
  223.             parameters[i] = drivers.get(i).isSelected() ?
  224.                             factory.variable(index++, drivers.get(i).getValue()) :
  225.                             factory.constant(drivers.get(i).getValue());
  226.         }
  227.         return parameters;
  228.     }

  230. }
Created with JaCoCo 0.8.6.202009150832