ootk 4.0.9 → 5.0.0

package/src/interpolator/ChebyshevCoefficients.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Kilometers, KilometersPerSecond, PositionVelocity, Seconds, Vector3D } from 'ootk-core';
+import { Kilometers, KilometersPerSecond, PositionVelocity, Seconds, Vector3D } from '../main.js';
 
 // / Chebyshev compressed ephemeris coefficients.
 export class ChebyshevCoefficients {

package/src/interpolator/ChebyshevInterpolator.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, EpochWindow, J2000 } from 'ootk-core';
+import { EpochUTC, EpochWindow, J2000 } from '../main.js';
 import { ChebyshevCoefficients } from './ChebyshevCoefficients.js';
 import { StateInterpolator } from './StateInterpolator.js';
 

package/src/interpolator/CubicSpline.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Kilometers, KilometersPerSecond, Seconds, Vector3D } from 'ootk-core';
+import { Kilometers, KilometersPerSecond, Seconds, Vector3D } from '../main.js';
 
 // / Container for cubic spline data.
 export class CubicSpline {

package/src/interpolator/CubicSplineInterpolator.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, EpochWindow, J2000, Kilometers, KilometersPerSecond, Vector3D } from 'ootk-core';
+import { EpochUTC, EpochWindow, J2000, Kilometers, KilometersPerSecond, Vector3D } from '../main.js';
 import { CubicSpline } from './CubicSpline.js';
 import { StateInterpolator } from './StateInterpolator.js';
 

package/src/interpolator/Interpolator.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, EpochWindow, Seconds } from 'ootk-core';
+import { EpochUTC, EpochWindow, Seconds } from '../main.js';
 
 // / Interpolator base class.
 export abstract class Interpolator {

package/src/interpolator/LagrangeInterpolator.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, EpochWindow, J2000, Kilometers, KilometersPerSecond, Seconds, Vector3D } from 'ootk-core';
+import { EpochUTC, EpochWindow, J2000, Kilometers, KilometersPerSecond, Seconds, Vector3D } from '../main.js';
 import { StateInterpolator } from './StateInterpolator.js';
 
 export class LagrangeInterpolator extends StateInterpolator {

package/src/interpolator/StateInterpolator.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, J2000 } from 'ootk-core';
+import { EpochUTC, J2000 } from '../main.js';
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable class-methods-use-this */
 

package/src/interpolator/VerletBlendInterpolator.ts

@@ -25,7 +25,7 @@ import {
   KilometersPerSecond,
   Seconds,
   Vector3D,
-} from 'ootk-core';
+} from '../main.js';
 import { CubicSplineInterpolator } from './CubicSplineInterpolator.js';
 import { LagrangeInterpolator } from './LagrangeInterpolator.js';
 import { StateInterpolator } from './StateInterpolator.js';

package/src/main.ts

@@ -20,14 +20,22 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-export * from 'ootk-core';
 export * from './enums/index.js';
 export * from './types/types.js';
 export * from './interfaces/index.js';
+export * from './time/index.js';
+export * from './transforms/index.js';
+export * from './utils/index.js';
+export * from './operations/operations.js';
+export { BaseObject } from './objects/index.js';
+export { Earth } from './body/index.js';
 export * from './coordinate/index.js';
+export * from './observation/index.js';
+export * from './data/DataHandler.js';
+export * from './sgp4/index.js';
 export * from './objects/index.js';
+export * from './body/index.js';
 export * from './operations/index.js';
 export * from './force/index.js';
 export * from './propagator/index.js';
-export * from './transforms/index.js';
-export * from './utils/index.js';
+export * from './orbit_determination/index.js';

package/src/maneuver/TwoBurnOrbitTransfer.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Earth, EpochUTC, MetersPerSecond, Seconds, SecondsPerMeterPerSecond } from 'ootk-core';
+import { Earth, EpochUTC, MetersPerSecond, Seconds, SecondsPerMeterPerSecond } from '../main.js';
 import { Thrust } from '../force/Thrust.js';
 
 // / Container for a two-burn orbit transfer.

package/src/maneuver/Waypoint.ts

@@ -24,7 +24,7 @@ import {
   RIC,
   SecondsPerMeterPerSecond,
   Vector3D,
-} from 'ootk-core';
+} from '../main.js';
 import { Thrust } from '../force/Thrust.js';
 import { StateInterpolator } from '../interpolator/StateInterpolator.js';
 import { ForceModel } from './../force/ForceModel.js';

package/src/objects/BaseObject.ts

