redback.get_data.get_bat_xrt_afterglow_data_from_swift

redback.get_data.get_bat_xrt_afterglow_data_from_swift(grb: str, data_mode: str, snr: int | str = 4, force_download: bool = False, **kwargs: None) → DataFrame[source]

Get BAT+XRT afterglow data from Swift. Creates a directory structure and saves the data. Returns the data, though no further action needs to be taken by the user.

Parameters:

  • grb (str) – Telephone number of GRB, e.g., ‘GRB140903A’ or ‘140903A’ are valid inputs.

  • data_mode (str) – Data mode must be from redback.get_data.swift.SwiftDataGetter.VALID_DATA_MODES.

  • snr (int or str) – BAT Burst Analyser SNR choice (e.g., 4, 5, 6, 7).

  • force_download (bool, optional) – If True, re-download data from API even if cached files exist. (Default value = False)

  • kwargs (dict) – Placeholder to prevent TypeErrors.

Returns:

The processed data.

Return type:

pandas.DataFrame