CreateAreas¶
- class muse_origin.CreateAreas(orig, idx, param)[source]¶
Bases:
muse_origin.steps.Step
Creation of areas to split the work.
This allows to split the cube into sub-cubes to distribute the following steps on multiple processes. The merged segmap computed previously is used to avoid cutting objects.
- Parameters
- Returns
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[, pfa, minsize, maxsize])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
- areamap = None¶
- desc = 'Areas creation'¶
Description of the step.
- name = 'areas'¶
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__(*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.