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
impl OutfitCache
Sourcepub fn get_centric(&self, idx: ObsIndex) -> &ObserverCentricCache
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).
Sourcepub fn get_fixed(&self, observer_id: ObserverId) -> Option<&ObserverFixedCache>
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).
Sourcepub fn build(
obs_dataset: &ObsDataset,
jpl: &JPLEphem,
ut1_provider: &Ut1Provider,
cache_velocity: bool,
) -> Result<Self, OutfitError>
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:
- Build the
BodyFixedObserverCachefrom the dataset’s observer list. - Build the
CentricObserverCacheby 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 resultingObserverCentricCache. Iffalse, the velocity fields will be set toNoneto 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.
Sourcepub fn get_observer_fixed_cache(
&self,
observer_id: ObserverId,
) -> Option<&ObserverFixedCache>
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.
Sourcepub fn get_observer_geocentric_position(
&self,
idx: ObsIndex,
) -> &ObserverGeocentricPosition
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.
Sourcepub fn get_observer_geocentric_velocity(
&self,
idx: ObsIndex,
) -> &Option<ObserverGeocentricVelocity>
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.
Sourcepub fn get_helio_position(&self, idx: ObsIndex) -> &ObserverHeliocentricPosition
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§
Auto Trait Implementations§
impl Freeze for OutfitCache
impl RefUnwindSafe for OutfitCache
impl Send for OutfitCache
impl Sync for OutfitCache
impl Unpin for OutfitCache
impl UnsafeUnpin for OutfitCache
impl UnwindSafe for OutfitCache
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.