IMPHOT

class musered.IMPHOT(output_dir=None, log_dir='.', temp_dir=None, **kwargs)[source]

Bases: musered.recipes.recipe.PythonRecipe

Recipe to compute offsets with Imphot.

Attributes Summary

DPR_TYPE

Type of data to process (DPR.TYPE).

calib_frames

Return the list of calibration frames.

default_params

Default parameters.

exclude_frames

Frames that must be excluded by default.

n_inputs_min

Minimum number of input files, as required by the DRS.

output_dir

Default output directory.

output_frames

Output frames.

recipe_name

Name of the recipe.

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 = 'DATACUBE_FINAL'

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

calib_frames

Return the list of calibration frames.

default_params = {'exclude_regions': None, 'extramask': None, 'fix_beta': None, 'fix_bg': None, 'force_hst_image': False, 'force_muse_image': False, 'hst_filters': None, 'hst_filters_dir': None, 'hst_img_dir': None, 'hst_resample_each': False, 'min_scale': 0}

Default parameters.

exclude_frames = {}

Frames that must be excluded by default.

n_inputs_min = None

Minimum number of input files, as required by the DRS.

output_dir = 'exp_align'

Default output directory.

output_frames = ['OFFSET_LIST']

Output frames.

recipe_name = 'imphot'

Name of the recipe.

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.