ootk 1.5.0 → 1.5.1

package/dist/objects/base-object.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The BaseObject class is used for creating core properties and methods applicable
+ * to ground and space based objects.
+ *
+ * @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 { EciVec3, SpaceObjectType } from '../types/types';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    position?: EciVec3;
+    time?: Date;
+}
+export declare class BaseObject {
+    name: string;
+    type: SpaceObjectType;
+    position: EciVec3;
+    time: Date;
+    constructor(info: ObjectInfo);
+    getName(): string;
+    getType(): SpaceObjectType;
+    getTypeString(): string;
+}
+export {};

package/dist/objects/detailed-sat.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The DetailedSat class is an extension of the Sat class that provides additional
+ * properties for categorizing and filtering satellites.
+ *
+ * @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 { LaunchDetails, OperationsDetails, SpaceCraftDetails, SpaceObjectType } from '../types/types';
+import { Sat } from './sat';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    rcs?: number;
+    vmag?: number;
+    tle1: string;
+    tle2: string;
+}
+export declare class DetailedSat extends Sat {
+    launchDate: string;
+    launchMass: string;
+    launchSite: string;
+    launchVehicle: string;
+    lifetime: string | number;
+    maneuver: string;
+    manufacturer: string;
+    motor: string;
+    power: string;
+    payload: string;
+    purpose: string;
+    shape: string;
+    span: string;
+    user: string;
+    mission: string;
+    owner: string;
+    configuration: string;
+    equipment: string;
+    dryMass: string;
+    country: string;
+    constructor(info: ObjectInfo, options: any, details: {
+        launchDetails: LaunchDetails;
+        spaceCraftDetails: SpaceCraftDetails;
+        operationsDetails: OperationsDetails;
+    });
+    setLaunchDetails(details: LaunchDetails): void;
+    getLaunchDetails(): LaunchDetails;
+    setSpaceCraftDetails(details: SpaceCraftDetails): void;
+    getSpaceCraftDetails(): SpaceCraftDetails;
+    setOperationsDetails(details: OperationsDetails): void;
+    getOperationsDetails(): OperationsDetails;
+}
+export {};

package/dist/objects/index.d.ts

@@ -0,0 +1,4 @@
+export { DetailedSat } from './detailed-sat';
+export { Sat } from './sat';
+export { Sensor } from './sensor';
+export { Star } from './star';

package/dist/objects/sat.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Sat class provides functions for calculating satellites positions relative
+ * to earth based sensors and other orbital objects.
+ *
+ * @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 { EcfVec3, EciVec3, LlaVec3, RaeVec3, SatelliteRecord, SpaceObjectType, StateVector } from '../types/types';
+import { Sensor } from './sensor';
+import { SpaceObject } from './space-object';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    rcs?: number;
+    vmag?: number;
+    tle1: string;
+    tle2: string;
+}
+export declare class Sat extends SpaceObject {
+    satNum: number;
+    satrec: SatelliteRecord;
+    intlDes: string;
+    epochYear: number;
+    epochDay: number;
+    meanMoDev1: number;
+    meanMoDev2: number;
+    bstar: number;
+    inclination: number;
+    raan: number;
+    eccentricity: number;
+    argOfPerigee: number;
+    meanAnomaly: number;
+    meanMotion: number;
+    period: number;
+    apogee: number;
+    perigee: number;
+    options: any;
+    constructor(info: ObjectInfo, options: any);
+    propagateTo(date: Date): Sat;
+    /**
+     * Calculates position and velocity in ECI coordinates at a given time.
+     * @param {Date} date Date to calculate the state vector for
+     * @returns {StateVector} State vector for the given date
+     */
+    getStateVec(date?: Date): StateVector;
+    /**
+     * Calculates ECI position at a given time.
+     * @param {Date} date Date to calculate
+     * @returns {EciVec3} ECI position vector
+     */
+    getEci(date?: Date): EciVec3;
+    /**
+     * Calculates ECF position at a given time.
+     * @param {Date} date Date to calculate
+     * @returns {EcfVec3} ECF position vector
+     */
+    getEcf(date?: Date): EcfVec3;
+    /**
+     * Calculates LLA position at a given time.
+     * @param {Date} date Date to calculate
+     * @returns {LlaVec3} LLA position vector
+     */
+    getLla(date?: Date): LlaVec3;
+    getRae(sensor: Sensor, date?: Date): RaeVec3;
+    /**
+     * Calculates the time variables for a given date relative to the TLE epoch.
+     * @param {Date} date Date to calculate
+     * @param {SatelliteRecord} satrec Satellite orbital information
+     * @returns {{m: number, gmst: GreenwichMeanSiderealTime, j: number}} Time variables
+     */
+    private static calculateTimeVariables;
+}
+export {};

