Module: analysis_pipeline

Module: analysis_pipeline

Overview

This module provides the implementation of the base class AnalysisPipeline class used to create specific Pipelines that combines together different AnalysisProcess. In the diagram the Pipeline #1 is combining different AnalysisProcess P1...Pn. See AnalysisPipeline for more details .

Classes relations

Classes and Inheritance Structure

Summary

AnalysisProducts
AnalysisPipeline(name, func[, plot_func, ...])	Methods
IOConfProcess([name, func, parser, ...])	Methods
DoIOConfTask([name, func, parser, process])	Methods

Module API

class AnalysisPipeline(name, func, plot_func=None, parser=None, argv=None, conf_file=None)

Bases: object

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)

add_analysis_process(process_class, name, add_plot_task=True)

assign_out_files_values(prods_collection, image_id=None, out_image_id=None)

build_out_files(prods_collection)

builds the OutFilesCollection that stores the output data corresponding to the analysis products. These data reflect the structure of the input images, i.e. single image, list of image, image cube Parameters ———- out_analysis_products

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=None)

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)

class DoIOConfTask(name='do_IO_conf', 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()

class IOConfProcess(name='IO_conf', func=<function foo>, parser=None, add_plot_task=False)

Bases: asterism.pipeline_manager.analysis_processes.AnalysisProcess

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

foo()