ecpi.process.bube.core.main_bube module

Section author: ECLAIRs GP team

BUBE implementation, no file access, only memory Background correction, Earth Occultation Correction module

This component shall perform the following tasks:

  • Select the calibrated events based on scientific input parameters for this component.

  • Bin the selected calibrated events in detector images, for a set of given energy ranges and within a set of time intervals.

  • Create and associate the proper efficiency detector images based on the pixel life-time information.

  • Prepare uniformity and background images based on the same selection/binning parameters of the detector images.

  • Apply a non-uniformity correction and a background model subtraction to the binned detector images. The background model shall include the CXB contribution, the particle induced background and the Earth albedo contribution.

  • Apply a “correction” for the Earth Occultation effect in order to take into account the partial and variable occultation of the ECLAIRs field of view by the Earth. The earth passage in the FOV shall be included in the computation of the background model.

  • Possibly take in account (by modeling) bright source contribution at this stage (TBD). In this case input catalog will be needed (not mentioned in the input section).

Summary

Functions:

bube

BUBE module - dynamic mode

dynamic_bube

BUBE module - dynamic mode

process_bube

param gti

stack_images

param data_out

static_bube

BUBE module - static mode

Reference

bube(df_data, d_pars)[source]

BUBE module - dynamic mode

Bin the selected calibrated events in detector images, within a set of time intervals.

error_code =

  • ‘OK’ if everything was fine

  • ‘BubeError’ if an error occur

dynamic_bube(df_data, d_pars)[source]

BUBE module - dynamic mode

Parameters

df_data (DataFlow instance) – dictionnary with all necessary parameters to run BUBE pipeline. Contains keys enery_ranges, bkg_correction_mode, events and pvtatt.

Returns

detector_shadowgrams, error_code, error_message

Return type

DetectorImages, string, string

process_bube(gti, gti_name, cor_mod, bube_handler, secl)[source]
Parameters

  • gti –

  • gti_name –

  • cor_mod –

  • bube_handler –

  • secl –

Type

gti:

Type

gti_name:

Type

cor_mod:

Type

bube_handler:

Type

secl:

Returns

stack_images(data_out, d_pars)[source]
Parameters

  • data_out –

  • d_pars –

Type

data_out:

Type

d_pars:

Returns

static_bube(df_data, d_pars)[source]

BUBE module - static mode

Bin the selected calibrated events in detector images, within a set of time intervals.

error_code =

  • ‘OK’ if everything was fine

  • ‘BubeError’ if an error occur