Visibility – ephemerista.analysis.visibility¶
The visibility.py module.
This module provides the Visibility class for conducting visibility analyses.
- class ephemerista.analysis.visibility.Pass(*, window, times, observables)¶
The Pass class.
This class models a ground station pass and provides modelled observables.
- interpolate(time)¶
Interpolate observables for a given time within the window.
- Return type:
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- plot()¶
Plot the observables.
- to_dataframe()¶
Convert the pass observables to a Pandas DataFrame.
- Returns:
DataFrame with columns for time, azimuth_deg, elevation_deg, range_km, and range_rate_km_s.
- Return type:
DataFrame
- class ephemerista.analysis.visibility.Visibility(*, scenario, startTime=None, endTime=None, bodies=[], useGroundLocations=False, parallel=False)¶
The Visibility analysis.
This analysis finds windows of visibility between ground stations and spacecraft within the provided scenario.
- analyze(ensemble=None)¶
Run the analysis.
- Return type:
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class ephemerista.analysis.visibility.VisibilityResults(*, type='visibility', passes)¶
Results of the Visibility analysis.
- get(observer, target)¶
Return all passes for a given observer and target combination.
- Return type:
list[Pass]
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dataframe(observer, target)¶
Convert the results to a Pandas DataFrame.
- Parameters:
- Returns:
DataFrame with columns ‘start’, ‘end’, ‘duration’ for the specified observer-target combination.
- Return type:
DataFrame
- total_duration(observer, target)¶
Return the sum of all visibility durations for a given observer and target combination.
- Return type:
float
- class ephemerista.analysis.visibility.Window(*, start, stop)¶
The Window class.
This class models a visibility window.
- property duration: float¶
duration of the window in seconds.
- Type:
float
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].