Module: analysis_processes

Module: analysis_process

Overview

This module provides the implementation of the base class AnalysisProcess class used to create the create specific Processes.

Classes relations

Classes and Inheritance Structure

Summary

AnalysisProducts
AnalysisProcessProducts
AnalysisProcess(name, func[, plot_func, ...])	This class is a base class to handle Processes.
DoPlotTask([name, func, parser, process])	Methods

Module API

class AnalysisProcess(name, func, plot_func=None, parser=None, add_plot_task=True)

Bases: object

This class is a base class to handle Processes. Processes are combinations of AnalysisTask. The combination of Tasks is implemented by the member func, a function that is implemented in each derived class, specific for each derived class, and that is passed as an argument of the constructor. The func is called by the method AnalysisProcess.run().

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()

add_analysis_task(task_class, name)

dump_to_conf_file(file)

list_parameters()

run(image, image_id=None, extra_message=None, **kwargs)

Method that calls the .func to combine AnalysisTask and produce the output

Parameters:

image:

image_id:

extra_message:

**kwargs:

Returns:

prods : AnalysisProductsCollection

Class storing the process output.

run_plotting(plot_func, *args, **kwargs)

set_par(task_name, par_name, **kwargs)

set_pars_from_parser(conf_file_lines, args, argv, args_dict)

set_plotting()

start_message(extra_message=None)

stop_message()

class DoPlotTask(name='do_plot', func=<function foo>, parser=None, process=None)

Bases: asterism.pipeline_manager.analysis_tasks.AnalysisTask

Methods

add_par(name, \*\*kwargs)
get_par_value(name)
list_parameters()
run()
set_par(name, \*\*kwargs)
set_pars_from_parser(args, argv, args_dict)
start_message([extra_message])
stop_message()

run()

foo()