BatSurveyTemporalFinder

class gdt.missions.swift.bat.finders.BatSurveyTemporalFinder(tstart, tstop=None)

Bases: SwiftTemporalFinder

Find Swift BAT survey 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_survey(download_dir, **kwargs)	Download the survey detector plane histogram files.
ls_survey()	List the survey detector plane histogram files.

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_survey(download_dir, **kwargs)

Download the survey detector plane histogram files.

Parameters:

• download_dir (str) – The download directory

• verbose (bool, optional) – If True, will output the download status.

Returns:

(list) – The file paths of the downloaded files

ls_survey()

List the survey detector plane histogram files.

Returns:

(list of str)