ecpi.pipeline.io.gti_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. AttPvtFlow 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:

GtiFlow

Class diagram:

Functions:

intersects_gti	Computes the intersection of 2 GTI (defined as sorted numpy arrays).
union	Computes the union of two gtis :param gtia: first gti to combine :type gtia: numpy.ndarray :param gtib: second gti to combine :type gtib: numpy.ndarray :return: gti_union: final gti made by the union of the two input gtis :rtype: gti_union: numpy.ndarray

Reference

class GtiFlow

Bases: object

compute_earth_gtis(t_orb, peof_min, peof_max)

Parameters

• t_orb (table) –

• peof_min (float) –

• peof_max (float) –

Returns

intersect_gtis(in_gti='')

Computes the intersection of a earth gti with the dpco basic gtis. :param in_gti: :type in_gti: string :return:

join_gti(gtia, gtib)

Computes the union of two gtis :param gtia: :param gtib: :return:

set_basic_gtis(gtis)

Parameters

gtis (dictionnary) –

Returns

set_earth_gtis(gtis, exist_ok=False)

Parameters

• gtis (dictionnary) –

• exist_ok (boolean) –

Returns

set_gti_types(gti_types)

Parameters

gti_types (dictionnary) – dict of different possible gtis

Returns

set_user_gtis(gtis)

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

show_gtis()

Returns

intersects_gti(gti_a, gti_b)

Computes the intersection of 2 GTI (defined as sorted numpy arrays). Returns the intersected array. :param gtia: first gti to be intersect :type gtia: numpy.ndarray :param gtib: second gti to be intersect :type gtib: numpy.ndarray :return: gti_intersection: intersection of the two input gtis :rtype gti_intersection: numpy.ndarray

union(gtia, gtib)

Computes the union of two gtis :param gtia: first gti to combine :type gtia: numpy.ndarray :param gtib: second gti to combine :type gtib: numpy.ndarray :return: gti_union: final gti made by the union of the two input gtis :rtype: gti_union: numpy.ndarray