IntegratedPropagatorBuilder.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.propagation.conversion;

  18. import java.util.List;

  19. import org.orekit.estimation.leastsquares.BatchLSODModel;
  20. import org.orekit.estimation.leastsquares.ModelObserver;
  21. import org.orekit.estimation.measurements.ObservedMeasurement;
  22. import org.orekit.estimation.sequential.CovarianceMatrixProvider;
  23. import org.orekit.estimation.sequential.KalmanODModel;
  24. import org.orekit.orbits.Orbit;
  25. import org.orekit.utils.ParameterDriversList;

  26. /** Base class for orbit determination model builders.
  27.  * @author Bryan Cazabonne
  28.  * @since 10.0
  29.  */
  30. public interface IntegratedPropagatorBuilder extends PropagatorBuilder {

  31.     /** Build a new {@link BatchLSODModel}.
  32.      * @param builders builders to use for propagation
  33.      * @param measurements measurements
  34.      * @param estimatedMeasurementsParameters estimated measurements parameters
  35.      * @param observer observer to be notified at model calls
  36.      * @return a new model for the Batch Least Squares orbit determination
  37.      */
  38.     BatchLSODModel buildLSModel(IntegratedPropagatorBuilder[] builders,
  39.                        List<ObservedMeasurement<?>> measurements,
  40.                        ParameterDriversList estimatedMeasurementsParameters,
  41.                        ModelObserver observer);

  42.     /** Build a new {@link KalmanODModel}.
  43.      * @param propagatorBuilders propagators builders used to evaluate the orbits.
  44.      * @param covarianceMatricesProviders providers for covariance matrices
  45.      * @param estimatedMeasurementsParameters measurement parameters to estimate
  46.      * @return a new model for Kalman Filter orbit determination
  47.      * @deprecated since 10.3, replaced by {@link #buildKalmanModel(List, List, ParameterDriversList, CovarianceMatrixProvider)}
  48.      */
  49.     @Deprecated
  50.     KalmanODModel buildKalmanModel(List<IntegratedPropagatorBuilder> propagatorBuilders,
  51.                                    List<CovarianceMatrixProvider> covarianceMatricesProviders,
  52.                                    ParameterDriversList estimatedMeasurementsParameters);

  53.     /** Build a new {@link KalmanODModel}.
  54.      * <p>
  55.      * The default implementation will be removed in 11.0. It calls {@link
  56.      * #buildKalmanModel(List, List, ParameterDriversList)}.
  57.      * </p>
  58.      * @param propagatorBuilders propagators builders used to evaluate the orbits.
  59.      * @param covarianceMatricesProviders providers for covariance matrices
  60.      * @param estimatedMeasurementsParameters measurement parameters to estimate
  61.      * @param measurementProcessNoiseMatrix provider for measurement process noise matrix
  62.      * @return a new model for Kalman Filter orbit determination
  63.      */
  64.     default KalmanODModel buildKalmanModel(final List<IntegratedPropagatorBuilder> propagatorBuilders,
  65.                                            final List<CovarianceMatrixProvider> covarianceMatricesProviders,
  66.                                            final ParameterDriversList estimatedMeasurementsParameters,
  67.                                            final CovarianceMatrixProvider measurementProcessNoiseMatrix) {
  68.         return buildKalmanModel(propagatorBuilders, covarianceMatricesProviders, estimatedMeasurementsParameters);
  69.     }

  70.     /** Reset the orbit in the propagator builder.
  71.      * @param newOrbit New orbit to set in the propagator builder
  72.      */
  73.     void resetOrbit(Orbit newOrbit);

  74. }