ImagConfiguration

class ImagConfiguration(version, src_subimage_size, snr_limit, ref_catalog_fov=None, off_axis=None)

Bases: object

configuration parameters and modules for the IMAG process

version:

• 1 = DeconvV1, SimuECLAIRsRayTracing
• 1.1 = DeconvV1, SimuECLAIRsMaskProjection

constructor

Parameters:

• version (string) – pipeline version to determine which deconv and simu module to use [‘1’ or ‘1.1’]
• src_subimage_size (int) – nb of pixels around the detected source (radius) kept in the final sky image
• snr_limit (float >0) – snr limit to stop at the source detection algorithm
• ref_catalog_fov (CatalogFOV_ECLAIRs) – FOV x-ray sources reference catalog (default=None)
• off_axis (None, cos_theta or irf) – off axis correction. Default=None

Methods Summary

build()	build the configuration: modules and parameters
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_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:snr_limit 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