5.1.1.4. recipe_system.reduction package

5.1.1.4.1. Subpackages

• 5.1.1.4.1.1. recipe_system.reduction.tests package
  • 5.1.1.4.1.1.1. Submodules
  • 5.1.1.4.1.1.2. recipe_system.reduction.tests.test_coreReduce module

5.1.1.4.2. Submodules

5.1.1.4.3. recipe_system.reduction.coreReduce module

class Reduce provides one (1) public method:

runr()

which calls on the mapper classes and passes the received data to them.

class recipe_system.reduction.coreReduce.Reduce(sys_args=None)

Bases: object

The Reduce class encapsulates the core processing to be done by reduce. __init__ may receive one (1) parameter, nominally, an argparse Namespace instance. However, this object type is not required, but only that any passed object must present an equivalent interface to that of an <argparse.Namespace> instance, i.e. a duck type.

The class provides one (1) public method, runr(), the only call needed to run reduce on the supplied argument set.

5.1.1.4. Parameters

sys_argsargparse.Namespace (optional) or <duck-type object>

This object type is not required, per se, but only that any passed object must present an equivalent interface to that of an argparse.Namespace instance.

5.1.1.4. Attributes

adinputs: <list>

attribute is a list of the input astrodata objects as made from the ‘files’ list (see ‘files’ below).

output_filenames: <list>

read-only property is a list of final output filenames.

mode: <str>

operational mode. Currently, only ‘qa’, ‘sq’ modes are supported.

drpkg: <str>

Data reduction package name. Default is ‘geminidr’, the Gemini Observatory data reduction package.

files: <list>

List of input filenames. Passed to Reduce.__init__(), these are converted to astrodata objects.

suffix: <str>

User supplied suffix to be applied as a final suffix to output filenames.

ucals: <dict>

Dictionary of calibration files passed by –user_cals flag.

uparms: <dict>

Dictionary of user parameters as passed by -p, –param flag.

upload<list>

List of products to upload to fitsstore as passed by –upload. E.g.,

–upload metrics calibs

(==> upload == [‘metrics’, ‘calibs’]) will upload QA metrics to fitsstore and processing calibration files.

recipename: <str> or callable

The name of the recipe that will be run. If None, the ‘default’ recipe is used, as specified in the appropriate recipe library.

property output_filenames

runr()

Map and run the requested or defaulted recipe.

5.1.1.4. Parameters

<void>

5.1.1.4. Returns

<void>

property upload

exception recipe_system.reduction.coreReduce.UnrecognizedParameterException

Bases: Exception

Exception for unrecognized user parameters.