ecpi.pipeline.io.data_flow module

Section author: ECLAIRs GP team

Data Flow is the layer for transmitting the data along the ECPI pipeline. Data Flow is a class containing four different classes each one for a particular type of data to be transmitted A) GtiFlow concerns all the information and functionality

related to the Good Time Intervals.

2. AavPvtFlow concerns the information about the orbit and

   the attitude of the satellite.

3. EventFlow concerns the events and the different type

   of related objects

4. DetImagFlow concerns the detector images and its

   different representations

All these objects are grouped in a global container which becomes the data_flow layer in the main pipeline.

Summary

Classes:

DataFlow	Scientific Data Products and its component
DetImagFlow	Detector images and representations
EventFlow	Events and related objects

Class diagram:

Reference

class DataFlow(load_kws=True, only_check=False)

Bases: object

Scientific Data Products and its component

comp_by_prod = {'ecl-det-ima': 'bube', 'ecl-det-mod': 'imag', 'ecl-det-ubc': 'bube', 'ecl-evs-soe': 'spex', 'ecl-evt-cal': 'cali', 'ecl-evt-cor': 'dpco', 'ecl-gti-1': 'dpco', 'ecl-gti-2': 'cali', 'ecl-gti-3': 'bube', 'ecl-lcs-soe': 'spex', 'ecl-pix-lif': 'dpco', 'ecl-sky-ima': 'imag', 'ecl-sky-mos': 'mosa', 'ecl-sop-ima': 'imag', 'ecl-sop-mos': 'mosa', 'ecl-sps-soe': 'spex'}

compute_earth_gtis(peof_min, peof_max)

Parameters

• peof_min (float) –

• peof_max (float) –

Returns

compute_ptgori_mean()

Returns

get_aav_size()

Returns

get_eof_table()

Returns

get_index_by_time(time)

Parameters

time –

Returns

get_ptgori_mean()

Returns

get_pvt_time_column()

Returns

get_sdp_data(sdp_name)

Parameters

sdp_name (string) –

Returns

get_t_start()

Returns

get_t_stop()

Returns

get_time_by_index(idx)

Parameters

idx (integer) –

Returns

intersect_gtis(gti='')

Parameters

gti (string) –

Returns

is_ready(c_name)

Parameters

c_name (string) –

Returns

load_common_keywords()

Returns

load_detector_effect_from_dir(caldb_dir)

Parameters

caldb_dir (string) –

Returns

set_aav_pvt(t_aav, t_pvt, compute_eof=False)

Parameters

• t_aav (table) –

• t_pvt (table) –

• compute_eof (boolean) –

Returns

set_basic_gtis(d_gtis)

Parameters

d_gtis (dictionnary) – good time intervals

Returns

set_det_images(det_images_by_gti)

Parameters

det_images_by_gti (dictionnary) –

Returns

set_detector_effect(detector_effect=None)

Parameters

detector_effect (instance of ECLAIRsDetectorEffectDefault) –

Returns

set_earth_gtis(d_gtis, exist_ok=False)

Parameters

• d_gtis (dictionnary) – good time intervals

• exist_ok (boolean) –

Returns

set_eof(t_eof)

Parameters

t_eof (table) – table of Earth occultation fractions

Returns

set_events(events)

Parameters

events (instance of EclairsCalEvtData) –

Returns

Return type

set_imag_output(d_sky_images_by_gti)

Parameters

d_sky_images_by_gti (dictionnary) –

Returns

set_pi_vector(pi_vect)

Parameters

pi_vect (numpy.ndarray) –

Returns

set_user_gtis(d_gtis)

User gtis can be given with arbitrary bounds and a preliminary check is made for setting in the right decimation :param d_gtis: good time intervals :type d_gtis: dictionnary :return:

show_common_keywords(lim=- 1)

Parameters

lim (integer) –

Returns

show_gtis()

Returns

class DetImagFlow

Bases: object

Detector images and representations

class EventFlow

Bases: object

Events and related objects

set_events(events)

Parameters

events (instance of EclairsCalEvtData) –

Returns

Return type

boolean