across.tools.core.plotting

Functions

plot_visibility_windows(visibility_windows[, ...])

Method to visualize visibility windows using plotly.

plot_joint_visibility_windows(visibility_windows[, ...])

Method to visualize joint visibility windows using plotly.

plot_footprint(detectors[, fig, name, color])

Method to plot a footprint using plotly.

Module Contents

plot_visibility_windows(visibility_windows, observatory_name=None, fig=None, offset=0)[source]

Method to visualize visibility windows using plotly.

Parameters:

  • visibility_windows (list[dict[str, Any]]) – A list of dictionaries containing the JSON-serialized visibility windows.

  • observatory_name (str, optional) – The name of the observatory for these window, by default None.

  • fig (go.Figure, optional) – An existing plotly figure to add to, by default None

  • offset (int | float, optional) – The x-axis offset to plot new visibility windows, by default 0

Returns:

The plotly figure containing the visibility plot

Return type:

go.Figure

plot_joint_visibility_windows(visibility_windows, min_extent=0.0, max_extent=0.0, fig=None)[source]

Method to visualize joint visibility windows using plotly. Plots the individual instrument visibility windows and the regions of joint visibility on one figure.

Parameters:

  • visibility_windows (list[dict[str, Any]]) – A list of dictionaries containing the JSON-serialized visibility windows.

  • min_extent (float, optional) – The leftmost extent of the visibility windows, for overlap with the joint window. By default 0.

  • max_extent (float, optional) – The rightmost extent of the visibility windows, for overlap with the joint window. By default 0.

  • fig (go.Figure, optional) – An existing plotly figure to add to, by default None

Returns:

The plotly figure containing the visibility plot

Return type:

go.Figure

plot_footprint(detectors, fig=None, name=None, color=None)[source]

Method to plot a footprint using plotly.

Parameters:

detectors: list[dict[str, Any]]: The detectors to plot.

Assumes a list of dictionaries containing a list of coordinates as dictionaries.

figgo.Figure, optional

An existing plotly figure to add to, by default None

namestr | None, optional

The name to assign to the detector traces, by default None

colorstr | None, optional

The color to assign to the detector traces, by default None

returns:

The plotly figure containing the footprint plot

rtype:

go.Figure