MaxiAuxilFinder

class gdt.missions.maxi.finders.MaxiAuxilFinder(*args, protocol='HTTPS', **kwargs)

Bases: MaxiFinder

Finder for MAXI auxiliary data files.

Attributes Summary

cwd
files	The list of files in the current directory
num_files	Number of files in the current directory

Methods Summary

cd(time)	Set the time.
filter(filetype, extension)	Filters the directory for the requested filetype and extension
get(download_dir, files[, verbose])	Downloads a list of files from the current FTP directory.
get_attitude(download_dir, **kwargs)	Download the MAXI attitude file for the day.
get_gti_low(download_dir[, dets])	Download the MAXI low-bitrate GTI files for the day.
get_gti_med(download_dir[, dets])	Download the MAXI medium-bitrate GTI files for the day.
get_orbit(download_dir, **kwargs)	Download the MAXI orbit file for the day.
ls(*args[, fullpath])	List the contents of a directory
ls_attitude()	List the MAXI attitude file for the day.
ls_gti_low()	List the MAXI GSC low-bitrate GTI files for the day.
ls_gti_med()	List the MAXI GSC medium-bitrate GTI files for the day.
ls_orbit()	List the MAXI orbit file for the day.

Attributes Documentation

cwd

files

The list of files in the current directory

Type:

(list of str)

num_files

Number of files in the current directory

Type:

(int)

Methods Documentation

cd(time)

Set the time. If the object was previously associated with a different time, this will effectively change the working directory to that of the new time. If the time is invalid, an exception will be raised, and no directory change will be made.

Parameters:

time (astropy.time.Time, optional) – The time object

filter(filetype, extension)

Filters the directory 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: str | Path, files: List[str], verbose: bool = True) → List[Path]

Downloads a list of files from the current FTP directory. This function also returns a list of the downloaded file paths.

Parameters:

• download_dir (str, Path) – The download directory location

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

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

Returns:

(list)

get_attitude(download_dir, **kwargs)

Download the MAXI attitude file for the day.

Parameters:

• download_dir (str) – The download directory

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

Returns:

(list) – The filenames of the downloaded files

get_gti_low(download_dir, dets=None, **kwargs)

Download the MAXI low-bitrate GTI files for the day.

Parameters:

• download_dir (str) – The download directory

• dets – The detectors’ data to download. If omitted, will download all.

Returns:

(list) – The filenames of the downloaded files

get_gti_med(download_dir, dets=None, **kwargs)

Download the MAXI medium-bitrate GTI files for the day.

Parameters:

• download_dir (str) – The download directory

• dets – The detectors’ data to download. If omitted, will download all.

Returns:

(list) – The filenames of the downloaded files

get_orbit(download_dir, **kwargs)

Download the MAXI orbit file for the day.

Parameters:

• download_dir (str) – The download directory

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

Returns:

(list) – The filenames of the downloaded files

ls(*args, fullpath: bool = False)

List the contents of a directory

Parameters:

• args (tuple) – The arguments needed to construct the remote path

• fullpath (bool, optional) – If True, will list all files in the current with their full path.

ls_attitude()

List the MAXI attitude file for the day.

Returns:

(list of str)

ls_gti_low()

List the MAXI GSC low-bitrate GTI files for the day.

Returns:

(list of str)

ls_gti_med()

List the MAXI GSC medium-bitrate GTI files for the day.

Returns:

(list of str)

ls_orbit()

List the MAXI orbit file for the day.

Returns:

(list of str)