DetectorImages

class DetectorImages(shadowgrams, shadowgrams_var, obs_time, energy_ranges)[source]

Bases: object

build and save detector images for a defined observation time

constructor

Parameters:
  • shadowgrams (list(2D array)) – detector images
  • shadowgrams_var (list(2D array)) – detector variance images
  • obs_time (float) – observation time in s
  • energy_ranges – different energy ranges (in PI) to extract

the images [[low_energy, high_energy],[]] :type energy_ranges: [[int, int]]

Methods Summary

background_correction(mode) Apply background correction on shadowgrams.
background_nonuniformity_correction([…]) Correct background non uniformity using the pixel detector efficiencies.
get_shadowgrams() Return attribute shadowgrams corrected
get_shadowgrams_var() Return attribute shadowgrams_var
shapebased_background_correction([enable_arf]) Correct the shadowgrams from a CXB shape read from a pixel solid angle file.

Methods Documentation

background_correction(mode)[source]

Apply background correction on shadowgrams.

Parameters:mode – CXB background correction mode.

Choices are ‘no_correction’ or ‘shape_based’ :type mode: str

background_nonuniformity_correction(efficiency_filename='/home/user/projet/ECLAIRs/ecpi/common/data/instru/efficiency_matrix.fits', nonunif_filename='/home/user/projet/ECLAIRs/ecpi/common/data/instru/non_uniformity_matrix.fits')[source]

Correct background non uniformity using the pixel detector efficiencies.

..warning: it is assumed the global_efficiency matrix is the same for every channel !

Parameters:
  • efficiency_filename (string) – PATH/filename of the detector efficiency array
  • nonunif_filename (string) – PATH/filename of the detector non-uniformity array
get_shadowgrams()[source]

Return attribute shadowgrams corrected

get_shadowgrams_var()[source]

Return attribute shadowgrams_var

shapebased_background_correction(enable_arf=True)[source]

Correct the shadowgrams from a CXB shape read from a pixel solid angle file.

Note

enable_arf option is necessary for testing purposes

(cf. test_BubeProcesses/test_shapebasedbackgroundcorrection)

Parameters:enable_arf (bool) – whether or not to multiply par ARF in BKG subtraction. Default is True.