across.client.apis.observation

Classes

Observation

Client for interacting with Observation resources in the Across API.

Module Contents

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

Client for interacting with Observation resources in the Across API.

Provides methods to retrieve single or multiple observations by ID, name, observation information, or creation date.

across_client[source]
get(id: str) → across.sdk.v1.Observation[source]

Retrieve a single Observation by ID.

Parameters:

id (str) – The unique identifier of the Observation to retrieve.

Returns:

The requested Observation object.

Return type:

sdk.Observation

get_many(page: int | None = None, page_limit: int | None = None, external_id: str | None = None, schedule_ids: list[str | None] | None = None, observatory_ids: list[str] | None = None, telescope_ids: list[str] | None = None, instrument_ids: list[str] | None = None, status: across.sdk.v1.ObservationStatus | None = None, proposal: str | None = None, object_name: str | None = None, date_range_begin: datetime.datetime | None = None, date_range_end: datetime.datetime | None = None, bandpass_min: float | None = None, bandpass_max: float | None = None, bandpass_type: across.sdk.v1.WavelengthBandpass | across.sdk.v1.EnergyBandpass | across.sdk.v1.FrequencyBandpass | None = None, cone_search_ra: float | None = None, cone_search_dec: float | None = None, cone_search_radius: float | None = None, type: across.sdk.v1.ObservationType | None = None, depth_value: float | None = None, depth_unit: across.sdk.v1.DepthUnit | None = None) → across.sdk.v1.PageObservation[source]

Retrieve multiple observations filtered by optional criteria.

Parameters:

  • page (int | None) – Filter by pagination page

  • page_limit (int | None) – Filter by number of records per page

  • external_id (str | None) – Filter by an external identifier.

  • schedule_ids (list[str | None] | None) – Filter by one or more schedule IDs.

  • observatory_ids (list[str] | None) – Filter by one or more observatory IDs.

  • telescope_ids (list[str] | None) – Filter by one or more telescope IDs.

  • instrument_ids (list[str] | None) – Filter by one or more instrument IDs.

  • status (sdk.ObservationStatus | None) – Filter by observation status.

  • proposal (str | None) – Filter by proposal identifier or name.

  • object_name (str | None) – Filter by target object name.

  • date_range_begin (datetime | None) – Filter for observations starting on or after this date.

  • date_range_end (datetime | None) – Filter for observations ending on or before this date.

  • bandpass_min (float | None) – Minimum bandpass value (in the unit defined by bandpass_type).

  • bandpass_max (float | None) – Maximum bandpass value (in the unit defined by bandpass_type).

  • bandpass_type (sdk.WavelengthBandpass | sdk.EnergyBandpass | sdk.FrequencyBandpass | None) – Type of bandpass measurement (wavelength, energy, or frequency).

  • cone_search_ra (float | None) – Right Ascension (RA) for cone search, in degrees.

  • cone_search_dec (float | None) – Declination (Dec) for cone search, in degrees.

  • cone_search_radius (float | None) – Search radius for cone search, in degrees.

  • type (sdk.ObservationType | None) – Filter by observation type.

  • depth_value (float | None) – Sensitivity or depth threshold value.

  • depth_unit (sdk.DepthUnit | None) – Unit for depth_value.

Returns:

A list of observations matching the given filters.

Return type:

list[sdk.Observation]