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