@@ -0,0 +1,171 @@
+/**
+ * @author Theodore Kruczek.
+ * @license MIT
+ * @copyright (c) 2022-2025 Theodore Kruczek 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 { BaseObjectParams } from '../interfaces/BaseObjectParams.js';
+import { EciVec3, Kilometers, KilometersPerSecond, SpaceObjectType } from '../types/types.js';
+
+export class BaseObject {
+  id: number;
+  name: string;
+  type: SpaceObjectType;
+  position: EciVec3; // Where is the object
+  totalVelocity: number; // How fast is the object moving
+  velocity: EciVec3<KilometersPerSecond>; // How fast is the object moving
+  active = true; // Is the object active
+
+  constructor(info: BaseObjectParams) {
+    this.type = info.type ?? SpaceObjectType.UNKNOWN;
+    this.name = info.name ?? 'Unknown';
+    this.id = info.id ?? -1; // Default to -1 if no id is provided
+    this.active = info.active ?? true;
+
+    // Default to the center of the earth until position is calculated
+    this.position = info.position ?? {
+      x: <Kilometers>0,
+      y: <Kilometers>0,
+      z: <Kilometers>0,
+    };
+
+    // Default to 0 velocity until velocity is calculated
+    this.velocity = info.velocity ?? {
+      x: <KilometersPerSecond>0,
+      y: <KilometersPerSecond>0,
+      z: <KilometersPerSecond>0,
+    };
+    this.totalVelocity = Math.sqrt(this.velocity.x ** 2 + this.velocity.y ** 2 + this.velocity.z ** 2);
+  }
+
+  /**
+   * Checks if the object is a satellite.
+   * @returns True if the object is a satellite, false otherwise.
+   */
+  isSatellite(): boolean {
+    return false;
+  }
+
+  /**
+   * Checks if the object is a ground object.
+   * @returns True if the object is a ground object, false otherwise.
+   */
+  isGroundObject(): boolean {
+    return false;
+  }
+
+  /**
+   * Returns whether the object is a sensor.
+   * @returns True if the object is a sensor, false otherwise.
+   */
+  isSensor(): boolean {
+    return false;
+  }
+
+  /**
+   * Checks if the object is a marker.
+   * @returns True if the object is a marker, false otherwise.
+   */
+  isMarker(): boolean {
+    return false;
+  }
+
+  /**
+   * Returns whether the object's position is static.
+   * @returns True if the object is static, false otherwise.
+   */
+  isStatic(): boolean {
+    return this.velocity.x === 0 && this.velocity.y === 0 && this.velocity.z === 0;
+  }
+
+  isPayload(): boolean {
+    return this.type === SpaceObjectType.PAYLOAD;
+  }
+
+  isRocketBody(): boolean {
+    return this.type === SpaceObjectType.ROCKET_BODY;
+  }
+
+  isDebris(): boolean {
+    return this.type === SpaceObjectType.DEBRIS;
+  }
+
+  isStar(): boolean {
+    return this.type === SpaceObjectType.STAR;
+  }
+
+  isMissile(): boolean {
+    return this.type === SpaceObjectType.BALLISTIC_MISSILE;
+  }
+
+  isNotional(): boolean {
+    return this.type === SpaceObjectType.NOTIONAL;
+  }
+
+  getTypeString(): string {
+    const typeToStringMap: { [key in SpaceObjectType]?: string } = {
+      [SpaceObjectType.UNKNOWN]: 'Unknown',
+      [SpaceObjectType.PAYLOAD]: 'Payload',
+      [SpaceObjectType.ROCKET_BODY]: 'Rocket Body',
+      [SpaceObjectType.DEBRIS]: 'Debris',
+      [SpaceObjectType.SPECIAL]: 'Special',
+      [SpaceObjectType.BALLISTIC_MISSILE]: 'Ballistic Missile',
+      [SpaceObjectType.STAR]: 'Star',
+      [SpaceObjectType.INTERGOVERNMENTAL_ORGANIZATION]: 'Intergovernmental Organization',
+      [SpaceObjectType.SUBORBITAL_PAYLOAD_OPERATOR]: 'Suborbital Payload Operator',
+      [SpaceObjectType.PAYLOAD_OWNER]: 'Payload Owner',
+      [SpaceObjectType.METEOROLOGICAL_ROCKET_LAUNCH_AGENCY_OR_MANUFACTURER]:
+        'Meteorological Rocket Launch Agency or Manufacturer',
+      [SpaceObjectType.PAYLOAD_MANUFACTURER]: 'Payload Manufacturer',
+      [SpaceObjectType.LAUNCH_AGENCY]: 'Launch Agency',
+      [SpaceObjectType.LAUNCH_SITE]: 'Launch Site',
+      [SpaceObjectType.LAUNCH_POSITION]: 'Launch Position',
+      [SpaceObjectType.LAUNCH_FACILITY]: 'Launch Facility',
+      [SpaceObjectType.CONTROL_FACILITY]: 'Control Facility',
+      [SpaceObjectType.GROUND_SENSOR_STATION]: 'Ground Sensor Station',
+      [SpaceObjectType.OPTICAL]: 'Optical',
+      [SpaceObjectType.MECHANICAL]: 'Mechanical',
+      [SpaceObjectType.PHASED_ARRAY_RADAR]: 'Phased Array Radar',
+      [SpaceObjectType.OBSERVER]: 'Observer',
+      [SpaceObjectType.BISTATIC_RADIO_TELESCOPE]: 'Bistatic Radio Telescope',
+      [SpaceObjectType.COUNTRY]: 'Country',
+      [SpaceObjectType.LAUNCH_VEHICLE_MANUFACTURER]: 'Launch Vehicle Manufacturer',
+      [SpaceObjectType.ENGINE_MANUFACTURER]: 'Engine Manufacturer',
+    };
+
+    return typeToStringMap[this.type] ?? 'Unknown';
+  }
+
+  /**
+   * Validates a parameter value against a minimum and maximum value.
+   * @param value - The value to be validated.
+   * @param minValue - The minimum allowed value.
+   * @param maxValue - The maximum allowed value.
+   * @param errorMessage - The error message to be thrown if the value is invalid.
+   */
+  validateParameter<T>(value: T, minValue: T, maxValue: T, errorMessage: string): void {
+    if (typeof minValue !== 'undefined' && minValue !== null && (value as number) < (minValue as number)) {
+      throw new Error(errorMessage);
+    }
+    if (typeof maxValue !== 'undefined' && maxValue !== null && (value as number) > (maxValue as number)) {
+      throw new Error(errorMessage);
+    }
+  }
+}

