across.client.apis.tools

Classes

VisibilityCalculator

Client for interacting with Visibility Calculator resources in the Across API.

Module Contents

class VisibilityCalculator(across_client: across.sdk.v1.api_client_wrapper.ApiClientWrapper)[source]

Client for interacting with Visibility Calculator resources in the Across API.

Provides methods to calculate individual instrument visibility windows by instrument ID.

across_client[source]
calculate_windows(instrument_id: str, ra: float | int, dec: float | int, date_range_begin: datetime.datetime, date_range_end: datetime.datetime, hi_res: bool | None = None, min_visibility_duration: int | None = None) → across.sdk.v1.VisibilityResult[source]

Retrieve visibility windows for a target and a single instrument.

Parameters:

  • instrument_id (str) – The unique identifier of the instrument in the ACROSS core-server.

  • ra (float | int) – The Right Ascension of the target.

  • dec (float | int) – The Declination of the target.

  • date_range_begin (datetime) – The beginning of the date range to calculate the visibility windows.

  • date_range_end (datetime) – The end of the date range to calculate the visibility windows.

  • hi_res (bool | None, optional) – Flag to calculate high resolution windows (default is False)

  • min_visibility_duration (int | None, optional) – The minimum duration visibility windows to return, in seconds (default is 0).

Returns:

The requested visibility windows.

Return type:

sdk.VisibilityResult

calculate_joint_windows(instrument_ids: list[str | None], ra: float | int, dec: float | int, date_range_begin: datetime.datetime, date_range_end: datetime.datetime, hi_res: bool | None = None, min_visibility_duration: int | None = None) → across.sdk.v1.JointVisibilityResult[source]

Retrieve joint visibility windows for a target and multiple instruments.

Parameters:

  • instrument_ids (list[str]) – List of unique identifiers of the instruments in the ACROSS core-server.

  • ra (float | int) – The Right Ascension of the target.

  • dec (float | int) – The Declination of the target.

  • date_range_begin (datetime) – The beginning of the date range to calculate the visibility windows.

  • date_range_end (datetime) – The end of the date range to calculate the visibility windows.

  • hi_res (bool | None, optional) – Flag to calculate high resolution windows (default is False)

  • min_visibility_duration (int | None, optional) – The minimum duration visibility windows to return, in seconds (default is 0).

Returns:

The requested visibility windows.

Return type:

sdk.VisibilityResult