ootk 1.5.0 → 1.5.3

package/dist/tle/tle.d.ts

@@ -0,0 +1,374 @@
+/**
+ * @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.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+import { Line1Data, Line2Data, TleLine1, TleLine2 } from '../types/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 {};

package/dist/transforms/transforms.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Transforms module contains a collection of conversions not contained
+ * in the original SGP4 library such as ECI to ECF and ECF to RAE. This was based
+ * on some of the functions in satellite.js.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+import { Degrees, EcfVec3, EciVec3, LlaVec3, Radians, RaeVec3, SezVec3 } from '../types/types';
+declare class Transforms {
+    static getDegLat(radians: Radians): Degrees;
+    static getDegLon(radians: Radians): Degrees;
+    static getRadLat(degrees: Degrees): Radians;
+    static getRadLon(degrees: Degrees): Radians;
+    static rad2deg(radians: Radians): Degrees;
+    static deg2rad(degrees: Degrees): Radians;
+    static ecf2eci(ecf: EcfVec3, gmst: number): EciVec3;
+    static ecf2rae(lla: LlaVec3, ecf: EcfVec3): RaeVec3;
+    /**
+     * EciToGeodetic converts eci coordinates to lla coordinates
+     * @param {vec3} eci takes xyz coordinates
+     * @param {number} gmst takes a number in gmst time
+     * @returns {array} array containing lla coordinates
+     */
+    static eci2lla(eci: EciVec3, gmst: number): LlaVec3;
+    static eci2ecf(eci: EciVec3, gmst: number): EcfVec3;
+    static lla2ecf(lla: LlaVec3): EcfVec3;
+    static lla2sez(lla: LlaVec3, ecf: EcfVec3): SezVec3;
+    static rae2sez(rae: RaeVec3): SezVec3;
+    static rae2ecf(rae: RaeVec3, lla: LlaVec3): EcfVec3;
+    /**
+     * @param {Object} sez Containing SEZ coordinates
+     * @param {Number} sez.s Positive horizontal vector S due south.
+     * @param {Number} sez.e Positive horizontal vector E due east.
+     * @param {Number} sez.z Vector Z normal to the surface of the earth (up).
+     * @returns {Object} Rng, Az, El array
+     */
+    static sez2rae(sez: SezVec3): RaeVec3;
+}
+export { Transforms };

package/dist/types/types.d.ts

