BurstCatalog¶

class gdt.missions.fermi.gbm.catalogs.BurstCatalog(cache_path='/home/docs/.gammaray_data_tools/2.2.2/cache/fermigbm', **kwargs)[source]¶

Class that interfaces with the GBM Burst Catalog via HEASARC Browse.

Parameters:

cache_path (str) – The path where the cached catalog will live.
cached (bool, optional) – Set to True to read from the cached file instead of querying HEASARC. Default is False.
verbose (bool, optional) – Default is True

Attributes Summary

`columns`	The names of the columns available in the table
`num_cols`	The total number of columns (fields) in the data table
`num_rows`	The total number of rows in the data table

Methods Summary

`column_range`(column)	Return the data range for a given column, in the form of (low, high).
`get_table`([columns])	Return the table data as a numpy record array.
`slice`(column[, lo, hi])	Perform row slices of the data table based on a conditional of a single column.
`slices`(columns)	Perform row slices of the data table based on a conditional of multiple columns.

Attributes Documentation

columns¶

The names of the columns available in the table

num_cols¶

The total number of columns (fields) in the data table

num_rows¶

The total number of rows in the data table

Methods Documentation

column_range(column)¶

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

get_table(columns=None)¶

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)

slice(column, lo=None, hi=None)¶

Perform row slices of the data table based on a conditional of a single column. Returns a new BrowseCatalog object.

Parameters:

column (str) – The column name
lo (optional) – The minimum (inclusive) value of the slice. If not set, uses the lowest range of the data in the column.
hi (optional) – The maximum (inclusive) value of the slice. If not set, uses the highest range of the data in the column.

Returns:

(BrowseCatalog)

slices(columns)¶

Perform row slices of the data table based on a conditional of multiple columns. Returns a new BrowseCatalog object.

Parameters:: columns (list of tuples) – A list of tuples, where each tuple is (column, lo, hi). The ‘column’ is the column name, ‘lo’ is the lowest bounding value, and ‘hi’ is the highest bouding value. If no low or high bounding is desired, set to None. See slice() for more info.
Returns:: (BrowseCatalog)