RapidDataAndPredictionColumnsLoader.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.frames;

  19. import java.io.BufferedReader;
  20. import java.io.IOException;
  21. import java.io.InputStream;
  22. import java.io.InputStreamReader;
  23. import java.nio.charset.StandardCharsets;
  24. import java.util.ArrayList;
  25. import java.util.Collection;
  26. import java.util.List;
  27. import java.util.SortedSet;
  28. import java.util.function.Supplier;
  29. import java.util.regex.Matcher;
  30. import java.util.regex.Pattern;

  32. import org.hipparchus.util.MathUtils;
  33. import org.orekit.data.DataProvidersManager;
  34. import org.orekit.errors.OrekitException;
  35. import org.orekit.errors.OrekitMessages;
  36. import org.orekit.time.AbsoluteDate;
  37. import org.orekit.time.DateComponents;
  38. import org.orekit.time.TimeScale;
  39. import org.orekit.utils.IERSConventions;
  40. import org.orekit.utils.IERSConventions.NutationCorrectionConverter;

  42. /** Loader for IERS rapid data and prediction files in columns format (finals file).
  43.  * <p>Rapid data and prediction files contain {@link EOPEntry
  44.  * Earth Orientation Parameters} for several years periods, in one file
  45.  * only that is updated regularly.</p>
  46.  * <p>
  47.  * These files contain both the data from IERS Bulletin A and IERS bulletin B.
  48.  * This class parses only the part from Bulletin A.
  49.  * </p>
  50.  * <p>The rapid data and prediction file is recognized thanks to its base name,
  51.  * which must match one of the the patterns <code>finals.*</code> or
  52.  * <code>finals2000A.*</code> (or the same ending with <code>.gz</code>
  53.  * for gzip-compressed files) where * stands for a word like "all", "daily",
  54.  * or "data". The file with 2000A in their name correspond to the
  55.  * IAU-2000 precession-nutation model whereas the files without any identifier
  56.  * correspond to the IAU-1980 precession-nutation model. The files with the all
  57.  * suffix start from 1973-01-01, the file with the data suffix start
  58.  * from 1992-01-01 and the files with the daily suffix.</p>
  59.  * <p>
  60.  * This class is immutable and hence thread-safe
  61.  * </p>
  62.  * @author Romain Di Costanzo
  63.  * @see <a href="http://maia.usno.navy.mil/ser7/readme.finals2000A">finals2000A file format description at USNO</a>
  64.  * @see <a href="http://maia.usno.navy.mil/ser7/readme.finals">finals file format description at USNO</a>
  65.  */
  66. class RapidDataAndPredictionColumnsLoader extends AbstractEopLoader
  67.         implements EOPHistoryLoader {

  69.     /** Conversion factor. */
  70.     private static final double  ARC_SECONDS_TO_RADIANS       = MathUtils.TWO_PI / 1296000;

  72.     /** Conversion factor. */
  73.     private static final double  MILLI_ARC_SECONDS_TO_RADIANS = ARC_SECONDS_TO_RADIANS / 1000;

  75.     /** Conversion factor. */
  76.     private static final double  MILLI_SECONDS_TO_SECONDS     = 1.0e-3;

  78.     /** Field for year, month and day parsing. */
  79.     private static final String  INTEGER2_FIELD               = "((?:\\p{Blank}|\\p{Digit})\\p{Digit})";

  81.     /** Field for modified Julian day parsing. */
  82.     private static final String  MJD_FIELD                    = "\\p{Blank}+(\\p{Digit}+)(?:\\.00*)";

  84.     /** Field for separator parsing. */
  85.     private static final String  SEPARATOR                    = "\\p{Blank}*[IP]";

  87.     /** Field for real parsing. */
  88.     private static final String  REAL_FIELD                   = "\\p{Blank}*(-?\\p{Digit}*\\.\\p{Digit}*)";

  90.     /** Start index of the date part of the line. */
  91.     private static int DATE_START = 0;

  93.     /** end index of the date part of the line. */
  94.     private static int DATE_END   = 15;

  96.     /** Pattern to match the date part of the line (always present). */
  97.     private static final Pattern DATE_PATTERN = Pattern.compile(INTEGER2_FIELD + INTEGER2_FIELD + INTEGER2_FIELD + MJD_FIELD);

  99.     /** Start index of the pole part of the line. */
  100.     private static int POLE_START = 16;

  102.     /** end index of the pole part of the line. */
  103.     private static int POLE_END   = 55;

  105.     /** Pattern to match the pole part of the line. */
  106.     private static final Pattern POLE_PATTERN = Pattern.compile(SEPARATOR + REAL_FIELD + REAL_FIELD + REAL_FIELD + REAL_FIELD);

  108.     /** Start index of the UT1-UTC part of the line. */
  109.     private static int UT1_UTC_START = 57;

  111.     /** end index of the UT1-UTC part of the line. */
  112.     private static int UT1_UTC_END   = 78;

  114.     /** Pattern to match the UT1-UTC part of the line. */
  115.     private static final Pattern UT1_UTC_PATTERN = Pattern.compile(SEPARATOR + REAL_FIELD + REAL_FIELD);

  117.     /** Start index of the LOD part of the line. */
  118.     private static int LOD_START = 79;

  120.     /** end index of the LOD part of the line. */
  121.     private static int LOD_END   = 93;

  123.     /** Pattern to match the LOD part of the line. */
  124.     private static final Pattern LOD_PATTERN = Pattern.compile(REAL_FIELD + REAL_FIELD);

  126.     /** Start index of the nutation part of the line. */
  127.     private static int NUTATION_START = 95;

  129.     /** end index of the nutation part of the line. */
  130.     private static int NUTATION_END   = 134;

  132.     /** Pattern to match the nutation part of the line. */
  133.     private static final Pattern NUTATION_PATTERN = Pattern.compile(SEPARATOR + REAL_FIELD + REAL_FIELD + REAL_FIELD + REAL_FIELD);

  135.     /** Type of nutation corrections. */
  136.     private final boolean isNonRotatingOrigin;

  138.     /** Build a loader for IERS bulletins B files.
  139.      * @param isNonRotatingOrigin if true the supported files <em>must</em>
  140.      * contain δX/δY nutation corrections, otherwise they
  141.      * <em>must</em> contain δΔψ/δΔε nutation
  142.      * corrections
  143.      * @param supportedNames regular expression for supported files names
  144.      * @param manager provides access to EOP data files.
  145.      * @param utcSupplier UTC time scale.
  146.      */
  147.     RapidDataAndPredictionColumnsLoader(final boolean isNonRotatingOrigin,
  148.                                         final String supportedNames,
  149.                                         final DataProvidersManager manager,
  150.                                         final Supplier<TimeScale> utcSupplier) {
  151.         super(supportedNames, manager, utcSupplier);
  152.         this.isNonRotatingOrigin = isNonRotatingOrigin;
  153.     }

  155.     /** {@inheritDoc} */
  156.     public void fillHistory(final IERSConventions.NutationCorrectionConverter converter,
  157.                             final SortedSet<EOPEntry> history) {
  158.         final ItrfVersionProvider itrfVersionProvider = new ITRFVersionLoader(
  159.                 ITRFVersionLoader.SUPPORTED_NAMES,
  160.                 getDataProvidersManager());
  161.         final Parser parser =
  162.                 new Parser(converter, itrfVersionProvider, getUtc(), isNonRotatingOrigin);
  163.         final EopParserLoader loader = new EopParserLoader(parser);
  164.         this.feed(loader);
  165.         history.addAll(loader.getEop());
  166.     }

  168.     /** Internal class performing the parsing. */
  169.     static class Parser extends AbstractEopParser {

  171.         /** Indicator for Non-Rotating Origin. */
  172.         private final boolean isNonRotatingOrigin;

  174.         /** Simple constructor.
  175.          * @param converter converter to use
  176.          * @param itrfVersionProvider to use for determining the ITRF version of the EOP.
  177.          * @param utc time scale for parsing dates.
  178.          * @param isNonRotatingOrigin type of nutation correction
  179.          */
  180.         Parser(final NutationCorrectionConverter converter,
  181.                final ItrfVersionProvider itrfVersionProvider,
  182.                final TimeScale utc,
  183.                final boolean isNonRotatingOrigin) {
  184.             super(converter, itrfVersionProvider, utc);
  185.             this.isNonRotatingOrigin = isNonRotatingOrigin;
  186.         }

  188.         /** {@inheritDoc} */
  189.         @Override
  190.         public Collection<EOPEntry> parse(final InputStream input, final String name)
  191.             throws IOException {

  193.             final List<EOPEntry> history = new ArrayList<>();
  194.             ITRFVersionLoader.ITRFVersionConfiguration configuration = null;

  196.             // reset parse info to start new file (do not clear history!)
  197.             int lineNumber = 0;

  199.             // set up a reader for line-oriented bulletin B files
  200.             try (BufferedReader reader = new BufferedReader(new InputStreamReader(input, StandardCharsets.UTF_8))) {

  202.                 for (String line = reader.readLine(); line != null; line = reader.readLine()) {

  204.                     lineNumber++;

  206.                     // split the lines in its various columns (some of them can be blank)
  207.                     final String datePart      = (line.length() >= DATE_END)     ? line.substring(DATE_START,       DATE_END)     : "";
  208.                     final String polePart      = (line.length() >= POLE_END)     ? line.substring(POLE_START,       POLE_END)     : "";
  209.                     final String ut1utcPart    = (line.length() >= UT1_UTC_END ) ? line.substring(UT1_UTC_START,    UT1_UTC_END)  : "";
  210.                     final String lodPart       = (line.length() >= LOD_END)      ? line.substring(LOD_START,        LOD_END)      : "";
  211.                     final String nutationPart  = (line.length() >= NUTATION_END) ? line.substring(NUTATION_START,   NUTATION_END) : "";

  213.                     // parse the date part
  214.                     final Matcher dateMatcher = DATE_PATTERN.matcher(datePart);
  215.                     final int mjd;
  216.                     if (dateMatcher.matches()) {
  217.                         final int yy = Integer.parseInt(dateMatcher.group(1).trim());
  218.                         final int mm = Integer.parseInt(dateMatcher.group(2).trim());
  219.                         final int dd = Integer.parseInt(dateMatcher.group(3).trim());
  220.                         mjd = Integer.parseInt(dateMatcher.group(4).trim());
  221.                         final DateComponents reconstructedDate = new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd);
  222.                         if ((reconstructedDate.getYear() % 100) != yy ||
  223.                              reconstructedDate.getMonth()       != mm ||
  224.                              reconstructedDate.getDay()         != dd) {
  225.                             throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
  226.                                                       lineNumber, name, line);
  227.                         }
  228.                     } else {
  229.                         throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
  230.                                                   lineNumber, name, line);
  231.                     }

  233.                     // parse the pole part
  234.                     final double x;
  235.                     final double y;
  236.                     if (polePart.trim().length() == 0) {
  237.                         // pole part is blank
  238.                         x = 0;
  239.                         y = 0;
  240.                     } else {
  241.                         final Matcher poleMatcher = POLE_PATTERN.matcher(polePart);
  242.                         if (poleMatcher.matches()) {
  243.                             x = ARC_SECONDS_TO_RADIANS * Double.parseDouble(poleMatcher.group(1));
  244.                             y = ARC_SECONDS_TO_RADIANS * Double.parseDouble(poleMatcher.group(3));
  245.                         } else {
  246.                             throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
  247.                                                       lineNumber, name, line);
  248.                         }
  249.                     }

  251.                     // parse the UT1-UTC part
  252.                     final double dtu1;
  253.                     if (ut1utcPart.trim().length() == 0) {
  254.                         // UT1-UTC part is blank
  255.                         dtu1 = 0;
  256.                     } else {
  257.                         final Matcher ut1utcMatcher = UT1_UTC_PATTERN.matcher(ut1utcPart);
  258.                         if (ut1utcMatcher.matches()) {
  259.                             dtu1 = Double.parseDouble(ut1utcMatcher.group(1));
  260.                         } else {
  261.                             throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
  262.                                                       lineNumber, name, line);
  263.                         }
  264.                     }

  266.                     // parse the lod part
  267.                     final double lod;
  268.                     if (lodPart.trim().length() == 0) {
  269.                         // lod part is blank
  270.                         lod = 0;
  271.                     } else {
  272.                         final Matcher lodMatcher = LOD_PATTERN.matcher(lodPart);
  273.                         if (lodMatcher.matches()) {
  274.                             lod = MILLI_SECONDS_TO_SECONDS * Double.parseDouble(lodMatcher.group(1));
  275.                         } else {
  276.                             throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
  277.                                                       lineNumber, name, line);
  278.                         }
  279.                     }

  281.                     // parse the nutation part
  282.                     final double[] nro;
  283.                     final double[] equinox;
  284.                     final AbsoluteDate mjdDate =
  285.                             new AbsoluteDate(new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd),
  286.                                     getUtc());
  287.                     if (nutationPart.trim().length() == 0) {
  288.                         // nutation part is blank
  289.                         nro     = new double[2];
  290.                         equinox = new double[2];
  291.                     } else {
  292.                         final Matcher nutationMatcher = NUTATION_PATTERN.matcher(nutationPart);
  293.                         if (nutationMatcher.matches()) {
  294.                             if (isNonRotatingOrigin) {
  295.                                 nro = new double[] {
  296.                                     MILLI_ARC_SECONDS_TO_RADIANS * Double.parseDouble(nutationMatcher.group(1)),
  297.                                     MILLI_ARC_SECONDS_TO_RADIANS * Double.parseDouble(nutationMatcher.group(3))
  298.                                 };
  299.                                 equinox = getConverter().toEquinox(mjdDate, nro[0], nro[1]);
  300.                             } else {
  301.                                 equinox = new double[] {
  302.                                     MILLI_ARC_SECONDS_TO_RADIANS * Double.parseDouble(nutationMatcher.group(1)),
  303.                                     MILLI_ARC_SECONDS_TO_RADIANS * Double.parseDouble(nutationMatcher.group(3))
  304.                                 };
  305.                                 nro = getConverter().toNonRotating(mjdDate, equinox[0], equinox[1]);
  306.                             }
  307.                         } else {
  308.                             throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
  309.                                                       lineNumber, name, line);
  310.                         }
  311.                     }

  313.                     if (configuration == null || !configuration.isValid(mjd)) {
  314.                         // get a configuration for current name and date range
  315.                         configuration = getItrfVersionProvider().getConfiguration(name, mjd);
  316.                     }
  317.                     history.add(new EOPEntry(mjd, dtu1, lod, x, y, equinox[0], equinox[1], nro[0], nro[1],
  318.                                              configuration.getVersion(), mjdDate));

  320.                 }

  322.             }

  324.             return history;
  325.         }

  327.     }

  329. }
Created with JaCoCo 0.8.6.202009150832