Module: analysis_products¶

Overview¶

This modules provides an

The class_name is used to...

Classes relations¶

Classes and Inheritance Structure¶

Summary¶

`some`
`some`

Module API¶

class AnalysisProduct(name='AnalysisProd', prods=None)[source]¶

Bases: object

Base class for analysis products

class AnalysisProductCatalog(data, name='catalog')[source]¶

Bases: asterism.pipeline_manager.analysis_products.AnalysisProduct

AnalysisProduct for ASCII catalog

class AnalysisProductFigure(figures_list, figures_name_list, name='prod_figure')[source]¶

Bases: asterism.pipeline_manager.analysis_products.AnalysisProduct

AnalysisProduct for matplotlib figures

class AnalysisProductFitsImage(image_array, name='prod_image')[source]¶

Bases: asterism.pipeline_manager.analysis_products.AnalysisProduct

AnalysisProduct for Image

class AnalysisProductGeneric(prods, name='prod_generic')[source]¶: Bases: asterism.pipeline_manager.analysis_products.AnalysisProduct

class AnalysisProductRecArray(array_values, analysis_array_dtype, name='prod_rec_array')[source]¶

Bases: asterism.pipeline_manager.analysis_products.AnalysisProduct

AnalysisProduct for numpy record array

Methods

append_row(list_of_array_values)

append_row(list_of_array_values)[source]¶

class AnalysisProductRegionCatalog(catalog_text, name='prod_generic')[source]¶: Bases: asterism.pipeline_manager.analysis_products.AnalysisProduct

class AnalysisProductsCollection(prod=None)[source]¶

Bases: object

Class storing a collection of AnalysisProduct objects

Methods

`add_product`(prod)
`extend`(prod_collection)
`get_product_by_name`(name)

add_product(prod)[source]¶

extend(prod_collection)[source]¶

get_product_by_name(name)[source]¶

class OutFile(name='out_file', working_dir=None, flag=None, suffix='')[source]¶

Bases: object

Methods

`set_file_name`([suffix])
`write_to_file`()

set_file_name(suffix=None)[source]¶

write_to_file()[source]¶

class OutFileCatalog(working_dir=None, flag=None, name='catalog', fmt=None, fits_format=True)[source]¶

Bases: asterism.pipeline_manager.analysis_products.OutFile

Methods

`fill`(prod[, out_image_id, image_id])
`set_file_name`([suffix])
`write_to_file`()

fill(prod, out_image_id=None, image_id=None)[source]¶

write_to_file()[source]¶

class OutFileFigure(n_entries, file_type='png', working_dir=None, flag=None, name='figure_out_file')[source]¶

Bases: asterism.pipeline_manager.analysis_products.OutFile

OutFile class for AnalysisProductFigure objects

Methods

`fill`(analysis_prod[, image_id, out_image_id])
`save_plot_func`(analysis_prod[, image_id, ...])
`set_file_name`([fig_name, image_id, out_image_id])
`write_to_file`()

fill(analysis_prod, image_id=None, out_image_id=None)[source]¶

save_plot_func(analysis_prod, image_id=None, out_image_id=None)[source]¶

set_file_name(fig_name='', image_id=None, out_image_id=None)[source]¶

write_to_file()[source]¶

class OutFileFitsImage(out_shape, working_dir=None, flag=None, name='image_out_file', suffix='.fits')[source]¶

Bases: asterism.pipeline_manager.analysis_products.OutFile

Methods

`fill`(analysis_prod[, out_image_id, image_id])
`set_file_name`([suffix])
`write_to_file`()

fill(analysis_prod, out_image_id=None, image_id=None)[source]¶

write_to_file()[source]¶

class OutFileGeneric(name='generic_out_file', working_dir=None, flag=None)[source]¶

Bases: asterism.pipeline_manager.analysis_products.OutFile

Methods

`fill`(analysis_prod[, out_image_id, image_id])
`set_file_name`([suffix])
`write_to_file`()

fill(analysis_prod, out_image_id=None, image_id=None)[source]¶

write_to_file()[source]¶

class OutFileRecArray(dtype, working_dir=None, flag=None, name='recarray_out_file', suffix='.fits')[source]¶

Bases: asterism.pipeline_manager.analysis_products.OutFile

OutFile class for AnalysisProductRecArray objects The numpy record array is stored in the .data class member

Methods

`fill`(data[, out_image_id, image_id])
`set_file_name`([suffix])
`write_to_file`()

fill(data, out_image_id=None, image_id=None)[source]¶

write_to_file()[source]¶

class OutFileRegionCatalog(catalog_text, name='generic_out_file', working_dir=None, flag=None, suffix='.reg')[source]¶

Bases: asterism.pipeline_manager.analysis_products.OutFile

Methods

`fill`(analysis_prod[, out_image_id, image_id])
`set_file_name`([suffix])
`write_to_file`()

fill(analysis_prod, out_image_id=None, image_id=None)[source]¶

write_to_file()[source]¶

class OutFilesCollection(out_file=None)[source]¶

Bases: object

Class storing a collection of OutFile objects

Methods

`add_out_file`(out_file)
`fill_file`()

add_out_file(out_file)[source]¶

fill_file()[source]¶

Module: analysis_products¶