package/dist/objects/sensor.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Sensor class is used for creating ground based observers.
+ *
+ * @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 { RaeVec3, SpaceObjectType } from '../types/types';
+import { BaseObject } from './base-object';
+import { Sat } from './sat';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    lat: number;
+    lon: number;
+    alt: number;
+}
+export declare class Sensor extends BaseObject {
+    lat: number;
+    lon: number;
+    alt: number;
+    constructor(info: ObjectInfo);
+    setTime(date: Date): Sensor;
+    getRae(sat: Sat, date?: Date): RaeVec3;
+}
+export {};

package/dist/objects/space-object.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The SpaceObject class is meant to provide properties to satellites/stars that
+ * do not apply to ground based objects.
+ *
+ * @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 { BaseObject } from './base-object';
+import { SpaceObjectType } from '../types/types';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    rcs?: number;
+    vmag?: number;
+}
+export declare class SpaceObject extends BaseObject {
+    rcs: number;
+    vmag: number;
+    constructor(info: ObjectInfo);
+    getRcs(): number;
+    getVmag(): number;
+}
+export {};

package/dist/objects/star.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Star class is meant to help with cacluating star positions relative to
+ * satellites and earth based sensors.
+ *
+ * @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 { EciVec3, LlaVec3, RaeVec3, SpaceObjectType } from '../types/types';
+import { SpaceObject } from './space-object';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    vmag?: number;
+    ra: number;
+    dec: number;
+    pname?: string;
+    bf?: string;
+    h?: string;
+}
+export declare class Star extends SpaceObject {
+    pname: string;
+    bf: string;
+    h: string;
+    dec: number;
+    ra: number;
+    constructor(info: ObjectInfo);
+    getEci(lla?: LlaVec3, date?: Date): EciVec3;
+    getRae(lla?: LlaVec3, date?: Date): RaeVec3;
+    private static calculateTimeVariables;
+}
+export {};

package/dist/sgp4/sgp4.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Sgp4 module contains a TypeScript port of the 2020 version of
+ * sgp4unit.cpp from "Fundamentals of Astrodynamics and Applications" by David
+ * Vallado. All of the original comments and notes are inserted in the code below
+ * in order provide context to the functions and clarify any adjustments made for
+ * TypeScript/JavaScript compatibility.
+ *
+ * @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 { SatelliteRecord, StateVector, Vec3Flat } from '../types/types';
+declare class Sgp4 {
+    private static dpper;
+    private static dscom;
+    private static dsinit;
+    private static dspace;
+    private static initl;
+    private static sgp4init;
+    static propagate(satrec: SatelliteRecord, tsince: number): StateVector;
+    private static getgravconst;
+    static createSatrec(tleLine1: string, tleLine2: string, whichconst?: string, opsmode?: string): SatelliteRecord;
+    static gstime(jdut1: number): number;
+    static sgn(x: number): number;
+    static mag(x: Vec3Flat): number;
+    static cross(vec1: Vec3Flat, vec2: Vec3Flat): Vec3Flat;
+    static dot(x: Vec3Flat, y: Vec3Flat): number;
+    static angle(vec1: Vec3Flat, vec2: Vec3Flat): number;
+    static asinh(xval: number): number;
+    static newtonnu(ecc: number, nu: number): {
+        e0: number;
+        m: number;
+    };
+    static sinh(x: number): number;
+    static rv2coe(r: Vec3Flat, v: Vec3Flat, mus: number): {
+        p: number;
+        a: number;
+        ecc: number;
+        incl: number;
+        omega: number;
+        argp: number;
+        nu: number;
+        m: number;
+        arglat: number;
+        truelon: number;
+        lonper: number;
+    };
+    static jday(year: number | Date, mon?: number, day?: number, hr?: number, min?: number, sec?: number, ms?: number): {
+        jd: number;
+        jdFrac: number;
+    };
+    static days2mdhms(year: number, days: number): {
+        mon: number;
+        day: number;
+        hr: number;
+        min: number;
+        sec: number;
+    };
+    static invjday(jd: number, jdfrac: number): {
+        year: number;
+        mon: number;
+        day: number;
+        hr: number;
+        min: number;
+        sec: number;
+    };
+}
+export { Sgp4 };

package/dist/tle/tle-format-data.d.ts

@@ -0,0 +1,6 @@
+export declare class TleFormatData {
+    start: number;
+    stop: number;
+    length: number;
+    constructor(start: number, end: number);
+}