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.estimation.measurements.generation;
18  
19  import java.util.Map;
20  
21  import org.hipparchus.geometry.euclidean.threed.Vector3D;
22  import org.hipparchus.random.CorrelatedRandomVectorGenerator;
23  import org.orekit.estimation.measurements.EstimationModifier;
24  import org.orekit.estimation.measurements.ObservableSatellite;
25  import org.orekit.estimation.measurements.PV;
26  import org.orekit.propagation.SpacecraftState;
27  import org.orekit.propagation.sampling.OrekitStepInterpolator;
28  import org.orekit.time.AbsoluteDate;
29  import org.orekit.utils.ParameterDriver;
30  
31  
32  /** Builder for {@link PV} measurements.
33   * @author Luc Maisonobe
34   * @since 9.3
35   */
36  public class PVBuilder extends AbstractMeasurementBuilder<PV> {
37  
38      /** Satellite related to this builder.
39       * @since 12.0
40       */
41      private final ObservableSatellite satellite;
42  
43      /** Simple constructor.
44       * @param noiseSource noise source, may be null for generating perfect measurements
45       * @param sigmaPosition theoretical standard deviation on position components
46       * @param sigmaVelocity theoretical standard deviation on velocity components
47       * @param baseWeight base weight
48       * @param satellite satellite related to this builder
49       */
50      public PVBuilder(final CorrelatedRandomVectorGenerator noiseSource,
51                       final double sigmaPosition, final double sigmaVelocity,
52                       final double baseWeight, final ObservableSatellite satellite) {
53          super(noiseSource,
54                new double[] {
55                    sigmaPosition, sigmaVelocity
56                }, new double[] {
57                    baseWeight
58                }, satellite);
59          this.satellite = satellite;
60      }
61  
62      /** {@inheritDoc} */
63      @Override
64      public PV build(final AbsoluteDate date, final Map<ObservableSatellite, OrekitStepInterpolator> interpolators) {
65  
66          final double[] sigma                = getTheoreticalStandardDeviation();
67          final double baseWeight             = getBaseWeight()[0];
68          final SpacecraftState[] relevant    = new SpacecraftState[] { interpolators.get(satellite).getInterpolatedState(date) };
69  
70          // create a dummy measurement
71          final PV dummy = new PV(relevant[0].getDate(), Vector3D.NaN, Vector3D.NaN,
72                                  sigma[0], sigma[1], baseWeight, satellite);
73          for (final EstimationModifier<PV> modifier : getModifiers()) {
74              dummy.addModifier(modifier);
75          }
76  
77          // set a reference date for parameters missing one
78          for (final ParameterDriver driver : dummy.getParametersDrivers()) {
79              if (driver.getReferenceDate() == null) {
80                  final AbsoluteDate start = getStart();
81                  final AbsoluteDate end   = getEnd();
82                  driver.setReferenceDate(start.durationFrom(end) <= 0 ? start : end);
83              }
84          }
85  
86          // estimate the perfect value of the measurement
87          final double[] pv = dummy.estimateWithoutDerivatives(relevant).getEstimatedValue();
88  
89          // add the noise
90          final double[] noise = getNoise();
91          if (noise != null) {
92              pv[0] += noise[0];
93              pv[1] += noise[1];
94              pv[2] += noise[2];
95              pv[3] += noise[3];
96              pv[4] += noise[4];
97              pv[5] += noise[5];
98          }
99  
100         // generate measurement
101         final PV measurement = new PV(relevant[0].getDate(),
102                                       new Vector3D(pv[0], pv[1], pv[2]), new Vector3D(pv[3], pv[4], pv[5]),
103                                       sigma[0], sigma[1], baseWeight, satellite);
104         for (final EstimationModifier<PV> modifier : getModifiers()) {
105             measurement.addModifier(modifier);
106         }
107         return measurement;
108 
109     }
110 
111 }