ootk/dist/coordinate/RelativeState.d.ts

Orbital Object Toolkit including Multiple Propagators, Initial Orbit Determination, and Maneuver Calculations.

/**
 * @author @thkruz Theodore Kruczek
 * @description Orbital Object ToolKit (ootk) is a collection of tools for working
 * with satellites and other orbital objects.
 * @license AGPL-3.0-or-later
 * @copyright (c) 2025 Kruczek Labs LLC
 *
 * Many of the classes are based off of the work of @david-rc-dayton and his
 * Pious Squid library (https://github.com/david-rc-dayton/pious_squid) which
 * is licensed under the MIT license.
 *
 * 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 { Kilometers, KilometersPerSecond } from '../main.js';
import { Matrix } from '../operations/Matrix.js';
import { Vector3D } from '../operations/Vector3D.js';
import { J2000 } from './J2000.js';
/**
 * Represents the relative state of an object in 3D space.
 */
export declare abstract class RelativeState {
    position: Vector3D<Kilometers>;
    velocity: Vector3D<KilometersPerSecond>;
    constructor(position: Vector3D<Kilometers>, velocity: Vector3D<KilometersPerSecond>);
    /**
     * Gets the name of the coordinate system.
     * @returns The name of the coordinate system.
     */
    abstract get name(): string;
    /**
     * Returns a string representation of the RelativeState object. The string includes the name, position, and velocity
     * of the object.
     * @returns A string representation of the RelativeState object.
     */
    toString(): string;
    /**
     * Transforms the current RelativeState coordinate to the J2000 coordinate
     * @param origin The origin J2000 coordinate.
     * @returns The transformed J2000 coordinate.
     */
    abstract toJ2000(origin: J2000): J2000;
    /**
     * Creates a matrix based on the given position and velocity vectors. The matrix represents the relative state of an
     * object in 3D space.
     * @param position - The position vector.
     * @param velocity - The velocity vector.
     * @returns The matrix representing the relative state.
     */
    static createMatrix(position: Vector3D, velocity: Vector3D): Matrix;
    /**
     * Calculates the range of the relative state.
     * @returns The range in kilometers.
     */
    get range(): Kilometers;
    /**
     * Calculates the range rate of the relative state. Range rate is the dot product of the position and velocity divided
     * by the range.
     * @returns The range rate in Kilometers per second.
     */
    get rangeRate(): number;
}