ImagConfiguration

class ImagConfiguration(dict_imag_cfg, ref_catalog_fov=None)

Bases: object

configuration parameters and modules for the IMAG process

version:

• 1 = Deconv, SimuECLAIRsRayTracing
• 1.1 = Deconv, SimuECLAIRsMaskProjection

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

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

Methods Summary

build()	build the configuration: modules and parameters
check_fit_function(fit_function)	check if the specified fit_function parameter
check_fit_sigma(fit_sigma)	check if the specified sigma value is relevant.
check_snr_limit(snr_limit)	check the snr limit parameter
check_src_subimage_size(src_subimage_size)	check the src_subimage_size parameter
create_deconv_module()	build the deconvolution module to use in IMAG
create_simu_module()	build the simulation module to use in IMAG
create_source_finder_module()	build the source finder module to use in IMAG

Methods Documentation

build()

build the configuration: modules and parameters

check_fit_function(fit_function)

check if the specified fit_function parameter belongs to the list of accepted functions.

Parameters:fit_function (string) – function to fit the precise source location. Returns:fit_function Return type:function in num.gauss_tools

check_fit_sigma(fit_sigma)

check if the specified sigma value is relevant.

Parameters:fit_sigma (float>0) – standard deviation of the gaussian fit_function. Default is 1.555.

check_snr_limit(snr_limit)

check the snr limit parameter

check if snr_limit > 0

Parameters:snr_limit (any (should be float)) – snr limit to stop at the source detection algorithm Returns:snr_limit Return type:float

check_src_subimage_size(src_subimage_size)

check the src_subimage_size parameter

check if src_subimage_size > 0

Parameters:src_subimage_size (any (should be int)) – nb of pixels around the detected source (radius) kept in the final sky image Returns:src_subimage_size Return type:float

create_deconv_module()

build the deconvolution module to use in IMAG

create_simu_module()

build the simulation module to use in IMAG

simulation module : SimuInstruX_base

create_source_finder_module()

build the source finder module to use in IMAG

Warning

not implemented yet