RapidDataAndPredictionColumnsLoader.java
/* Copyright 2002-2023 CS GROUP
* Licensed to CS GROUP (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.orekit.frames;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.SortedSet;
import java.util.function.Supplier;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.orekit.data.DataProvidersManager;
import org.orekit.errors.OrekitException;
import org.orekit.errors.OrekitMessages;
import org.orekit.time.AbsoluteDate;
import org.orekit.time.DateComponents;
import org.orekit.time.TimeScale;
import org.orekit.utils.IERSConventions;
import org.orekit.utils.IERSConventions.NutationCorrectionConverter;
import org.orekit.utils.units.UnitsConverter;
/** Loader for IERS rapid data and prediction files in columns format (finals file).
* <p>Rapid data and prediction files contain {@link EOPEntry
* Earth Orientation Parameters} for several years periods, in one file
* only that is updated regularly.</p>
* <p>
* These files contain both the data from IERS Bulletin A and IERS bulletin B.
* This class parses only the part from Bulletin A.
* </p>
* <p>The rapid data and prediction file is recognized thanks to its base name,
* which must match one of the the patterns <code>finals.*</code> or
* <code>finals2000A.*</code> (or the same ending with <code>.gz</code>
* for gzip-compressed files) where * stands for a word like "all", "daily",
* or "data". The file with 2000A in their name correspond to the
* IAU-2000 precession-nutation model whereas the files without any identifier
* correspond to the IAU-1980 precession-nutation model. The files with the all
* suffix start from 1973-01-01, the file with the data suffix start
* from 1992-01-01 and the files with the daily suffix.</p>
* <p>
* This class is immutable and hence thread-safe
* </p>
* @author Romain Di Costanzo
* @see <a href="http://maia.usno.navy.mil/ser7/readme.finals2000A">finals2000A file format description at USNO</a>
* @see <a href="http://maia.usno.navy.mil/ser7/readme.finals">finals file format description at USNO</a>
*/
class RapidDataAndPredictionColumnsLoader extends AbstractEopLoader
implements EopHistoryLoader {
/** Field for year, month and day parsing. */
private static final String INTEGER2_FIELD = "((?:\\p{Blank}|\\p{Digit})\\p{Digit})";
/** Field for modified Julian day parsing. */
private static final String MJD_FIELD = "\\p{Blank}+(\\p{Digit}+)(?:\\.00*)";
/** Field for separator parsing. */
private static final String SEPARATOR = "\\p{Blank}*[IP]";
/** Field for real parsing. */
private static final String REAL_FIELD = "\\p{Blank}*(-?\\p{Digit}*\\.\\p{Digit}*)";
/** Start index of the date part of the line. */
private static int DATE_START = 0;
/** end index of the date part of the line. */
private static int DATE_END = 15;
/** Pattern to match the date part of the line (always present). */
private static final Pattern DATE_PATTERN = Pattern.compile(INTEGER2_FIELD + INTEGER2_FIELD + INTEGER2_FIELD + MJD_FIELD);
/** Start index of the pole part of the line (from bulletin A). */
private static int POLE_START_A = 16;
/** end index of the pole part of the line (from bulletin A). */
private static int POLE_END_A = 55;
/** Pattern to match the pole part of the line (from bulletin A). */
private static final Pattern POLE_PATTERN_A = Pattern.compile(SEPARATOR + REAL_FIELD + REAL_FIELD + REAL_FIELD + REAL_FIELD);
/** Start index of the pole part of the line (from bulletin B). */
private static int POLE_START_B = 134;
/** end index of the pole part of the line (from bulletin B). */
private static int POLE_END_B = 154;
/** Pattern to match the pole part of the line (from bulletin B). */
private static final Pattern POLE_PATTERN_B = Pattern.compile(REAL_FIELD + REAL_FIELD);
/** Start index of the UT1-UTC part of the line (from bulletin A). */
private static int UT1_UTC_START_A = 57;
/** end index of the UT1-UTC part of the line (from bulletin A). */
private static int UT1_UTC_END_A = 78;
/** Pattern to match the UT1-UTC part of the line (from bulletin A). */
private static final Pattern UT1_UTC_PATTERN_A = Pattern.compile(SEPARATOR + REAL_FIELD + REAL_FIELD);
/** Start index of the UT1-UTC part of the line (from bulletin B). */
private static int UT1_UTC_START_B = 154;
/** end index of the UT1-UTC part of the line (from bulletin B). */
private static int UT1_UTC_END_B = 165;
/** Pattern to match the UT1-UTC part of the line (from bulletin B). */
private static final Pattern UT1_UTC_PATTERN_B = Pattern.compile(REAL_FIELD);
/** Start index of the LOD part of the line (from bulletin A). */
private static int LOD_START_A = 79;
/** end index of the LOD part of the line (from bulletin A). */
private static int LOD_END_A = 93;
/** Pattern to match the LOD part of the line (from bulletin A). */
private static final Pattern LOD_PATTERN_A = Pattern.compile(REAL_FIELD + REAL_FIELD);
// there are no LOD part from bulletin B
/** Start index of the nutation part of the line (from bulletin A). */
private static int NUTATION_START_A = 95;
/** end index of the nutation part of the line (from bulletin A). */
private static int NUTATION_END_A = 134;
/** Pattern to match the nutation part of the line (from bulletin A). */
private static final Pattern NUTATION_PATTERN_A = Pattern.compile(SEPARATOR + REAL_FIELD + REAL_FIELD + REAL_FIELD + REAL_FIELD);
/** Start index of the nutation part of the line (from bulletin B). */
private static int NUTATION_START_B = 165;
/** end index of the nutation part of the line (from bulletin B). */
private static int NUTATION_END_B = 185;
/** Pattern to match the nutation part of the line (from bulletin B). */
private static final Pattern NUTATION_PATTERN_B = Pattern.compile(REAL_FIELD + REAL_FIELD);
/** Type of nutation corrections. */
private final boolean isNonRotatingOrigin;
/** Build a loader for IERS bulletins B files.
* @param isNonRotatingOrigin if true the supported files <em>must</em>
* contain δX/δY nutation corrections, otherwise they
* <em>must</em> contain δΔψ/δΔε nutation
* corrections
* @param supportedNames regular expression for supported files names
* @param manager provides access to EOP data files.
* @param utcSupplier UTC time scale.
*/
RapidDataAndPredictionColumnsLoader(final boolean isNonRotatingOrigin,
final String supportedNames,
final DataProvidersManager manager,
final Supplier<TimeScale> utcSupplier) {
super(supportedNames, manager, utcSupplier);
this.isNonRotatingOrigin = isNonRotatingOrigin;
}
/** {@inheritDoc} */
public void fillHistory(final IERSConventions.NutationCorrectionConverter converter,
final SortedSet<EOPEntry> history) {
final ItrfVersionProvider itrfVersionProvider = new ITRFVersionLoader(
ITRFVersionLoader.SUPPORTED_NAMES,
getDataProvidersManager());
final Parser parser =
new Parser(converter, itrfVersionProvider, getUtc(), isNonRotatingOrigin);
final EopParserLoader loader = new EopParserLoader(parser);
this.feed(loader);
history.addAll(loader.getEop());
}
/** Internal class performing the parsing. */
static class Parser extends AbstractEopParser {
/** Indicator for Non-Rotating Origin. */
private final boolean isNonRotatingOrigin;
/** Simple constructor.
* @param converter converter to use
* @param itrfVersionProvider to use for determining the ITRF version of the EOP.
* @param utc time scale for parsing dates.
* @param isNonRotatingOrigin type of nutation correction
*/
Parser(final NutationCorrectionConverter converter,
final ItrfVersionProvider itrfVersionProvider,
final TimeScale utc,
final boolean isNonRotatingOrigin) {
super(converter, itrfVersionProvider, utc);
this.isNonRotatingOrigin = isNonRotatingOrigin;
}
/** {@inheritDoc} */
@Override
public Collection<EOPEntry> parse(final InputStream input, final String name)
throws IOException {
final List<EOPEntry> history = new ArrayList<>();
ITRFVersionLoader.ITRFVersionConfiguration configuration = null;
// reset parse info to start new file (do not clear history!)
int lineNumber = 0;
// set up a reader for line-oriented bulletin B files
try (BufferedReader reader = new BufferedReader(new InputStreamReader(input, StandardCharsets.UTF_8))) {
for (String line = reader.readLine(); line != null; line = reader.readLine()) {
lineNumber++;
// split the lines in its various columns (some of them can be blank)
final String datePart = getPart(line, DATE_START, DATE_END);
final String polePartA = getPart(line, POLE_START_A, POLE_END_A);
final String ut1utcPartA = getPart(line, UT1_UTC_START_A, UT1_UTC_END_A);
final String lodPartA = getPart(line, LOD_START_A, LOD_END_A);
final String nutationPartA = getPart(line, NUTATION_START_A, NUTATION_END_A);
final String polePartB = getPart(line, POLE_START_B, POLE_END_B);
final String ut1utcPartB = getPart(line, UT1_UTC_START_B, UT1_UTC_END_B);
final String nutationPartB = getPart(line, NUTATION_START_B, NUTATION_END_B);
// parse the date part
final Matcher dateMatcher = DATE_PATTERN.matcher(datePart);
final int mjd;
if (dateMatcher.matches()) {
final int yy = Integer.parseInt(dateMatcher.group(1).trim());
final int mm = Integer.parseInt(dateMatcher.group(2).trim());
final int dd = Integer.parseInt(dateMatcher.group(3).trim());
mjd = Integer.parseInt(dateMatcher.group(4).trim());
final DateComponents reconstructedDate = new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd);
if ((reconstructedDate.getYear() % 100) != yy ||
reconstructedDate.getMonth() != mm ||
reconstructedDate.getDay() != dd) {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
// parse the pole part
final double x;
final double y;
if (polePartB.trim().length() == 0) {
// pole part from bulletin B is blank
if (polePartA.trim().length() == 0) {
// pole part from bulletin A is blank
x = 0;
y = 0;
} else {
final Matcher poleAMatcher = POLE_PATTERN_A.matcher(polePartA);
if (poleAMatcher.matches()) {
x = UnitsConverter.ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(poleAMatcher.group(1)));
y = UnitsConverter.ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(poleAMatcher.group(3)));
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
}
} else {
final Matcher poleBMatcher = POLE_PATTERN_B.matcher(polePartB);
if (poleBMatcher.matches()) {
x = UnitsConverter.ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(poleBMatcher.group(1)));
y = UnitsConverter.ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(poleBMatcher.group(2)));
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
}
// parse the UT1-UTC part
final double dtu1;
if (ut1utcPartB.trim().length() == 0) {
// UT1-UTC part from bulletin B is blank
if (ut1utcPartA.trim().length() == 0) {
// UT1-UTC part from bulletin A is blank
dtu1 = 0;
} else {
final Matcher ut1utcAMatcher = UT1_UTC_PATTERN_A.matcher(ut1utcPartA);
if (ut1utcAMatcher.matches()) {
dtu1 = Double.parseDouble(ut1utcAMatcher.group(1));
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
}
} else {
final Matcher ut1utcBMatcher = UT1_UTC_PATTERN_B.matcher(ut1utcPartB);
if (ut1utcBMatcher.matches()) {
dtu1 = Double.parseDouble(ut1utcBMatcher.group(1));
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
}
// parse the lod part
final double lod;
if (lodPartA.trim().length() == 0) {
// lod part from bulletin A is blank
lod = Double.NaN;
} else {
final Matcher lodAMatcher = LOD_PATTERN_A.matcher(lodPartA);
if (lodAMatcher.matches()) {
lod = UnitsConverter.MILLI_SECONDS_TO_SECONDS.convert(Double.parseDouble(lodAMatcher.group(1)));
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
}
// parse the nutation part
final double[] nro;
final double[] equinox;
final AbsoluteDate mjdDate =
new AbsoluteDate(new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd),
getUtc());
if (nutationPartB.trim().length() == 0) {
// nutation part from bulletin B is blank
if (nutationPartA.trim().length() == 0) {
// nutation part from bulletin A is blank
nro = new double[2];
equinox = new double[2];
} else {
final Matcher nutationAMatcher = NUTATION_PATTERN_A.matcher(nutationPartA);
if (nutationAMatcher.matches()) {
if (isNonRotatingOrigin) {
nro = new double[] {
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationAMatcher.group(1))),
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationAMatcher.group(3)))
};
equinox = getConverter().toEquinox(mjdDate, nro[0], nro[1]);
} else {
equinox = new double[] {
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationAMatcher.group(1))),
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationAMatcher.group(3)))
};
nro = getConverter().toNonRotating(mjdDate, equinox[0], equinox[1]);
}
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
}
} else {
final Matcher nutationBMatcher = NUTATION_PATTERN_B.matcher(nutationPartB);
if (nutationBMatcher.matches()) {
if (isNonRotatingOrigin) {
nro = new double[] {
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationBMatcher.group(1))),
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationBMatcher.group(2)))
};
equinox = getConverter().toEquinox(mjdDate, nro[0], nro[1]);
} else {
equinox = new double[] {
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationBMatcher.group(1))),
UnitsConverter.MILLI_ARC_SECONDS_TO_RADIANS.convert(Double.parseDouble(nutationBMatcher.group(2)))
};
nro = getConverter().toNonRotating(mjdDate, equinox[0], equinox[1]);
}
} else {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, name, line);
}
}
if (configuration == null || !configuration.isValid(mjd)) {
// get a configuration for current name and date range
configuration = getItrfVersionProvider().getConfiguration(name, mjd);
}
history.add(new EOPEntry(mjd, dtu1, lod, x, y, Double.NaN, Double.NaN,
equinox[0], equinox[1], nro[0], nro[1],
configuration.getVersion(), mjdDate));
}
}
return history;
}
}
/** Get a part of a line.
* @param line line to analyze
* @param start start index of the part
* @param end end index of the part
* @return either the line part if present or an empty string if line is too short
* @since 11.1
*/
private static String getPart(final String line, final int start, final int end) {
return (line.length() >= end) ? line.substring(start, end) : "";
}
}