soxspipe.recipes.soxs_straighten

transform spectral image from detector pixel space to wavelength and slit-position space

Author

David Young & Marco Landoni

Date Created

May 17, 2021

Module Contents

Classes

soxs_straighten

The soxs_straighten recipe

API

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

Bases: soxspipe.recipes.base_recipe.base_recipe

The soxs_straighten recipe

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]
produce_product()[source][source]

The code to generate the product of the soxs_straighten recipe

Return:

  • productPath – the path to the final product

Usage

from soxspipe.recipes import soxs_straighten
recipe = soxs_straighten(
    log=log,
    settings=settings,
    inputFrames=fileList
)
straightenFrame = 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]
subtract_mean_flux_level(rawFrame)[source]
update_fits_keywords(frame, rawFrames=False)[source]
verify_input_frames()[source][source]

verify the input frame match those required by the soxs_straighten recipe

Return:

  • None

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

xsh2soxs(frame)[source]