Step¶

class muse_origin.Step(orig, idx, param)[source]¶

Bases: muse_origin.steps.LogMixin

Define a processing step.

Parameters

origmuse_origin.ORIGIN: The ORIGIN instance.
idxint: The step number
paramdict: Dictionary of parameters for the step.

Attributes Summary

`desc`	Description of the step.
`name`	Name of the function to run the step.
`require`	List of required steps (that must be run before).
`status`	Processing status (`muse_origin.Status`):

Methods Summary

`__call__`(self, \args, \\*kwargs)	Run a step, calling its `run` method.
`dump`(self, outpath)	Save the attributes that have been created by the steps, and unload them to free memory.
`load`(self, 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`(self, name, data, \\kwargs)	Create a MPDAF Cube and store it as an attribute.
`store_image`(self, name, data, \\kwargs)	Create a MPDAF Image and store it as an attribute.

Attributes Documentation

desc = None¶: Description of the step.

name = None¶: Name of the function to run the step.

require = None¶: 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__(self, *args, **kwargs)[source]¶

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(self, outpath)[source]¶: Save the attributes that have been created by the steps, and unload them to free memory.

load(self, outpath)[source]¶: 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(self, name, data, **kwargs)[source]¶: Create a MPDAF Cube and store it as an attribute.

store_image(self, name, data, **kwargs)[source]¶: Create a MPDAF Image and store it as an attribute.