soxspipe.recipes.soxs_offset

Reduce SOXS/Xshooter data taken in offset mode

Author

David Young & Marco Landoni

Date Created

February 27, 2024

Module Contents

Classes

soxs_offset

Reduce SOXS/Xshooter data taken in offset mode

API

class soxspipe.recipes.soxs_offset.soxs_offset(log, settings=False, inputFrames=[], verbose=False, overwrite=False, command=False, debug=False, turnOffMP=False)[source][source]

Bases: soxspipe.recipes.soxs_nod.soxs_nod

Reduce SOXS/Xshooter data taken in offset mode

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

  • command – the command called to run the recipe

  • debug – generate debug plots. Default False

  • turnOffMP – turn off multiprocessing. True or False. Default False. If True, multiprocessing will be turned off and the recipe will run in serial. This is useful for debugging.

Usage

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

Initialization

clean_up(forceFail=False)[source]
clip_and_stack(frames, recipe, ignore_input_masks=False, post_stack_clipping=True)[source]
detrend(inputFrame, master_bias=False, dark=False, master_flat=False, order_table=False)[source]
flag_poor_data()[source]
get_recipe_settings()[source]
prepare_frames(save=False)[source]
process_single_ab_nodding_cycle(aFrame, bFrame, locationSetIndex, orderTablePath, notFlattened=False, masterFlat=False)[source]
produce_product()[source][source]

The code to generate the product of the soxs_offset recipe

Return:

  • productPath – the path to the final product

Usage

from soxspipe.recipes import soxs_offset
recipe = soxs_offset(
    log=log,
    settings=settings,
    inputFrames=fileList
)
offsetFrame = recipe.produce_product()
qc_median_flux_level(frame, frameType='MBIAS', frameName='master bias', medianFlux=False)[source]
qc_ron(frameType=False, frameName=False, masterFrame=False, rawRon=False, masterRon=False)[source]
report_output(rformat='stdout')[source]
stack_extractions(dataFrameList, notFlattened=False, orderJoins=None)[source]
subtract_mean_flux_level(rawFrame)[source]
update_fits_keywords(frame, rawFrames=False)[source]
verify_input_frames()[source]
xsh2soxs(frame)[source]