pymap3d.eci module

transforms involving ECI earth-centered inertial

Source code
""" transforms involving ECI earth-centered inertial """

from datetime import datetime
import numpy as np
from .sidereal import datetime2sidereal
try:
    from astropy.time import Time
except ImportError:
    Time = None


def eci2ecef(eci: np.ndarray,
             time: datetime,
             useastropy: bool = True) -> np.ndarray:
    """
    Observer => Point  ECI  =>  ECEF

    Parameters
    ----------
    eci : tuple of float
        Nx3 target ECI location (x,y,z) [meters]
    time : datetime.datetime
        time of obsevation (UTC)
    useastropy : bool, optional
        use AstroPy for conversion

    Results
    -------
    x : float
        target x ECEF coordinate
    y : float
        target y ECEF coordinate
    z : float
        target z ECEF coordinate
    """
    useastropy = useastropy and Time

    if useastropy:
        gst = Time(time).sidereal_time('apparent', 'greenwich').radian
    else:
        gst = datetime2sidereal(time, 0.)

    gst = np.atleast_1d(gst)
    assert gst.ndim == 1 and isinstance(gst[0], float)  # must be in radians!

    eci = np.atleast_2d(eci)
    assert eci.shape[0] == gst.size, 'length of time does not match number of ECI positions'

    N, trip = eci.shape
    if eci.ndim > 2 or trip != 3:
        raise ValueError('eci triplets must be shape (N,3)')

    ecef = np.empty_like(eci)

    for i in range(N):
        ecef[i, :] = _rottrip(gst[i]) @ eci[i, :]

    return ecef.squeeze()


def ecef2eci(ecef: np.ndarray,
             time: datetime,
             useastropy: bool = True) -> np.ndarray:
    """
    Point => Point   ECEF => ECI

    input
    -----
    ecef : tuple of float
        Nx3 target ECEF location (x,y,z) [meters]
    time : datetime.datetime
        time of observation
    useastropy : bool, optional
        use AstroPy for conversion


    Results
    -------
    x : float
        target x ECI coordinate
    y : float
        target y ECI coordinate
    z : float
        target z ECI coordinate
    """
    useastropy = useastropy and Time

    if useastropy:
        gst = Time(time).sidereal_time('apparent', 'greenwich').radian
    else:
        gst = datetime2sidereal(time, 0.)

    gst = np.atleast_1d(gst)
    assert gst.ndim == 1 and isinstance(gst[0], float)  # must be in radians!

    ecef = np.atleast_2d(ecef)
    assert ecef.shape[0] == gst.size, 'length of time does not match number of ECEF positions'

    N, trip = ecef.shape
    if ecef.ndim > 2 or trip != 3:
        raise ValueError('ecef triplets must be shape (N,3)')

    eci = np.empty_like(ecef)
    for i in range(N):
        eci[i, :] = _rottrip(gst[i]).T @ ecef[i, :]  # this one is transposed

    return eci.squeeze()


def _rottrip(ang: np.ndarray) -> np.ndarray:
    """
    transformation matrix

    Parameters
    ----------

    ang : N x 3 numpy.ndarray
        angle to transform (radians)
    """
    ang = ang.squeeze()
    if ang.size > 1:
        raise ValueError('only one angle allowed at a time')

    return np.array([[np.cos(ang), np.sin(ang), 0],
                     [-np.sin(ang), np.cos(ang), 0],
                     [0, 0, 1]])

Functions

def ecef2eci(ecef, time, useastropy=True)

Point => Point ECEF => ECI

input

ecef : tuple of float
Nx3 target ECEF location (x,y,z) [meters]
time : datetime.datetime
time of observation
useastropy : bool, optional
use AstroPy for conversion

Results

x : float
target x ECI coordinate
y : float
target y ECI coordinate
z : float
target z ECI coordinate
Source code
def ecef2eci(ecef: np.ndarray,
             time: datetime,
             useastropy: bool = True) -> np.ndarray:
    """
    Point => Point   ECEF => ECI

    input
    -----
    ecef : tuple of float
        Nx3 target ECEF location (x,y,z) [meters]
    time : datetime.datetime
        time of observation
    useastropy : bool, optional
        use AstroPy for conversion


    Results
    -------
    x : float
        target x ECI coordinate
    y : float
        target y ECI coordinate
    z : float
        target z ECI coordinate
    """
    useastropy = useastropy and Time

    if useastropy:
        gst = Time(time).sidereal_time('apparent', 'greenwich').radian
    else:
        gst = datetime2sidereal(time, 0.)

    gst = np.atleast_1d(gst)
    assert gst.ndim == 1 and isinstance(gst[0], float)  # must be in radians!

    ecef = np.atleast_2d(ecef)
    assert ecef.shape[0] == gst.size, 'length of time does not match number of ECEF positions'

    N, trip = ecef.shape
    if ecef.ndim > 2 or trip != 3:
        raise ValueError('ecef triplets must be shape (N,3)')

    eci = np.empty_like(ecef)
    for i in range(N):
        eci[i, :] = _rottrip(gst[i]).T @ ecef[i, :]  # this one is transposed

    return eci.squeeze()
def eci2ecef(eci, time, useastropy=True)

Observer => Point ECI => ECEF

Parameters

eci : tuple of float
Nx3 target ECI location (x,y,z) [meters]
time : datetime.datetime
time of obsevation (UTC)
useastropy : bool, optional
use AstroPy for conversion

Results

x : float
target x ECEF coordinate
y : float
target y ECEF coordinate
z : float
target z ECEF coordinate
Source code
def eci2ecef(eci: np.ndarray,
             time: datetime,
             useastropy: bool = True) -> np.ndarray:
    """
    Observer => Point  ECI  =>  ECEF

    Parameters
    ----------
    eci : tuple of float
        Nx3 target ECI location (x,y,z) [meters]
    time : datetime.datetime
        time of obsevation (UTC)
    useastropy : bool, optional
        use AstroPy for conversion

    Results
    -------
    x : float
        target x ECEF coordinate
    y : float
        target y ECEF coordinate
    z : float
        target z ECEF coordinate
    """
    useastropy = useastropy and Time

    if useastropy:
        gst = Time(time).sidereal_time('apparent', 'greenwich').radian
    else:
        gst = datetime2sidereal(time, 0.)

    gst = np.atleast_1d(gst)
    assert gst.ndim == 1 and isinstance(gst[0], float)  # must be in radians!

    eci = np.atleast_2d(eci)
    assert eci.shape[0] == gst.size, 'length of time does not match number of ECI positions'

    N, trip = eci.shape
    if eci.ndim > 2 or trip != 3:
        raise ValueError('eci triplets must be shape (N,3)')

    ecef = np.empty_like(eci)

    for i in range(N):
        ecef[i, :] = _rottrip(gst[i]) @ eci[i, :]

    return ecef.squeeze()