BatseTteMulti

class gdt.missions.cgro.batse.tte.BatseTteMulti

Bases: FitsFileContextManager

BATSE data containing TTE from multiple detectors.

Attributes Summary

detectors	The detectors in the file
filename	The filename
hdulist	The list of Header Data Units
headers	The headers
num_dets	Number of detectors in the file
num_hdus	The number of HDUs

Methods Summary

close()	Close the file
column(hdu_num, col_name)	Return a column from an HDU as an array.
columns_as_array(hdu_num, col_names[, dtype])	Return a list of columns from an HDU as an array.
get_column_names(hdu_num)	Get the column names in a HDU.
get_detector(det_var)	Retrieve the Tte object for the given detector.
open(file_path, **kwargs)	Open a BATSE file containing TTE time series from multiple detectors.
sum_detectors([det_var_list])	Sum data over multiple detectors and return a Tte object.
write(directory[, filename])	Write the file to disk.

Attributes Documentation

detectors

The detectors in the file

Type:

(list)

filename

The filename

Type:

(str)

hdulist

The list of Header Data Units

Type:

(astropy.io.fits.hdu.HDUList)

headers

The headers

Type:

(FileHeaders)

num_dets

Number of detectors in the file

Type:

(int)

num_hdus

The number of HDUs

Type:

(int)

Methods Documentation

close()

Close the file

column(hdu_num: int, col_name: str) → array

Return a column from an HDU as an array.

Parameters:

• hdu_num (int) – The HDU number

• col_name (str) – The name of the column

Returns:

(np.array)

columns_as_array(hdu_num: int, col_names: List[str], dtype: dtype = None) → array

Return a list of columns from an HDU as an array.

Parameters:

• hdu_num (int) – The HDU number

• col_names (list of str) – The names of the columns

• dtype (np.dtype, optional) – The custom dtype of the output array

Returns:

(np.array)

get_column_names(hdu_num: int)

Get the column names in a HDU. Returns empty if there is no data extension in the HDU.

Parameters:

hdu_num (int) – The HDU number

Returns:

(tuple)

get_detector(det_var)

Retrieve the Tte object for the given detector.

Parameters:

det_var (str, int, or BatseDetectors) –

Returns:

(BatseTteTrigger`)

classmethod open(file_path, **kwargs)

Open a BATSE file containing TTE time series from multiple detectors.

Parameters:

file_path (str) – The file path

Returns:

(BatseTteMulti)

sum_detectors(det_var_list=None)

Sum data over multiple detectors and return a Tte object.

Note::

The energy edges are taken to be the geometric mean.

Parameters:

det_var_list (list of str, int, or BatseDetectors, optional) – If not set, will sum all available detectors.

Returns:

(BatseTteTrigger`)

write(directory: Union[str, Path], filename: str = None, **kwargs)

Write the file to disk.

Parameters:

• directory (str) – The directory to write the file.

• filename (str, optional) – The filename. If omitted, attempts to use the filename if set.