boinor.frames.util

module with utility functions for the frames sub-package

Functions

get_frame(attractor, plane[, obstime])

Returns an appropriate reference frame from an attractor and a plane.

Module Contents

boinor.frames.util.get_frame(attractor, plane, obstime=J2000)

Returns an appropriate reference frame from an attractor and a plane.

Available planes are Earth equator (parallel to GCRS) and Earth ecliptic. The fundamental direction of both is the equinox of epoch (J2000). An obstime is needed to properly locate the attractor.

Parameters:

  • attractor (Body) – Body that serves as the center of the frame.

  • plane (Planes) – Fundamental plane of the frame.

  • obstime (Time) – Time of the frame.