Module: source_detection

Module: source_detection

Overview

This modules provides the implementation of the SrcDetectionPipeline class used to create the pipeline for the source detection. The process in the pipeline are orchestrated by the do_src_detection_pipeline_func()

Classes and Inheritance Structure

Summary

do_src_detection_pipeline_func(pipeline, image)	Function that implements the algorithm for the SrcDetectionPipeline class
SrcDetectionPipeline([name, func, ...])	Class that implements the source detection pipeline.

Module API

class SrcDetectionPipeline(name='scr_detection_script', func=<function do_src_detection_pipeline_func>, plot_func=<function analysis_plot>, parser=None, argv=None, conf_file=None)

Bases: asterism.pipeline_manager.analysis_pipeline.AnalysisPipeline

Class that implements the source detection pipeline.

Processes in the Pipeline

• do_src_detection DoSrcDetectionProcess

user guide: src_detection pipeline user guide

Parameters:

name : str

the name for the Process

func : :func:

The function that handles tha processes

image_id : int

id of the image

plot_func : :func:

plotting function for this process

parser :

argv :

conf_file:

Methods

add_analysis_process(process_class, name[, ...])
assign_out_files_values(prods_collection[, ...])
build_out_files(prods_collection)	builds the OutFilesCollection that stores the output data corresponding
check_all_processes_exit_status()
dump_configuration_file(file_name)
get_process(proc_name)
list_parameters()
run(\*args, \*\*kwargs)
set_images_list(image_file)	get images list
set_infiles_list()
set_io_conf([infile])
set_pars_from_conf_file()
set_pars_from_parser()
set_plotting()
write_job_exit_file(exit_status, exception_mess)
write_out_products()
write_to_script_exit_file(image_id)

do_src_detection_pipeline_func(pipeline, image, image_id=None, input_seg_map=None, **kwargs)

Function that implements the algorithm for the SrcDetectionPipeline class

user guide: src_detection pipeline user guide

Parameters:

pipeline : SrcDetectionPipeline

instance of the base AnalysisPipeline class

image : Image

instance of the class used as input for different processes

image_id : int

id of the image

**kwargs:

Returns:

src_detection_analysis_products : AnalysisProduct

class instance storing the analysis products for this pipeline