BubeImag

class BubeImag(work_dir, cfg, obs, conf, proc_id)[source]

Bases: ecpi.process.pipeline.ecpi_flows.WorkFlow

find sources in the evts between start_time and end_time

Class to process the pipeline finding sources during a stable pointing observation. Save a catalog of the detected x-ray sources.

Constructor

get the different parameters used by the process. check the validity of the parameters. construct the right deconvolution module for the process.

param work_dir:working directory where to save scientific products
param cfg:pipeline input configuration
param obs:observation parameters
param conf:pipeline config
param proc_id:id number of the process
type work_dir:string (absolute path)
type cfg:ConfigParser print(cfg[‘general’][‘snr_limit’])
print(cvb)
type obs:EclairsObservation
type conf:PipelineConfiguration
type proc_id:string

Methods Summary

check_input_dir(cfg, proc_id) check the working directory parameter
check_work_dir(work_dir) check the working directory parameter
is_ok() answer to the question if the pipeline status is ‘OK’
run([show, verbose]) main process
set_snr_limit(snr_limit)

Methods Documentation

check_input_dir(cfg, proc_id)

check the working directory parameter

Parameters:
  • cfg (ConfigParser) – pipeline input configuration
  • proc_id (string) – id number of the process
Returns:

input directory
Return type:

string
check_work_dir(work_dir)

check the working directory parameter

Parameters:work_dir (any (should be string (absolute path))) – working directory where to save scientific products
is_ok()

answer to the question if the pipeline status is ‘OK’

Returns:True if status==’OK’, False if not
Return type:bool
run(show=False, verbose=False)[source]

main process

get the evts files and create the shadowgrams to process deconvolution of the shadowgrams and iterative searching/cleaning on sources

Outputfiles:

ECL-DET-IMA.fits: Prepared detector images

ECL-DET-UBC.fits: Uniformity & Background Corrected detector images

ECL-GTI-3.fits: Good Time Intervals

ECL-DET-MOD.fits: Source Model Images

ECL-SKY-IMA.fits: Reconstructed Sky Images

ECL-SOP-IMA.fits: Sources parameters from sky Images

Note

for the output products see:
General Program Software Description Document Requirements for the Scientific Data Products and Processing […] (SR4)
Parameters:
  • show (bool (defaut False)) – show and save plots of the sky
  • verbose (bool (default False)) – activate print outputs
set_snr_limit(snr_limit)[source]