ostk.physics.coordinate.frame.provider.CIRF¶

class CIRF(self: ostk.physics.coordinate.frame.provider.CIRF)¶

Bases: Provider

Celestial Intermediate Reference Frame (CIRF) provider.

Bias, precession-nutation.

Constructor.

Methods

`clear_xys_cache`	Clear the cached X, Y, s interpolation grid.
`get_transform_at`	Get the transform at a given instant.
`is_defined`	Check if the CIRF provider is defined.
`is_xys_interpolation_enabled`	Check whether X, Y, s interpolation is enabled.
`set_xys_interpolation_enabled`	Enable or disable X, Y, s interpolation at runtime.

static clear_xys_cache() → None¶

Clear the cached X, Y, s interpolation grid.

Releases the memory held by the grid nodes computed so far. Subsequent interpolated evaluations re-populate the grid on demand, so this only affects memory usage and performance, not results.

get_transform_at( self: ostk.physics.coordinate.frame.provider.CIRF, instant: ostk.physics.time.Instant, ) → ostk::physics::coordinate::Transform¶

Get the transform at a given instant.

Parameters:: instant (Instant) -- An instant.
Returns:: The transform from GCRF to CIRF at the given instant.
Return type:: Transform

is_defined(self: ostk.physics.coordinate.frame.provider.CIRF) → bool¶

Check if the CIRF provider is defined.

Returns:: True if defined.
Return type:: bool

static is_xys_interpolation_enabled() → bool¶

Check whether X, Y, s interpolation is enabled.

Defaults to disabled, unless the environment variable OSTK_PHYSICS_COORDINATE_FRAME_PROVIDER_CIRF_XYS_INTERPOLATION is set to "Enabled" or "True". Can be overridden at runtime via set_xys_interpolation_enabled.

Returns:: True if X, Y, s interpolation is enabled.
Return type:: bool

static set_xys_interpolation_enabled(interpolation_enabled: bool) → None¶

Enable or disable X, Y, s interpolation at runtime.

Overrides the environment-variable default for the lifetime of the process.

Parameters:: interpolation_enabled (bool) -- True to enable interpolation, False to evaluate the series directly.