ootk 1.0.8 → 1.2.0

package/lib/tle.d.ts

@@ -0,0 +1,378 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The TLE module contains a collection of functions for working with TLEs.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { Line1Data, Line2Data, TleLine1, TleLine2 } from './types';
+declare type TleData = {
+    satNum: number;
+    intlDes: string;
+    epochYear: number;
+    epochDay: number;
+    meanMoDev1: number;
+    meanMoDev2: number;
+    bstar: number;
+    inclination: number;
+    raan: number;
+    eccentricity: number;
+    argOfPerigee: number;
+    meanAnomaly: number;
+    meanMotion: number;
+};
+declare type TleDataFull = Line1Data & Line2Data;
+export declare class Tle {
+    private static lineNumber;
+    private static satNum;
+    private static classification;
+    private static intlDes;
+    private static intlDesYear;
+    private static intlDesLaunchNum;
+    private static intlDesLaunchPiece;
+    private static epochYear;
+    private static epochDay;
+    private static meanMoDev1;
+    private static meanMoDev2;
+    private static bstar;
+    private static ephemerisType;
+    private static elsetNum;
+    private static checksum;
+    private static inclination;
+    private static raan;
+    private static eccentricity;
+    private static argPerigee;
+    private static meanAnom;
+    private static meanMo;
+    private static revNum;
+    /**
+     * Parses the TLE into orbital data.
+     *
+     * If you want all of the data then use parseTleFull instead.
+     * @param {TleLine1} tleLine1 TLE line 1
+     * @param {TleLine2} tleLine2 TLE line 2
+     * @returns {TleData} Returns most commonly used orbital data from TLE
+     */
+    static parseTle(tleLine1: TleLine1, tleLine2: TleLine2): TleData;
+    /**
+     * Parses all of the data contained in the TLE.
+     *
+     * If you only want the most commonly used data then use parseTle instead.
+     * @param {TleLine1} tleLine1 The first line of the TLE to parse.
+     * @param {TleLine2} tleLine2 The second line of the TLE to parse.
+     * @returns {TleDataFull} Returns all of the data from the TLE.
+     */
+    static parseTleFull(tleLine1: TleLine1, tleLine2: TleLine2): TleDataFull;
+    /**
+     * Parse the first line of the TLE.
+     * @param {TleLine1} tleLine1 The first line of the TLE to parse.
+     * @returns {Line1Data} Returns the data from the first line of the TLE.
+     */
+    static parseLine1(tleLine1: TleLine1): Line1Data;
+    /**
+     * Parse the second line of the TLE.
+     * @param {TleLine2} tleLine2 The second line of the TLE to parse.
+     * @returns {Line2Data} Returns the data from the second line of the TLE.
+     */
+    static parseLine2(tleLine2: TleLine2): Line2Data;
+    /**
+     * This should always return a 1 or a 2.
+     * @param {string} tleLine The first line of the TLE to parse.
+     * @returns {number} The line number of the TLE.
+     */
+    static getLineNumber(tleLine: TleLine1 | TleLine2): 1 | 2;
+    /**
+     * See https://en.wikipedia.org/wiki/Satellite_Catalog_Number
+     *
+     * Range: 0 to 99999 or 26999.
+     *
+     * NOTE: To support Alpha-5, the first digit can be a letter.
+     * This will be converted to a number in order to expand the range to 26999.
+     *
+     * Example: 25544 or B1234 (e.g. Sputnik's rocket body was number 00001)
+     *
+     * @param {string} tleLine The first line of the TLE to parse.
+     * @returns {number} NORAD catalog number.
+     */
+    static getSatNum(tleLine: TleLine1 | TleLine2): number;
+    /**
+     * See https://en.wikipedia.org/wiki/Satellite_Catalog_Number
+     *
+     * Range: 0 to 99999 or 26999.
+     *
+     * NOTE: To support Alpha-5, the first digit can be a letter.
+     * This will NOT be converted to a number. Use getSatNum() for that.
+     *
+     * Example: 25544 or B1234 (e.g. Sputnik's rocket body was number 00001)
+     *
+     * @param {string} tleLine The first line of the TLE to parse.
+     * @returns {string} NORAD catalog number.
+     */
+    static getRawSatNum(tleLine: TleLine1 | TleLine2): string;
+    /**
+     * Satellite classification.
+     * * 'U' = unclassified
+     * * 'C' = confidential
+     * * 'S' = secret
+     *
+     * Example: 'U'
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {string} The classification.
+     */
+    static getClassification(tleLine1: TleLine1): string;
+    /**
+     * International Designator (COSPAR ID)
+     * See https://en.wikipedia.org/wiki/International_Designator
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {string} The International Designator.
+     */
+    static getIntlDes(tleLine1: TleLine1): string;
+    /**
+     * International Designator (COSPAR ID): Last 2 digits of launch year.
+     *
+     * Range: 00 to 99
+     *
+     * Example: 98
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The year of the International Designator.
+     */
+    static getIntlDesYear(tleLine1: TleLine1): number;
+    /**
+     * International Designator (COSPAR ID): Launch number of the year.
+     *
+     * Range: 1 to 999
+     *
+     * Example: 67
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The launch number of the International Designator.
+     */
+    static getIntlDesLaunchNum(tleLine1: string): number;
+    /**
+     * International Designator  (COSPAR ID): Piece of the launch.
+     *
+     * Range: A to ZZZ
+     *
+     * Example: 'A'
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {string} The launch piece of the International Designator.
+     */
+    static getIntlDesLaunchPiece(tleLine1: TleLine1): string;
+    /**
+     * Year when the TLE was generated (TLE epoch), last two digits.
+     *
+     * Range: 00 to 99
+     *
+     * Example: 17
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The year the TLE was generated.
+     */
+    static getEpochYear(tleLine1: TleLine1): number;
+    /**
+     * Year when the TLE was generated (TLE epoch), four digits.
+     *
+     * Range: 1957 to 2056
+     *
+     * Example: 2008
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The year the TLE was generated.
+     */
+    static getEpochYearFull(tleLine1: TleLine1): number;
+    /**
+     * Fractional day of the year when the TLE was generated (TLE epoch).
+     *
+     * Range: 1 to 365.99999999
+     *
+     * Example: 206.18396726
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The day of the year the TLE was generated.
+     */
+    static getEpochDay(tleLine1: string): number;
+    /**
+     * First Time Derivative of the Mean Motion divided by two.  Defines how mean motion changes
+     * over time, so TLE propagators can still be used to make reasonable guesses when
+     * times are distant from the original TLE epoch.
+     *
+     * Units: Orbits / day ^ 2
+     *
+     * Example: 0.00001961
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The first derivative of the mean motion.
+     */
+    static getMeanMoDev1(tleLine1: TleLine1): number;
+    /**
+     * Second Time Derivative of Mean Motion divided by six (decimal point assumed). Measures rate
+     * of change in the Mean Motion Dot so software can make reasonable guesses when times are
+     * distant from the original TLE epoch.
+     *
+     * Usually zero, unless the satellite is manuevering or in a decaying orbit.
+     *
+     * Units: Orbits / day ^ 3.
+     *
+     * Example: 0 ('00000-0' in the original TLE [= 0.00000 * 10 ^ 0])
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The second derivative of the mean motion.
+     */
+    static getMeanMoDev2(tleLine1: string): number;
+    /**
+     * BSTAR drag term (decimal point assumed).  Estimates the effects of
+     * atmospheric drag on the satellite's motion.
+     *
+     * Units: EarthRadii ^ -1
+     *
+     * Example: 0.000036771 ('36771-4' in the original TLE [= 0.36771 * 10 ^ -4])
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The drag coefficient.
+     */
+    static getBstar(tleLine1: TleLine1): number;
+    /**
+     * Private value - used by United States Space Force to reference the orbit model used to
+     * generate the TLE.  Will always be seen as zero externally (e.g. by "us", unless you are
+     * "them" - in which case, hello!).
+     *
+     * Example: 0
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The ephemeris type.
+     */
+    static getEphemerisType(tleLine1: TleLine1): number;
+    /**
+     * TLE element set number, incremented for each new TLE generated. 999 seems to mean the TLE
+     * has maxed out.
+     *
+     * Range: Technically 1 to 9999, though in practice the maximum number seems to be 999.
+     *
+     * Example: 999
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The element number.
+     */
+    static getElsetNum(tleLine1: TleLine1): number;
+    /**
+     * TLE line 1 checksum (modulo 10), for verifying the integrity of this line of the TLE.
+     *
+     * Range: 0 to 9
+     * Example: 3
+     *
+     * @param {string} tleLine1 The first line of the TLE to parse.
+     * @returns {number} The checksum value.
+     */
+    static getChecksum(tleLine1: TleLine1): number;
+    /**
+     * Inclination relative to the Earth's equatorial plane in degrees. 0 to 90 degrees is a
+     * prograde orbit and 90 to 180 degrees is a retrograde orbit.
+     *
+     * Units: degrees
+     *
+     * Range: 0 to 180
+     *
+     * Example: 51.6400
+     *
+     * @param {string} tleLine2 The second line of the TLE to parse.
+     * @returns {number} The inclination of the satellite.
+     */
+    static getInclination(tleLine2: TleLine2): number;
+    /**
+     * Right ascension of the ascending node in degrees. Essentially, this is the angle of the
+     * satellite as it crosses northward (ascending) across the Earth's equator (equatorial
+     * plane).
+     *
+     * Units: degrees
+     *
+     * Range: 0 to 359.9999
+     *
+     * Example: 208.9163
+     *
+     * @param {string} tleLine2 The second line of the TLE to parse.
+     * @returns {number} The right ascension of the satellite.
+     */
+    static getRaan(tleLine2: TleLine2): number;
+    /**
+     * Orbital eccentricity, decimal point assumed. All artificial Earth satellites have an
+     * eccentricity between 0 (perfect circle) and 1 (parabolic orbit).
+     *
+     * Range: 0 to 1
+     *
+     * Example: 0.0006317 (`0006317` in the original TLE)
+     *
+     * @param {string} tleLine2 The second line of the TLE to parse.
+     * @returns {number} The eccentricity of the satellite.
+     */
+    static getEccentricity(tleLine2: TleLine2): number;
+    /**
+     * Argument of perigee. See https://en.wikipedia.org/wiki/Argument_of_perigee
+     *
+     * Units: degrees
+     *
+     * Range: 0 to 359.9999
+     *
+     * Example: 69.9862
+     *
+     * @param {string} tleLine2 The second line of the TLE to parse.
+     * @returns {number} The argument of perigee in degrees.
+     */
+    static getArgOfPerigee(tleLine2: TleLine2): number;
+    /**
+     * Mean anomaly. Indicates where the satellite was located within its orbit at the time of the
+     * TLE epoch.
+     * See https://en.wikipedia.org/wiki/Mean_Anomaly
+     *
+     * Units: degrees
+     *
+     * Range: 0 to 359.9999
+     *
+     * Example: 25.2906
+     *
+     * @param {string} tleLine2 The second line of the TLE to parse.
+     * @returns {number} The mean anomaly of the satellite.
+     */
+    static getMeanAnomaly(tleLine2: TleLine2): number;
+    /**
+     * Revolutions around the Earth per day (mean motion).
+     * See https://en.wikipedia.org/wiki/Mean_Motion
+     *
+     * Range: 0 to 17 (theoretically)
+     * Example: 15.54225995
+     * @param {string} tleLine2 The second line of the TLE to parse.
+     * @returns {number} The mean motion of the satellite.
+     */
+    static getMeanMotion(tleLine2: TleLine2): number;
+    /**
+     * Total satellite revolutions when this TLE was generated. This number rolls over
+     * (e.g. 99999 -> 0).
+     *
+     * Range: 0 to 99999
+     *
+     * Example: 6766
+     *
+     * @param {string} tleLine2 The second line of the TLE to parse.
+     * @returns {number} The revolutions around the Earth per day (mean motion).
+     */
+    static getRevNum(tleLine2: TleLine2): number;
+}
+export {};