ecpi.process.bube.core.main_bube Module

Selection and Binning, Uniformity and 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).

Functions

Pool Returns a process pool object
add_path_data_ref_eclairs(p_file) add to p_file the path of the ECLAIRs data directory.
bube(cal_evts, obs, config) BUBE module
compute_global_efficiency([…]) Computes the global efficiency matrix Eg as defined in appendix B of ADD for the correction of background non uniformity.
compute_solid_angle([mask_filename]) Compute solid angle matrix from the mask and detector geometry.
solidangle_rectangle_ana Compute the solid angle subtended by a rectangle of length a and b as seen by an observer located at (xp,yp,zp).

Classes

BubeConfiguration(energy_ranges, …) configuration parameters and modules for the Bube process
DetectorImages(shadowgrams, shadowgrams_var, …) build and save detector images for a defined observation time
ECLAIRsGeom() All distance are in cm
EclairsCalEvtData([nb_line]) Standard container for ECLAIRs’ calibrated event data
EclairsObservation(t_0, t_1, …) Observation of the ECLAIRs instrument
InstruECLAIRs([show, p_file_mask, p_nb_pix]) Implementation of the ECLAIRs mask geometry.
ModelCxbShapeBasedEnergy([solidangle_filename]) model for a energy dependent CXB based on the pixel solid angle shape
product product(*iterables, repeat=1) –> product object

Class diagram