1   /* Copyright 2022-2025 Luc Maisonobe
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.frames;
18  
19  import org.orekit.utils.SecularAndHarmonic;
20  
21  /** Container for fitted model for Earth Orientation Parameters.
22   * @see PredictedEOPHistory
23   * @see EOPFitter
24   * @since 12.0
25   * @author Luc Maisonobe
26   */
27  public class EOPFittedModel {
28  
29      /** Fitted model for dut1 and LOD. */
30      private final SecularAndHarmonic dut1;
31  
32      /** Fitted model for pole x component. */
33      private final SecularAndHarmonic xP;
34  
35      /** Fitted model for pole y component. */
36      private final SecularAndHarmonic yP;
37  
38      /** Fitted model for nutation x component. */
39      private final SecularAndHarmonic dx;
40  
41      /** Fitted model for nutation y component. */
42      private final SecularAndHarmonic dy;
43  
44      /** Simple constructor.
45       * @param dut1 fitted model for dut1 and LOD
46       * @param xP fitted model for pole x component
47       * @param yP fitted model for pole y component
48       * @param dx fitted model for nutation x component
49       * @param dy fitted model for nutation y component
50       */
51      public EOPFittedModel(final SecularAndHarmonic dut1,
52                       final SecularAndHarmonic xP, final SecularAndHarmonic yP,
53                       final SecularAndHarmonic dx, final SecularAndHarmonic dy) {
54          this.dut1 = dut1;
55          this.xP   = xP;
56          this.yP   = yP;
57          this.dx   = dx;
58          this.dy   = dy;
59      }
60  
61      /** Get the fitted secular and harmonics model for DUT1/LOD.
62       * <p>
63       * LOD can be computed from DUT1 as {@code -Constants.JULIAN_DAY * getDUT1().osculatingDerivative(date)}
64       * </p>
65       * @return fitted secular and harmonics model for DUT1/LOD
66       */
67      public SecularAndHarmonic getDUT1() {
68          return dut1;
69      }
70  
71      /** Get the fitted secular and harmonics model for pole x component.
72       * @return fitted secular and harmonics model for pole x component
73       */
74      public SecularAndHarmonic getXp() {
75          return xP;
76      }
77  
78      /** Get the fitted secular and harmonics model for pole y component.
79       * @return fitted secular and harmonics model for pole y component
80       */
81      public SecularAndHarmonic getYp() {
82          return yP;
83      }
84  
85      /** Get the fitted secular and harmonics model for nutation x component.
86       * @return fitted secular and harmonics model for nutation x component
87       */
88      public SecularAndHarmonic getDx() {
89          return dx;
90      }
91  
92      /** Get the fitted secular and harmonics model for nutation y component.
93       * @return fitted secular and harmonics model for nutation y component
94       */
95      public SecularAndHarmonic getDy() {
96          return dy;
97      }
98  
99  }