Module: source_detection

This modules provides the implementation of the DoSrcDetectionProcess class used to handle the source detection process.

Classes and Inheritance Structure

Inheritance diagram of asterism.analysis_processes.source_detection

Summary

do_src_detection_process_func(process, image) This function implements the logic of the algorithm for the detection :class:DoSrcDetectionProcess.
DoSrcDetectionProcess([name, func, ...]) Class that implements the src detection process

Module API

class DoSrcDetectionProcess(name='do_src_detection', func=<function do_src_detection_process_func>, plot_func=<function analysis_plot>, parser=None, add_plot_task=True)[source]

Bases: asterism.pipeline_manager.analysis_processes.AnalysisProcess

Class that implements the src detection process

Tasks in the Process:

user guide: src_detection process user guide

Parameters:

name : str

the name for the Process

func : callable

The function that handles tha tasks, do_src_detection_process_func() in this case

image_id : int

id of the image

plot_func : callable

plotting function for this process

parser :

add_plot_task : bool

Methods

add_analysis_task(task_class, name)
dump_to_conf_file(file)
list_parameters()
run(image[, image_id, extra_message]) Method that calls the .func to combine AnalysisTask and produce the output
run_plotting(plot_func, \*args, \*\*kwargs)
set_par(task_name, par_name, \*\*kwargs)
set_pars_from_parser(conf_file_lines, args, ...)
set_plotting()
start_message([extra_message])
stop_message()
do_src_detection_process_func(process, image, image_id=None, no_plot=False, bkg_image=None, input_seg_map=None)[source]

This function implements the logic of the algorithm for the detection :class:DoSrcDetectionProcess.

The following Tasks are used:

user guide: src_detection process user guide

Parameters:

process : AnalysisProcess

image : Image instance

The input image

image_id : int

id of the image

no_plo :t bool, optional (defaule=False):

bkg_image : 2D np.array, optional

numpy array of the image of the bkg image

bkg_lvl : float,optional

value of the background image, estimated for the current image

Returns:

products : AnalysisProcessProducts

instance of the AnalysisProcessProducts storing into the member prod_list FeaturesArray instance with all the features and features names extracted