Visibility – ephemerista.analysis.visibility

The visibility.py module.

This module provides the Visibility class for conducting visibility analyses.

pydantic model ephemerista.analysis.visibility.Pass

The Pass class.

This class models a ground station pass and provides modelled observables.

Fields:
field observables: list[Observables] [Required]

Observables.

field times: list[Time] [Required]

Time steps for observables.

field window: Window [Required]

The visibility window.

interpolate(time)

Interpolate observables for a given time within the window.

Return type:

Observables

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:

pd.DataFrame

pydantic model ephemerista.analysis.visibility.Visibility

The Visibility analysis.

This analysis finds windows of visibility between ground stations and spacecraft within the provided scenario.

Fields:
field bodies: list[Origin] = []
field end_time: Time | None = None (alias 'endTime')
field parallel: bool = False

Use parallel execution with visibility_all from lox_space

field scenario: Scenario [Required]
field start_time: Time | None = None (alias 'startTime')
field use_ground_locations: bool = False (alias 'useGroundLocations')

Include ground locations from areas of interest

analyze(ensemble=None)

Run the analysis.

Return type:

VisibilityResults

pydantic model ephemerista.analysis.visibility.VisibilityResults

Results of the Visibility analysis.

Fields:
field passes: dict[UUID, dict[UUID, list[Pass]]] [Required]
field results_type: Literal['visibility'] = 'visibility' (alias 'type')
get(observer, target)

Return all passes for a given observer and target combination.

Return type:

list[Pass]

to_dataframe(observer, target)

Convert the results to a Pandas DataFrame.

Parameters:

  • observer (AssetKey) – Observer asset key for the specific observer-target combination.

  • target (AssetKey) – Target asset key for the specific observer-target combination.

Returns:

DataFrame with columns ‘start’, ‘end’, ‘duration’ for the specified observer-target combination.

Return type:

pd.DataFrame

total_duration(observer, target)

Return the sum of all visibility durations for a given observer and target combination.

Return type:

float

pydantic model ephemerista.analysis.visibility.Window

The Window class.

This class models a visibility window.

Fields:
field start: Time [Required]

Start time of the window.

field stop: Time [Required]

End time of the window.

property duration: float

duration of the window in seconds.

Type:

float