ootk/dist/coordinate/ITRF.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 } from '../main.js';
import { Geodetic } from './Geodetic.js';
import { J2000 } from './J2000.js';
import { StateVector } from './StateVector.js';
/**
 * The International Terrestrial Reference Frame (ITRF) is a geocentric reference frame for the Earth. It is the
 * successor to the International Terrestrial Reference System (ITRS). The ITRF definition is maintained by the
 * International Earth Rotation and Reference Systems Service (IERS). Several versions of ITRF exist, each with a
 * different epoch, to address the issue of crustal motion. The latest version is ITRF2014, based on data collected from
 * 1980 to 2014.
 * @see https://en.wikipedia.org/wiki/International_Terrestrial_Reference_Frame
 *
 * This is a geocentric coordinate system, also referenced as ECF/ECEF (Earth Centered Earth Fixed). It is a Cartesian
 * coordinate system with the origin at the center of the Earth. The x-axis intersects the sphere of the Earth at 0°
 * latitude (the equator) and 0° longitude (the Prime Meridian). The z-axis goes through the North Pole. The y-axis goes
 * through 90° East longitude.
 * @see https://en.wikipedia.org/wiki/Earth-centered,_Earth-fixed_coordinate_system
 */
export declare class ITRF extends StateVector {
    /**
     * Gets the name of the ITRF coordinate system.
     * @returns The name of the coordinate system.
     */
    get name(): string;
    /**
     * Gets a value indicating whether the coordinate system is inertial.
     * @returns A boolean value indicating whether the coordinate system is inertial.
     */
    get inertial(): boolean;
    /**
     * Gets the height of the ITRF coordinate above the surface of the Earth in kilometers.
     * @returns The height in kilometers.
     */
    get height(): Kilometers;
    /**
     * Gets the altitude in kilometers.
     * @returns The altitude in kilometers.
     */
    get alt(): Kilometers;
    /**
     * Converts the current coordinate to the J2000 coordinate system. This is an Earth-Centered Inertial (ECI) coordinate
     * system with the origin at the center of the Earth.
     * @see https://en.wikipedia.org/wiki/Epoch_(astronomy)#Julian_years_and_J2000
     * @returns The coordinate in the J2000 coordinate system.
     */
    toJ2000(): J2000;
    /**
     * Converts the current ITRF coordinate to Geodetic coordinate. This is a coordinate system for latitude, longitude,
     * and altitude.
     * @returns The converted Geodetic coordinate.
     */
    toGeodetic(): Geodetic;
}