TriggerCatalog

class gdt.missions.gifts.catalogs.TriggerCatalog(catalog_type: str = 'triggers', config: str = None, _base_cache_path: str = './giftscache', _catalog_archive_url: str = 'simplecache://::https://zenodo.org/records/17295200/files/gifts_bursts_catalog_v0_1_0.tar.gz')

Bases: Catalog

GIFTS catalog for triggers

Attributes Summary

catalog
catalog_type
columns	The names of the columns available in the catalog
config
num_columns	The total number of columns (fields) in the catalog
num_rows	The total number of rows in the catalog

Methods Summary

column_range(column)	Return the data range for a specified column, in the form of (low, high).
get_healpix(trigger_name)	Retrieve and open a localization HEALPix product.
get_table([columns])	TODO Return the table data as a numpy record array.
get_tcat(trigger_name)	Retrieve and open a Tcat product.
get_trigdat(trigger_name)	Retrieve and open a Trigdat product.
get_tte(trigger_name)	Retrieve and open TTE products.
to_dataframe()	Returns a copy of the catalog as a Pandas DataFrame, which can be used for subsequent slicing/filtering operations.

Attributes Documentation

catalog: DataFrame = None

catalog_type: str = 'triggers'

columns

The names of the columns available in the catalog

config: str = None

num_columns

The total number of columns (fields) in the catalog

num_rows

The total number of rows in the catalog

Methods Documentation

column_range(column: str) → tuple

Return the data range for a specified column, in the form of (low, high).

Parameters:

column – The column name

Returns:

Tuple containg low (min) and high (max) values

get_healpix(trigger_name: str) → GiftsHealPix

Retrieve and open a localization HEALPix product.

Parameters:

trigger_name – required trigger/burst

Returns:

GiftsHealPix product

get_table(columns: List[str] = None) → recarray

TODO Return the table data as a numpy record array.

Parameters:

columns (list of str, optional) – The columns to return. If omitted, returns all columns.

Returns:

(np.recarray)

get_tcat(trigger_name: str) → Tcat

Retrieve and open a Tcat product.

Parameters:

trigger_name – required trigger/burst

Returns:

GIFTS Tcat

get_trigdat(trigger_name: str) → Trigdat

Retrieve and open a Trigdat product.

Parameters:

trigger_name – required trigger/burst

Returns:

GIFTS Trigdat

get_tte(trigger_name: str) → List[GiftsTte]

Retrieve and open TTE products.

Parameters:

trigger_name – required trigger/burst

Returns:

List of GIFTS TTEs, one per detector.

to_dataframe() → DataFrame

Returns a copy of the catalog as a Pandas DataFrame, which can be used for subsequent slicing/filtering operations.