redback.get_data.directory.afterglow_directory_structure

redback.get_data.directory.afterglow_directory_structure(grb: str, data_mode: str, instrument: str = 'BAT+XRT', snr: str = None) → DirectoryStructure[source]

Provides directory structure for Swift afterglow data.

Parameters:

grb (str) – Name of the GRB, e.g. GRB123456.
data_mode (str) – Data mode.
instrument (str, optional) – Must be in [‘BAT+XRT’, ‘XRT’], default is ‘BAT+XRT’ (Default value = ‘BAT+XRT’)
snr (str, optional) – BAT SNR selection (e.g., ‘SNR4’, ‘SNR5’). If provided, included in file path. (Default value = None)

Returns:

The directory structure, with ‘directory_path’, ‘raw_file_path’, and ‘processed_file_path’

Return type:

namedtuple