HAWCParameters

class sofia_redux.pipeline.sofia.parameters.hawc_parameters.HAWCParameters(config=None, param_lists=None, mode=None)

Bases: Parameters

Reduction parameters for the HAWC pipeline.

Initialize parameters from HAWC DRP step defaults.

Parameters:

configconfigobj.ConfigObj or dict-like, optional

DRP configuration object.

param_listsdict

DRP pipeline step parameter lists for all available steps. Keys are pipeline step names.

Methods Summary

calibrate(step_index)	Modify parameters for the calibrate step.
checkhead(step_index)	Modify parameters for the checkhead step.
demodulate(step_index)	Define parameters for the demodulate super-step.
dmdcut(step_index)	Modify parameters for the dmdcut step.
dmdplot(step_index)	Modify parameters for the dmdplot step.
fluxjump(step_index)	Modify parameters for the fluxjump step.
focus(step_index)	Modify parameters for the focus step.
make_flats(step_index)	Define parameters for the make_flats super-step.
merge(step_index)	Modify parameters for the merge step.
opacity(step_index)	Modify parameters for the opacity step.
poldip(step_index)	Modify parameters for the poldip step.
polmap(step_index)	Modify parameters for the polmap step.
prepare(step_index)	Modify parameters for the prepare step.
process_intcal(step_index)	Define parameters for the process_intcal super-step.
read_parameters(param_lists)	Read parameters from DRP parameter lists.
scanmap(step_index)	Modify parameters for the scanmap step.
scanmapflat(step_index)	Modify parameters for the scanmapflat step.
scanmapfocus(step_index)	Modify parameters for the scanmapfocus step.
scanmappol(step_index)	Modify parameters for the scanmappol step.
skycal(step_index)	Modify parameters for the skycal step.
skydip(step_index)	Modify parameters for the skydip step.
standard_param()	Return a standard set of parameters to add to all steps.
stdphotcal(step_index)	Modify parameters for the stdphotcal step.
to_config()	Read parameter values into a configuration object.
update_parameters(default[, config])	Update parameter values from a DRP configuration.

Methods Documentation

calibrate(step_index)

Modify parameters for the calibrate step.

Save the output data by default.

Parameters:

step_indexint

Reduction recipe index for the step.

checkhead(step_index)

Modify parameters for the checkhead step.

This step only checks headers. Don’t save, load, or display the data.

Parameters:

step_indexint

Reduction recipe index for the step.

demodulate(step_index)

Define parameters for the demodulate super-step.

Start with the parameters for the DRP demodulate step, then add in the abort parameter for the checkhead step. The final DMD file is saved by default; undo and display are turned off.

Parameters:

step_indexint

Reduction recipe index for the step.

dmdcut(step_index)

Modify parameters for the dmdcut step.

No display for demodulated data.

Parameters:

step_indexint

Reduction recipe index for the step.

dmdplot(step_index)

Modify parameters for the dmdplot step.

No display for demodulated data.

Parameters:

step_indexint

Reduction recipe index for the step.

fluxjump(step_index)

Modify parameters for the fluxjump step.

No undo or display for raw data. Do load, don’t save.

Parameters:

step_indexint

Reduction recipe index for the step.

focus(step_index)

Modify parameters for the focus step.

No output FITS file; hide save, don’t display.

Parameters:

step_indexint

Reduction recipe index for the step.

make_flats(step_index)

Define parameters for the make_flats super-step.

Parameters for the mkflat step are added. Earlier steps (prepare, demodulate, etc.) are not, since these parameters generally do not need modification by the user. They can still be overridden by modifying a DRP configuration file.

Save is off by default for the final DCL file. Don’t allow undo or display; the auxiliary OFT file will still display.

Parameters:

step_indexint

Reduction recipe index for the step.

merge(step_index)

Modify parameters for the merge step.

Save the output data by default.

Parameters:

step_indexint

Reduction recipe index for the step.

opacity(step_index)

Modify parameters for the opacity step.

Save the output data by default.

Parameters:

step_indexint

Reduction recipe index for the step.

poldip(step_index)

Modify parameters for the poldip step.

Save the output by default.

Parameters:

step_indexint

Reduction recipe index for the step.

polmap(step_index)

Modify parameters for the polmap step.

Save the output data by default. Keep the auxout from the previous step (DS9 regions).

Parameters:

step_indexint

Reduction recipe index for the step.

prepare(step_index)

Modify parameters for the prepare step.

No undo or display for raw data. Do load, don’t save.

Parameters:

step_indexint

Reduction recipe index for the step.

process_intcal(step_index)

Define parameters for the process_intcal super-step.

Parameters for the mkflat step are added. Earlier steps (prepare, demodulate, etc.) are not, since these parameters generally do not need modification by the user. They can still be overridden by modifying a DRP configuration file.

Save is on by default for the final DCL file. Don’t allow undo.

Parameters:

step_indexint

Reduction recipe index for the step.

read_parameters(param_lists)

Read parameters from DRP parameter lists.

DRP parameter types are inferred from their default values (see Parameters.get_param_type).

A standard set of Redux control parameters are also added to each pipeline step (save, undo, display, load, keep_auxout). These may be later overridden by methods in this class.

Parameters:

param_listsdict

DRP pipeline step parameter lists for all available steps. Keys are pipeline step names.

Returns:

defaultdict

Mapping of step names to parameter set values. Keys are pipeline step names; values are dicts with ParameterSet keywords.

scanmap(step_index)

Modify parameters for the scanmap step.

Don’t load data into memory: scanmap loads it separately. If no output is expected, don’t save or display the output. If output is expected, do save and display it.

Parameters:

step_indexint

Reduction recipe index for the step.

scanmapflat(step_index)

Modify parameters for the scanmapflat step.

Don’t load data into memory: scanmap loads it separately.

Parameters:

step_indexint

Reduction recipe index for the step.

scanmapfocus(step_index)

Modify parameters for the scanmapfocus step.

This step calls scanmap: don’t load the input data. Do save the output.

Parameters:

step_indexint

Reduction recipe index for the step.

scanmappol(step_index)

Modify parameters for the scanmappol step.

Don’t load data into memory: scanmap loads it separately.

Parameters:

step_indexint

Reduction recipe index for the step.

skycal(step_index)

Modify parameters for the skycal step.

Parameters:

step_indexint

Reduction recipe index for the step.

skydip(step_index)

Modify parameters for the skydip step.

No output FITS file; hide save, don’t display.

Parameters:

step_indexint

Reduction recipe index for the step.

standard_param()

Return a standard set of parameters to add to all steps.

The default is:

• don’t save output from the step

• allow undo of the step

• display the output of the step

• load the input data from memory if it has not already been loaded

• don’t keep auxiliary output from the previous step for re-display after this step

stdphotcal(step_index)

Modify parameters for the stdphotcal step.

Save the output data by default.

Parameters:

step_indexint

Reduction recipe index for the step.

to_config()

Read parameter values into a configuration object.

Section names in the output object are written as stepindex: stepname in order to record the order of reduction steps, and to keep any repeated step names uniquely identified. Only the current parameter values are recorded. Other information, such as data or widget type or default values, is lost.

Overrides parent function in order to add an override mode flag to the top-level configuration.

Returns:

ConfigObj

The parameter values in a configobj.ConfigObj object.

update_parameters(default, config=None)

Update parameter values from a DRP configuration.

Parameters:

defaultdict

Default parameter dictionary to update. Updates are made in place.

configconfigobj.ConfigObj, optional

DRP configuration object. If not provided, the default configuration will be used.

Returns:

dict

Updated default parameter dictionary.