ecpi.database.interact_sdb module

Section author: ECLAIRs GP team

SDB interface

Summary

Classes:

SdbParameters

#TODO: may be simpler solution can be used than a singleton

Class diagram:

Functions:

download_name	param f_name
download_url_and_rename	return if the operation succeeded
extract_type	from ECL-EVT-CAL_UTCtotootxxx.fits extract ECL-EVT-CAL
find_name_last_download	param obs_id
get_url_query	return url SDB query
get_url_with_namefile	param n_file
ping_sdb	Ping SDB server.
receive_event_att_files	Receive event ECL-EVT-SEC_XXX.fits or SVO-ATT-CNV_XXX.fits files from the SDB.
send_product_ecpi	Send L1 product generated by the ECLAIRs pipeline to the SDB.

Reference

class SdbParameters(*args, **kargs)

Bases: object

#TODO: may be simpler solution can be used than a singleton

instance = None

download_name(f_name, dest_dir, type_obj='')

Parameters

• f_name –

• dest_dir –

• type_obj –

download_url_and_rename(url_file, dest_dir, new_name='')

Returns

if the operation succeeded

Return type

bool

extract_type(n_file)

from ECL-EVT-CAL_UTCtotootxxx.fits extract ECL-EVT-CAL

Parameters

n_file –

find_name_last_download(obs_id, type_obj)

Parameters

• obs_id –

• type_obj –

get_url_query()

return url SDB query

get_url_with_namefile(n_file, prod_acronyme='', level_obj='l1')

Parameters

• n_file –

• prod_acronyme –

• level_obj –

ping_sdb(count=2)

Ping SDB server.

receive_event_att_files(sdb_filename, dest_dir)

Receive event ECL-EVT-SEC_XXX.fits or SVO-ATT-CNV_XXX.fits files from the SDB.

Parameters

• sdb_filename (str) – name of file to be downloaded from SDB

• dest_dir (str) – path of the destination directory

Returns

if the operation succeeded

Return type

bool

send_product_ecpi(path_product)

Send L1 product generated by the ECLAIRs pipeline to the SDB.

Check if input file has registered CARD KW value for DC1: ECL-SKY-IMA, ECL-SOP-IMA, ECL-DET-UBC and ECL-EVT-CAL.

Parameters

path_product (str) – path to the .fits file to be sent.

Returns

if the operation succeeded

Return type

bool