soxs_stare - PLANNED ∞

Input ∞

Data Type Content Related OB

Parameters ∞

Parameter Description Type Entry Point Related Util
stacked-clipping-sigma number of σ deviations from the median pixel flux beyond which pixel is excluded from stack float settings file

clip_and_stack
stacked-clipping-iterations number of σ-clipping iterations to perform before stacking float settings file

clip_and_stack

Method ∞

Output ∞

Data Type Content

QC Metrics ∞

Metric Description
TBC …

Recipe API ∞

class soxs_stare(log, settings=False, inputFrames=[], verbose=False, overwrite=False)[source] ∞

The soxs_stare recipe

Key Arguments

  • log – logger

  • settings – the settings dictionary

  • inputFrames – input fits frames. Can be a directory, a set-of-files (SOF) file or a list of fits frame paths.

  • verbose – verbose. True or False. Default False

  • overwrite – overwrite the product file if it already exists. Default False

See produce_product method for usage.

Todo

  • add usage info

  • create a sublime snippet for usage

  • create cl-util for this class

  • add a tutorial about soxs_stare to documentation

verify_input_frames()[source] ∞

verify the input frame match those required by the soxs_stare recipe

Return:

- ``None``

If the fits files conform to required input for the recipe everything will pass silently, otherwise an exception shall be raised.

produce_product()[source] ∞

The code to generate the product of the soxs_stare recipe

Return:

  • productPath – the path to the final product

Usage

from soxspipe.recipes import soxs_stare
recipe = soxs_stare(
    log=log,
    settings=settings,
    inputFrames=fileList
)
stareFrame = recipe.produce_product()