BatTriggerTemporalFinder

class gdt.missions.swift.bat.finders.BatTriggerTemporalFinder(tstart, tstop=None)[source]

Bases: SwiftTemporalFinder

Find Swift BAT triggered data that covers a given time or time range.

See SwiftTemporalFinder for details on how this class works.

Parameters:
  • tstart (astropy.Time) – A time of interest or start time for a time range of interest

  • tstop (astropy.Time, optional) – The stop time for a time range of interest.

Attributes Summary

cwd

The current working directory for each observation ID

files

The files that might contain data during the time or time range of interest

num_files

Number of files

Methods Summary

cd(tstart[, tstop])

Changes the directories based on a time or time range of interest.

filter(filetype, extension)

Filters the directories for the requested filetype and extension

get(download_dir, files[, verbose])

Downloads files to a directory and returns the downloaded file paths

get_afterslew(download_dir, **kwargs)

Download the afterslew files.

get_all(download_dir, **kwargs)

Download all files.

get_gti(download_dir, **kwargs)

Download the GTI data.

get_lightcurve(download_dir, **kwargs)

Download the lightcurve data.

get_peak(download_dir, **kwargs)

Download the peak intensity files.

get_preslew(download_dir, **kwargs)

Download the preslew files.

get_quicklook(download_dir, **kwargs)

Download the quicklook images (typically lightcurve and sky image).

get_slew(download_dir, **kwargs)

Download the files during slew.

ls_afterslew()

List the after-slew files available.

ls_gti()

List the GTI files available.

ls_lightcurve()

List the lightcurve data available.

ls_peak()

List the files at peak intensity that are available.

ls_preslew()

List the pre-slew files available.

ls_quicklook()

List the quicklook images available (typically lightcurve and sky image).

ls_slew()

List the files during slew that are available.

Attributes Documentation

cwd

The current working directory for each observation ID

Type:

(list)

files

The files that might contain data during the time or time range of interest

Type:

(list)

num_files

Number of files

Type:

(int)

Methods Documentation

cd(tstart, tstop=None)

Changes the directories based on a time or time range of interest.

Parameters:
  • tstart (astropy.Time) – A time of interest or start time for a time range of interest

  • tstop (astropy.Time, optional) – The stop time for a time range of interest.

filter(filetype, extension)

Filters the directories for the requested filetype and extension

Parameters:
  • filetype (str) – The type of file, e.g. ‘cspec’

  • extension (str) – The file extension, e.g. ‘.pha’

Returns:

(list)

get(download_dir, files, verbose=True)

Downloads files to a directory and returns the downloaded file paths

Parameters:
  • download_dir (str) – The download directory

  • files (list) – The list of files to download

  • verbose (bool, optional) – Set to False to turn off download status

Returns:

(list) – The downloaded file paths

get_afterslew(download_dir, **kwargs)[source]

Download the afterslew files.

Returns:

(list) – The file paths of the downloaded files

get_all(download_dir, **kwargs)[source]

Download all files.

Returns:

(list) – The file paths of the downloaded files

get_gti(download_dir, **kwargs)[source]

Download the GTI data.

Returns:

(list) – The file paths of the downloaded files

get_lightcurve(download_dir, **kwargs)[source]

Download the lightcurve data.

Returns:

(list) – The file paths of the downloaded files

get_peak(download_dir, **kwargs)[source]

Download the peak intensity files.

Returns:

(list) – The file paths of the downloaded files

get_preslew(download_dir, **kwargs)[source]

Download the preslew files.

Returns:

(list) – The file paths of the downloaded files

get_quicklook(download_dir, **kwargs)[source]

Download the quicklook images (typically lightcurve and sky image).

Returns:

(list) – The file paths of the downloaded files

get_slew(download_dir, **kwargs)[source]

Download the files during slew.

Returns:

(list) – The file paths of the downloaded files

ls_afterslew()[source]

List the after-slew files available.

Returns:

(list of str)

ls_gti()[source]

List the GTI files available.

Returns:

(list of str)

ls_lightcurve()[source]

List the lightcurve data available.

Returns:

(list of str)

ls_peak()[source]

List the files at peak intensity that are available.

Returns:

(list of str)

ls_preslew()[source]

List the pre-slew files available.

Returns:

(list of str)

ls_quicklook()[source]

List the quicklook images available (typically lightcurve and sky image).

Returns:

(list of str)

ls_slew()[source]

List the files during slew that are available.

Returns:

(list of str)