across.client.apis.filter

Classes

Filter

Client for interacting with Filter resources in the Across API.

Module Contents

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

Client for interacting with Filter resources in the Across API.

Provides methods to retrieve single or multiple filters by ID, name, wavelength, or instrument information.

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

Retrieve a single Filter by ID.

Parameters:

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

Returns:

The requested Filter object.

Return type:

sdk.Filter

get_many(name: str | None = None, covers_wavelength: float | None = None, instrument_name: str | None = None, instrument_id: str | None = None) → list[across.sdk.v1.Filter][source]

Retrieve multiple filters filtered by optional criteria.

Parameters:

  • name (str | None, optional) – Filter by filter name.

  • covers_wavelength (float | none, optional) – Filter by filters that contain wavelength value.

  • instrument_name (str | None, optional) – Filter by telescinstrumentope name.

  • instrument_id (str | None, optional) – Filter by instrument ID.

Returns:

A list of filters matching the given filters.

Return type:

list[sdk.Filter]