package/src/objects/DetailedSatellite.ts

@@ -15,18 +15,18 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
+import { Satellite } from './Satellite.js';
 import {
   FormatTle,
   LaunchDetails,
   OperationsDetails,
   OptionsParams,
-  Satellite,
   SpaceCraftDetails,
   TleLine1,
   TleLine2,
-} from 'ootk-core';
+  CatalogSource,
+} from '../main.js';
 import { DetailedSatelliteParams, PayloadStatus } from '../types/types.js';
-import { CatalogSource } from '../main.js';
 
 /**
  * Represents a detailed satellite object with launch, spacecraft, and operations details.

package/src/objects/DetailedSensor.ts

@@ -15,7 +15,8 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Milliseconds, Sensor } from 'ootk-core';
+import { Sensor } from './Sensor.js';
+import { Milliseconds } from '../main.js';
 import { DetailedSensorParams, ZoomValue } from '../types/types.js';
 import { CommLink } from '../enums/CommLink.js';
 

package/src/objects/GroundObject.ts

@@ -0,0 +1,176 @@
+/**
+ * @author Theodore Kruczek.
+ * @license MIT
+ * @copyright (c) 2022-2025 Theodore Kruczek 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 {
+  GroundPositionParams,
+  Degrees,
+  EcfVec3,
+  EciVec3,
+  Kilometers,
+  LlaVec3,
+  Radians,
+  RaeVec3,
+  calcGmst,
+  lla2eci,
+  llaRad2ecf,
+  DEG2RAD,
+  Geodetic,
+  BaseObjectParams,
+  SpaceObjectType,
+} from '../main.js';
+
+import { BaseObject } from './BaseObject.js';
+import { Satellite } from './Satellite.js';
+
+export class GroundObject extends BaseObject {
+  override name = 'Unknown Ground Object';
+  lat: Degrees;
+  lon: Degrees;
+  alt: Kilometers;
+
+  constructor(info: GroundPositionParams & BaseObjectParams) {
+    super(info);
+
+    this.validateGroundObjectInputData_(info);
+    this.name = info.name ?? this.name;
+    this.lat = info.lat;
+    this.lon = info.lon;
+    this.alt = info.alt;
+  }
+
+  /**
+   * Calculates the relative azimuth, elevation, and range between this GroundObject and a Satellite.
+   * @param satellite The Satellite object.
+   * @param date The date for which to calculate the RAE values. Defaults to the current date.
+   * @returns The relative azimuth, elevation, and range values in kilometers and degrees.
+   */
+  rae(satellite: Satellite, date: Date = new Date()): RaeVec3<Kilometers, Degrees> | null {
+    return satellite.rae(this, date);
+  }
+
+  /**
+   * Calculates ECF position at a given time.
+   * @variation optimized version of this.toGeodetic().toITRF().position;
+   * @returns The ECF position vector of the ground object.
+   */
+  ecf(): EcfVec3<Kilometers> {
+    return llaRad2ecf(this.toGeodetic());
+  }
+
+  /**
+   * Calculates the Earth-Centered Inertial (ECI) position vector of the ground object at a given date.
+   * @variation optimzed version of this.toGeodetic().toITRF().toJ2000().position;
+   * @param date The date for which to calculate the ECI position vector. Defaults to the current date.
+   * @returns The ECI position vector of the ground object.
+   */
+  eci(date: Date = new Date()): EciVec3<Kilometers> {
+    const { gmst } = calcGmst(date);
+
+    return lla2eci(this.toGeodetic(), gmst);
+  }
+
+  /**
+   * Returns the latitude, longitude, and altitude of the GroundObject.
+   * @returns The latitude, longitude, and altitude as an LlaVec3 object.
+   */
+  lla(): LlaVec3<Degrees, Kilometers> {
+    return {
+      lat: this.lat,
+      lon: this.lon,
+      alt: this.alt,
+    };
+  }
+
+  /**
+   * Converts the latitude, longitude, and altitude of the GroundObject to radians and kilometers.
+   * @variation optimized version of this.toGeodetic() without class instantiation for better performance and
+   * serialization.
+   * @returns An object containing the latitude, longitude, and altitude in
+   * radians and kilometers.
+   */
+  llaRad(): LlaVec3<Radians, Kilometers> {
+    return {
+      lat: (this.lat * DEG2RAD) as Radians,
+      lon: (this.lon * DEG2RAD) as Radians,
+      alt: this.alt,
+    };
+  }
+
+  get latRad(): Radians {
+    return this.lat * DEG2RAD as Radians;
+  }
+
+  get lonRad(): Radians {
+    return this.lon * DEG2RAD as Radians;
+  }
+
+  /**
+   * Creates a GroundObject object from a Geodetic position.
+   * @param geodetic The geodetic coordinates.
+   * @returns A new GroundObject object.
+   */
+  static fromGeodetic(geodetic: Geodetic): GroundObject {
+    return new GroundObject({
+      lat: geodetic.latDeg as Degrees,
+      lon: geodetic.lonDeg as Degrees,
+      alt: geodetic.alt,
+    });
+  }
+
+  /**
+   * Converts the ground position to geodetic coordinates.
+   * @returns The geodetic coordinates.
+   */
+  toGeodetic(): Geodetic {
+    return Geodetic.fromDegrees(this.lat, this.lon, this.alt);
+  }
+
+  /**
+   * Validates the input data for the GroundObject.
+   * @param info - The GroundPositionParams object containing the latitude,
+   * longitude, and altitude. @returns void
+   */
+  private validateGroundObjectInputData_(info: GroundPositionParams) {
+    this.validateParameter(info.lat, -90, 90, 'Invalid latitude - must be between -90 and 90');
+    this.validateParameter(info.lon, -180, 180, 'Invalid longitude - must be between -180 and 180');
+    this.validateParameter(info.alt, 0, null, 'Invalid altitude - must be greater than 0');
+  }
+
+  override isGroundObject(): boolean {
+    switch (this.type) {
+      case SpaceObjectType.INTERGOVERNMENTAL_ORGANIZATION:
+      case SpaceObjectType.SUBORBITAL_PAYLOAD_OPERATOR:
+      case SpaceObjectType.PAYLOAD_OWNER:
+      case SpaceObjectType.METEOROLOGICAL_ROCKET_LAUNCH_AGENCY_OR_MANUFACTURER:
+      case SpaceObjectType.PAYLOAD_MANUFACTURER:
+      case SpaceObjectType.LAUNCH_VEHICLE_MANUFACTURER:
+      case SpaceObjectType.ENGINE_MANUFACTURER:
+      case SpaceObjectType.LAUNCH_AGENCY:
+      case SpaceObjectType.LAUNCH_SITE:
+      case SpaceObjectType.LAUNCH_POSITION:
+        return true;
+      default:
+        return false;
+    }
+  }
+}

package/src/objects/LandObject.ts

@@ -15,7 +15,8 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { BaseObject, BaseObjectParams, Degrees, Kilometers } from 'ootk-core';
+import { BaseObject } from './BaseObject.js';
+import { BaseObjectParams, Degrees, Kilometers } from '../main.js';
 /* eslint-disable class-methods-use-this */
 
 export interface LandObjectParams extends BaseObjectParams {

package/src/objects/Marker.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { BaseObject } from 'ootk-core';
+import { BaseObject } from './BaseObject.js';
 /* eslint-disable class-methods-use-this */
 
 export class Marker extends BaseObject {

package/src/objects/RfSensor.ts

@@ -21,8 +21,7 @@
  * SOFTWARE.
  */
 
-import { DEG2RAD, Degrees, RAD2DEG, Radians, SpaceObjectType } from 'ootk-core';
-import { azel2uv, uv2azel, RfSensorParams } from '../main.js';
+import { DEG2RAD, Degrees, RAD2DEG, Radians, SpaceObjectType, azel2uv, uv2azel, RfSensorParams } from '../main.js';
 import { DetailedSensor } from './DetailedSensor.js';
 
 export class RfSensor extends DetailedSensor {