Skip to main content

OutfitCache

Struct OutfitCache 

Source
pub struct OutfitCache { /* private fields */ }
Expand description

Precomputed observer positions for all observations in a dataset.

OutfitCache is the top-level cache built once before any trajectory fitting, from a fully loaded ObsDataset. It encapsulates:

  • a per-observation centric cache (CentricObserverCache) holding geocentric and heliocentric positions at each observation epoch;
  • a per-observer body-fixed cache (BodyFixedObserverCache) holding the time-independent Earth-fixed state of each observer.

All positions are in the ecliptic mean J2000 frame (AU / AU·day⁻¹).

§Build

Use OutfitCache::build to construct the cache. Accessor methods then provide O(1) lookups keyed by ObsIndex or ObserverId.

Implementations§

Source§

impl OutfitCache

Source

pub fn get_centric(&self, idx: ObsIndex) -> &ObserverCentricCache

Returns the full ObserverCentricCache entry for the observation at idx.

The returned reference gives access to the geocentric position, geocentric velocity, and heliocentric position at the epoch of that observation.

§Panics

Panics if idx is out of bounds (i.e., ≥ number of observations in the dataset used to build this cache).

Source

pub fn get_fixed(&self, observer_id: ObserverId) -> Option<&ObserverFixedCache>

Returns the ObserverFixedCache for the given observer, if present.

Returns None if observer_id is not found in the body-fixed cache (e.g., the observer was not part of the dataset used to build this cache).

Source

pub fn build( obs_dataset: &ObsDataset, jpl: &JPLEphem, ut1_provider: &Ut1Provider, cache_velocity: bool, ) -> Result<Self, OutfitError>

Builds the cache for every observation in obs_dataset.

This is the primary constructor. It proceeds in two steps:

  1. Build the BodyFixedObserverCache from the dataset’s observer list.
  2. Build the CentricObserverCache by computing epoch-dependent positions for each observation using the JPL ephemeris and UT1 provider.
§Arguments
  • obs_dataset — the observation dataset to cache; all observers must have valid geodetic coordinates and associated observer IDs.
  • jpl — JPL planetary ephemeris (DE440 or compatible) for heliocentric Earth positions.
  • ut1_provider — UT1 time scale data for computing Earth’s sidereal angle at each observation epoch.
  • cache_velocity — whether to compute and cache the velocity components in the resulting ObserverCentricCache. If false, the velocity fields will be set to None to save computation time and memory.
§Errors

Returns OutfitError if:

  • the dataset’s observer iterator fails, or
  • any observer’s body-fixed position cannot be computed, or
  • any observation lacks an associated observer ID, or
  • the JPL ephemeris or UT1 provider cannot be evaluated at a given epoch.
Source

pub fn get_observer_fixed_cache( &self, observer_id: ObserverId, ) -> Option<&ObserverFixedCache>

Returns the ObserverFixedCache for the given observer, if present.

Alias for OutfitCache::get_fixed, provided for explicitness when the caller already has an ObserverId.

Source

pub fn get_observer_geocentric_position( &self, idx: ObsIndex, ) -> &ObserverGeocentricPosition

Returns the precomputed geocentric position of the observer at observation idx.

The position is in the ecliptic mean J2000 frame, in AU.

§Panics

Panics if idx is out of bounds.

Source

pub fn get_observer_geocentric_velocity( &self, idx: ObsIndex, ) -> &Option<ObserverGeocentricVelocity>

Returns the precomputed geocentric velocity of the observer at observation idx.

The velocity is in the ecliptic mean J2000 frame, in AU/day.

§Panics

Panics if idx is out of bounds.

Source

pub fn get_helio_position(&self, idx: ObsIndex) -> &ObserverHeliocentricPosition

Returns the precomputed heliocentric position of the observer at observation idx.

The position is in the ecliptic mean J2000 frame, in AU.

§Panics

Panics if idx is out of bounds.

Trait Implementations§

Source§

impl Debug for OutfitCache

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more