@@ -0,0 +1,272 @@
+export declare type Kilometer = number;
+export declare type Radians = number;
+export declare type Degrees = number;
+export declare type Vec3<Type> = {
+    x: Type;
+    y: Type;
+    z: Type;
+};
+export declare type EciVec3 = Vec3<Kilometer>;
+export declare type EcfVec3 = {
+    x: Kilometer;
+    y: Kilometer;
+    z: Kilometer;
+};
+export declare type LlaVec3 = {
+    lat: Radians;
+    lon: Radians;
+    alt: Kilometer;
+};
+export declare type RaeVec3 = {
+    rng: Kilometer;
+    az: Degrees;
+    el: Degrees;
+};
+export declare type SezVec3 = {
+    s: Kilometer;
+    e: Kilometer;
+    z: Kilometer;
+};
+/**
+ * @interface SatelliteRecord contains all of the orbital parameters necessary for running SGP4.
+ * It is generated by Sgp4.createSatrec.
+ *
+ */
+export interface SatelliteRecord {
+    a: number;
+    am: number;
+    alta: number;
+    altp: number;
+    argpdot: number;
+    argpo: number;
+    aycof: number;
+    bstar: number;
+    cc1: number;
+    cc4: number;
+    cc5: number;
+    con41: number;
+    d2: number;
+    d3: number;
+    d4: number;
+    d5232: number;
+    d5421: number;
+    d5433: number;
+    dedt: number;
+    delmo: number;
+    del1: number;
+    ecco: number;
+    em: number;
+    epochdays: number;
+    epochyr: number;
+    error: number;
+    eta: number;
+    gsto: number;
+    im: number;
+    inclo: number;
+    init: string;
+    isimp: number;
+    jdsatepoch: number;
+    mdot: number;
+    method: string;
+    mo: number;
+    mm: number;
+    nddot: number;
+    ndot: number;
+    no: number;
+    nodecf: number;
+    nodedot: number;
+    nodeo: number;
+    om: number;
+    Om: number;
+    omgcof: number;
+    operationmode: string;
+    satnum: string;
+    sinmao: number;
+    t: number;
+    t2cof: number;
+    t3cof: number;
+    t4cof: number;
+    t5cof: number;
+    x1mth2: number;
+    x7thm1: number;
+    xlcof: number;
+    xmcof: number;
+    xfact: number;
+    xlamo: number;
+    xli: number;
+    xgh4: number;
+    xgh3: number;
+    xh2: number;
+    xi2: number;
+    xi3: number;
+    xl2: number;
+    xl3: number;
+    xl4: number;
+    zmol: number;
+    zmos: number;
+    dmdt: number;
+    dnodt: number;
+    domdt: number;
+    e3: number;
+    ee2: number;
+    peo: number;
+    pgho: number;
+    pho: number;
+    PInco: number;
+    plo: number;
+    se2: number;
+    se3: number;
+    sgh2: number;
+    sgh3: number;
+    sgh4: number;
+    sh2: number;
+    sh3: number;
+    si2: number;
+    si3: number;
+    sl2: number;
+    sl3: number;
+    sl4: number;
+    xgh2: number;
+    xh3: number;
+    tumin: number;
+    radiusearthkm: number;
+    irez: number;
+    d3210: number;
+    d3222: number;
+    d4410: number;
+    d4422: number;
+    d5220: number;
+    del2: number;
+    del3: number;
+    didt: number;
+    atime: number;
+    j2: number;
+    j3: number;
+    j4: number;
+    mus: number;
+    xke: number;
+    j3oj2: number;
+    xni: number;
+    d2201: number;
+    d2211: number;
+    nm: number;
+}
+/** @typedef StateVector is a three dimensional position and velocity vector output from Sgp4.propagate.*/
+export declare type StateVector = {
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    } | boolean;
+    velocity: {
+        x: number;
+        y: number;
+        z: number;
+    } | boolean;
+};
+/** @typedef Vec3Flat is a flat three dimensional array used in vector math.*/
+export declare type Vec3Flat = [number, number, number];
+/** @typedef TleLine1 is the first line of a two line element set */
+export declare type TleLine1 = string;
+/** @typedef TleLine2 is the second line of a two line element set */
+export declare type TleLine2 = string;
+export declare type Line1Data = {
+    lineNumber1: number;
+    satNum: number;
+    satNumRaw: string;
+    classification: string;
+    intlDes: string;
+    intlDesYear: number;
+    intlDesLaunchNum: number;
+    intlDesLaunchPiece: string;
+    epochYear: number;
+    epochYearFull: number;
+    epochDay: number;
+    meanMoDev1: number;
+    meanMoDev2: number;
+    bstar: number;
+    ephemerisType: number;
+    elsetNum: number;
+    checksum1: number;
+};
+export declare type Line2Data = {
+    lineNumber2: number;
+    satNum: number;
+    satNumRaw: string;
+    inclination: number;
+    raan: number;
+    eccentricity: number;
+    argOfPerigee: number;
+    meanAnomaly: number;
+    meanMotion: number;
+    revNum: number;
+    checksum2: number;
+};
+export declare enum SpaceObjectType {
+    UNKNOWN = 0,
+    PAYLOAD = 1,
+    ROCKET_BODY = 2,
+    DEBRIS = 3,
+    SPECIAL = 4,
+    RADAR_MEASUREMENT = 5,
+    RADAR_TRACK = 6,
+    RADAR_OBJECT = 7,
+    BALLISTIC_MISSILE = 8,
+    STAR = 9,
+    INTERGOVERNMENTAL_ORGANIZATION = 10,
+    SUBORBITAL_PAYLOAD_OPERATOR = 11,
+    PAYLOAD_OWNER = 12,
+    METEOROLOGICAL_ROCKET_LAUNCH_AGENCY_OR_MANUFACTURER = 13,
+    PAYLOAD_MANUFACTURER = 14,
+    LAUNCH_AGENCY = 15,
+    LAUNCH_SITE = 16,
+    LAUNCH_POSITION = 17,
+    LAUNCH_FACILITY = 18,
+    CONTROL_FACILITY = 19,
+    GROUND_SENSOR_STATION = 20,
+    OPTICAL = 21,
+    MECHANICAL = 22,
+    PHASED_ARRAY_RADAR = 23,
+    OBSERVER = 24,
+    BISTATIC_RADIO_TELESCOPE = 25,
+    COUNTRY = 26,
+    LAUNCH_VEHICLE_MANUFACTURER = 27,
+    ENGINE_MANUFACTURER = 28
+}
+export declare type GreenwichMeanSiderealTime = number;
+export declare type LaunchDetails = {
+    launchDate?: string;
+    launchMass?: string;
+    launchSite?: string;
+    launchVehicle?: string;
+};
+export declare type SpaceCraftDetails = {
+    lifetime?: string | number;
+    maneuver?: string;
+    manufacturer?: string;
+    motor?: string;
+    power?: string;
+    payload?: string;
+    purpose?: string;
+    shape?: string;
+    span?: string;
+    bus?: string;
+    configuration?: string;
+    equipment?: string;
+    dryMass?: string;
+};
+export declare type OperationsDetails = {
+    user?: string;
+    mission?: string;
+    owner?: string;
+    country?: string;
+};
+export declare type AzEl = {
+    az: Radians;
+    el: Radians;
+};
+export declare type Meters = number;
+export declare type SunTime = {
+    solarNoon: Date;
+    nadir: Date;
+};