Imag

class Imag(work_dir, input_dir, obs, conf, proc_id)[source]

Bases: process.pipeline.ecpi_flows.WorkFlow

find sources in the shadowgrams 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.

Parameters:
  • work_dir (string (absolute path)) – working directory where to save scientific products
  • input_dir (string (absolute path)) – local directory with evts in it
  • obs (EclairsObservation) – observation parameters
  • conf (PipelineConfiguration) – pipeline config
  • proc_id (string) – id number of the process

Methods Summary

check_input_dir(input_dir) check the input local 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(input_dir)

check the input local directory parameter

check in addition if there is any fits file in the directory

Parameters:input_dir (any (should be string (absolute path))) – local directory with evts in it
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 shadowgrams deconvolution of the shadowgram and iterative searching/cleaning on sources

Outputfiles:

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]