SCIBASIC¶

class musered.SCIBASIC(output_dir=None, use_drs_output=True, temp_dir='.', log_dir='.', version=None, nifu=- 1, tag=None, verbose=True)[source]¶

Bases: musered.recipes.science.ScienceRecipe

muse_scibasic recipe.

Attributes Summary

`DPR_TYPE`	Type of data to process (DPR.TYPE).
`DPR_TYPES`	Same as DPR_TYPE but when a recipe can process multiples types, e.g.
`QC_keywords`	QC keywords to show, for each frame.
`calib_frames`	Return the list of calibration frames.
`default_params`	Default parameters.
`env`	Default environment variables.
`exclude_frames`	Frames that must be excluded by default.
`n_inputs_min`	Minimum number of input files, as required by the DRS.
`n_inputs_rec`	Recommended number of input files, typically for calibration files.
`output_dir`	Default output directory.
`output_frames`	Return the list of output frames.
`recipe_name`	Name of the recipe.
`recipe_name_drs`	Name of the recipe for the DRS, in case it is renamed in musered.
`use_illum`	If True, the recipe should use an ILLUM exposure.
`version`	Return the recipe version

Methods Summary

`activate_file_logger`()	Activate the logging to a file.
`deactivate_file_logger`()	Deactivate the logging to a file.
`dump`([include_files, json_col])	Dump recipe results, stats, parameters in a dict.
`dump_params`([json_col])	Dump non-default parameters to a JSON string.
`run`(flist, *args[, params])	Run the recipe.

Attributes Documentation

DPR_TYPE = None¶: Type of data to process (DPR.TYPE). If None, cpl.Recipe.tag is used.

DPR_TYPES = {}¶: Same as DPR_TYPE but when a recipe can process multiples types, e.g. muse_scibasic. If None, cpl.Recipe.tag is used.

QC_keywords = {}¶: QC keywords to show, for each frame.

calib_frames¶

default_params = {'merge': True, 'saveimage': False}¶: Default parameters.

env = None¶: Default environment variables.

exclude_frames = ('MASTER_DARK', 'NONLINEARITY_GAIN')¶: Frames that must be excluded by default.

n_inputs_min = 1¶: Minimum number of input files, as required by the DRS.

n_inputs_rec = None¶: Recommended number of input files, typically for calibration files.

output_dir = 'scibasic'¶: Default output directory.

output_frames¶: Output frames.

recipe_name = 'muse_scibasic'¶: Name of the recipe.

recipe_name_drs = None¶: Name of the recipe for the DRS, in case it is renamed in musered.

use_illum = True¶: If True, the recipe should use an ILLUM exposure.

version¶: Recipe version.

Methods Documentation

activate_file_logger()¶: Activate the logging to a file.

deactivate_file_logger()¶: Deactivate the logging to a file.

dump(include_files=False, json_col=False)¶: Dump recipe results, stats, parameters in a dict.

dump_params(json_col=False)¶: Dump non-default parameters to a JSON string.

run(flist, *args, params=None, **kwargs)¶

Run the recipe.

Subclasses must implement BaseRecipe._run to customize this.

Parameters

fliststr, list of str, or dict: List of input raw files. Can be a file, list of files, or a dict with DPR_TYPE as key and list of files as value.
paramsdict: Parameters for the recipe.
*args, **kwargs: Additional arguments are passed to BaseRecipe._run.