CleanResults¶
- class muse_origin.CleanResults(orig, idx, param)[source]¶
Bases:
muse_origin.steps.Step
Clean the various results.
This step does several things to “clean” the results of ORIGIN:
Some lines are associated to the same source but are very near considering their z positions. The lines are all marked as merged in the brightest line of the group (but are kept in the line table).
A table of unique sources is created.
Statistical detection info is added on the 2 resulting catalogs.
Attributes added to the ORIGIN object: -
Cat3_lines
: clean table of lines; -Cat3_sources
: table of unique sources- Parameters
- merge_lines_z_threshold: int
z axis pixel threshold used when merging similar lines, defaults to 5.
Attributes Summary
Description of the step.
Name of the function to run the step.
List of required steps (that must be run before).
Processing status (
muse_origin.Status
):Methods Summary
__call__
(*args, **kwargs)Run a step, calling its
run
method.dump
(outpath)Save the attributes that have been created by the steps, and unload them to free memory.
load
(outpath)Recreate attributes of a step, not really loading them as just the file is set, and files are loaded in memory only if needed.
run
(orig[, merge_lines_z_threshold])store_cube
(name, data, **kwargs)Create a MPDAF Cube and store it as an attribute.
store_image
(name, data, **kwargs)Create a MPDAF Image and store it as an attribute.
Attributes Documentation
- Cat3_lines = None¶
- Cat3_sources = None¶
- desc = 'Results cleaning'¶
Description of the step.
- name = 'clean_results'¶
Name of the function to run the step.
- require = ('compute_spectra',)¶
List of required steps (that must be run before).
- status¶
Processing status (
muse_origin.Status
):NOTRUN: The step has not been run.
RUN: The step has been run but not saved.
DUMP: The step has been run and its outputs saved to disk.
FAILED: The step has been run but it failed.
Methods Documentation
- __call__(*args, **kwargs)¶
Run a step, calling its
run
method.This method is the one that is called from the ORIGIN object. It calls the
run
method of the step and also does a few additional things like storing the parameters, execution time and date.
- dump(outpath)¶
Save the attributes that have been created by the steps, and unload them to free memory.
- load(outpath)¶
Recreate attributes of a step, not really loading them as just the file is set, and files are loaded in memory only if needed.
- store_cube(name, data, **kwargs)¶
Create a MPDAF Cube and store it as an attribute.
- store_image(name, data, **kwargs)¶
Create a MPDAF Image and store it as an attribute.