PipelineConfiguration

class PipelineConfiguration(version)[source]

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(version, …[, …])
param version:pipeline version to determine which deconv and simu module to use [‘1’ or ‘1.1’]
create_name() build the name of the pipeline, including the version

Methods Documentation

build_bube_config(energy_ranges)[source]
Parameters:energy_ranges ([[int, int]]) – different energy ranges (in PI) to extract the images [[low_energy, high_energy],[]]
build_imag_config(version, src_subimage_size, snr_limit, ref_catalog_fov=None, off_axis=None)[source]
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
create_name()[source]

build the name of the pipeline, including the version

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