PipelineConfiguration

class PipelineConfiguration(version)

Bases: object

configuration parameters and modules for the pipeline

constructor

Parameters:version (string) – pipeline version to determine which deconv and simu module to use [‘1’ or ‘1.1’]

Methods Summary

build_bube_config(energy_ranges, …)	param energy_ranges:  different energy ranges (in PI) to extract the images [[low_energy, high_energy],[]]
build_imag_config(dict_imag_cfg[, …])	param dict_imag_cfg:  dictionary containing the config parameters for IMAG. Values description below.
create_name()	build the name of the pipeline, including the version

Methods Documentation

build_bube_config(energy_ranges, bkg_correction_mode)

Parameters:energy_ranges ([[int, int]]) – different energy ranges (in PI) to extract the images [[low_energy, high_energy],[]]

build_imag_config(dict_imag_cfg, ref_catalog_fov=None)

Parameters:

• dict_imag_cfg (dict) – dictionary containing the config parameters for IMAG. Values description below.
• ref_catalog_fov (CatalogFOV_ECLAIRs.) – FOV x-ray sources reference catalog (default=None)

Variables:

• version – pipeline version to determine which deconv and simu module to use [‘1’ or ‘1.1’]
• src_subimage_size – nb of pixels around the detected source (radius) kept in the final sky image
• snr_limit – snr limit to stop at the source detection algorithm
• fit_function – function to fit the precise source location.
• fit_sigma – standard deviation of the gaussian fit_function. Default is 1.555.
• off_axis – off axis correction. Default=None

create_name()

build the name of the pipeline, including the version

name of the pipeline = “ECLAIRs pipeline v” + self.version