ootk/dist/coordinate/StateVector.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 { ClassicalElements, Kilometers, KilometersPerSecond, Minutes, EpochUTC, Vector3D } from '../main.js';
/**
 * A state vector is a set of coordinates used to specify the position and
 * velocity of an object in a particular reference frame.
 */
export declare abstract class StateVector {
    epoch: EpochUTC;
    position: Vector3D<Kilometers>;
    velocity: Vector3D<KilometersPerSecond>;
    constructor(epoch: EpochUTC, position: Vector3D<Kilometers>, velocity: Vector3D<KilometersPerSecond>);
    /**
     * The name of the reference frame in which the state vector is defined.
     * @returns The name of the reference frame.
     */
    abstract get name(): string;
    /**
     * Whether the state vector is defined in an inertial reference frame.
     * @returns True if the state vector is defined in an inertial reference
     */
    abstract get inertial(): boolean;
    /**
     * Returns a string representation of the StateVector object. The string includes the name, epoch, position, and
     * velocity.
     * @returns A string representation of the StateVector object.
     */
    toString(): string;
    /**
     * Calculates the mechanical energy of the state vector.
     * @returns The mechanical energy value.
     */
    get mechanicalEnergy(): number;
    /**
     * Calculates the semimajor axis of the state vector.
     * @returns The semimajor axis in kilometers.
     */
    get semimajorAxis(): Kilometers;
    /**
     * Gets the period of the state vector in minutes.
     * @returns The period in minutes.
     */
    get period(): Minutes;
    /**
     * Gets the angular rate of the state vector.
     * @returns The angular rate.
     */
    get angularRate(): number;
    /**
     * Converts the state vector to classical elements.
     * @param mu The gravitational parameter of the celestial body. Defaults to Earth's gravitational parameter.
     * @returns The classical elements corresponding to the state vector.
     * @throws Error if classical elements are undefined for fixed frames.
     */
    toClassicalElements(mu?: number): ClassicalElements;
}