Python API

MuseRed can also be used as a Python object, with the MuseRed class which provides all the methods corresponding to the command-line sub-commands:

>>> from musered import MuseRed
>>> mr = MuseRed(settings_file='settings.yml')
>>> mr.list_datasets()
- IC4406
>>> mr.list_nights()
- 2017-04-23
- 2017-06-13
- 2017-06-15
- 2017-06-17
- 2017-06-18
- 2017-06-19
- 2017-10-26

Functions

get_recipe_cls(recipe_name)	Return the class for a recipe.
normalize_recipe_name(recipe_name)	Add muse_ prefix if needed for the DRS recipe names.

Classes

BIAS([output_dir, use_drs_output, temp_dir, ...])	muse_bias recipe.
CalibRecipe([output_dir, use_drs_output, ...])	Mother class for calibration recipes.
DARK([output_dir, use_drs_output, temp_dir, ...])	muse_dark recipe.
EXPALIGN([output_dir, use_drs_output, ...])	muse_exp_align recipe.
EXPCOMBINE([output_dir, use_drs_output, ...])	muse_exp_combine recipe.
FLAT([output_dir, use_drs_output, temp_dir, ...])	muse_flat recipe.
FSF([output_dir, log_dir, temp_dir])	Recipe to compute FSF for individual exposures
IMPHOT([output_dir, log_dir, temp_dir])	Recipe to compute offsets with Imphot.
LSF([output_dir, use_drs_output, temp_dir, ...])	muse_lsf recipe.
MAKECUBE([output_dir, use_drs_output, ...])	muse_scipost_make_cube recipe.
MPDAFCOMBINE([output_dir, log_dir, temp_dir])	Recipe to combine data cubes with MPDAF.
MuseRed([settings_file, report_format, ...])	The main class handling all MuseRed's logic.
PythonRecipe([output_dir, log_dir, temp_dir])	Class for Python recipes.
QAFlags(table[, additional_flags])	Manage QA flags.
Recipe([output_dir, use_drs_output, ...])	Base class for the DRS Recipes.
SCIBASIC([output_dir, use_drs_output, ...])	muse_scibasic recipe.
SCIPOST([output_dir, use_drs_output, ...])	muse_scipost recipe.
SKYFLAT([output_dir, use_drs_output, ...])	muse_twilight recipe.
STANDARD([output_dir, use_drs_output, ...])	muse_standard recipe.
STDCOMBINE([output_dir, log_dir, temp_dir])	Recipe to combine standard for a run.
SUPERFLAT([output_dir, log_dir, temp_dir])	Recipe to compute and subtract a superflat.
ScienceRecipe([output_dir, use_drs_output, ...])	Mother class for science recipes.
WAVECAL([output_dir, use_drs_output, ...])	muse_wavecal recipe.
ZAP([output_dir, log_dir, temp_dir])	Recipe to subtract sky with ZAP.

Class Inheritance Diagram

digraph inheritanceb2ad46c007 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BIAS" [URL="../api/musered.BIAS.html#musered.BIAS",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_bias recipe."]; "CalibRecipe" -> "BIAS" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseRecipe" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for the recipes."]; "CalibRecipe" [URL="../api/musered.CalibRecipe.html#musered.CalibRecipe",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mother class for calibration recipes."]; "Recipe" -> "CalibRecipe" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DARK" [URL="../api/musered.DARK.html#musered.DARK",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_dark recipe."]; "CalibRecipe" -> "DARK" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EXPALIGN" [URL="../api/musered.EXPALIGN.html#musered.EXPALIGN",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_exp_align recipe."]; "ScienceRecipe" -> "EXPALIGN" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EXPCOMBINE" [URL="../api/musered.EXPCOMBINE.html#musered.EXPCOMBINE",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_exp_combine recipe."]; "ScienceRecipe" -> "EXPCOMBINE" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FLAT" [URL="../api/musered.FLAT.html#musered.FLAT",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_flat recipe."]; "CalibRecipe" -> "FLAT" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FSF" [URL="../api/musered.FSF.html#musered.FSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Recipe to compute FSF for individual exposures"]; "PythonRecipe" -> "FSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IMPHOT" [URL="../api/musered.IMPHOT.html#musered.IMPHOT",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Recipe to compute offsets with Imphot."]; "PythonRecipe" -> "IMPHOT" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LSF" [URL="../api/musered.LSF.html#musered.LSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_lsf recipe."]; "CalibRecipe" -> "LSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MAKECUBE" [URL="../api/musered.MAKECUBE.html#musered.MAKECUBE",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_scipost_make_cube recipe."]; "ScienceRecipe" -> "MAKECUBE" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MPDAFCOMBINE" [URL="../api/musered.MPDAFCOMBINE.html#musered.MPDAFCOMBINE",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Recipe to combine data cubes with MPDAF."]; "PythonRecipe" -> "MPDAFCOMBINE" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MuseRed" [URL="../api/musered.MuseRed.html#musered.MuseRed",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The main class handling all MuseRed's logic."]; "Reporter" -> "MuseRed" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PythonRecipe" [URL="../api/musered.PythonRecipe.html#musered.PythonRecipe",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class for Python recipes."]; "BaseRecipe" -> "PythonRecipe" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QAFlags" [URL="../api/musered.QAFlags.html#musered.QAFlags",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Manage QA flags."]; "Recipe" [URL="../api/musered.Recipe.html#musered.Recipe",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for the DRS Recipes."]; "BaseRecipe" -> "Recipe" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Reporter" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "SCIBASIC" [URL="../api/musered.SCIBASIC.html#musered.SCIBASIC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_scibasic recipe."]; "ScienceRecipe" -> "SCIBASIC" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SCIPOST" [URL="../api/musered.SCIPOST.html#musered.SCIPOST",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_scipost recipe."]; "ScienceRecipe" -> "SCIPOST" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SKYFLAT" [URL="../api/musered.SKYFLAT.html#musered.SKYFLAT",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_twilight recipe."]; "CalibRecipe" -> "SKYFLAT" [arrowsize=0.5,style="setlinewidth(0.5)"]; "STANDARD" [URL="../api/musered.STANDARD.html#musered.STANDARD",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_standard recipe."]; "ScienceRecipe" -> "STANDARD" [arrowsize=0.5,style="setlinewidth(0.5)"]; "STDCOMBINE" [URL="../api/musered.STDCOMBINE.html#musered.STDCOMBINE",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Recipe to combine standard for a run."]; "PythonRecipe" -> "STDCOMBINE" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SUPERFLAT" [URL="../api/musered.SUPERFLAT.html#musered.SUPERFLAT",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Recipe to compute and subtract a superflat."]; "PythonRecipe" -> "SUPERFLAT" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ScienceRecipe" [URL="../api/musered.ScienceRecipe.html#musered.ScienceRecipe",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mother class for science recipes."]; "Recipe" -> "ScienceRecipe" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WAVECAL" [URL="../api/musered.WAVECAL.html#musered.WAVECAL",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="muse_wavecal recipe."]; "CalibRecipe" -> "WAVECAL" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ZAP" [URL="../api/musered.ZAP.html#musered.ZAP",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Recipe to subtract sky with ZAP."]; "PythonRecipe" -> "ZAP" [arrowsize=0.5,style="setlinewidth(0.5)"]; }