soxspipe.recipes.soxs_spatial_solution

enhance the wavelength solution achieved with soxs_disp_solution by expanding the solution into the spatial dimension (along the slit)

Author

David Young & Marco Landoni

Date Created

March 17, 2021

Module Contents

Classes

soxs_spatial_solution

Enhance the wavelength solution achieved with soxs_disp_solution by expanding the solution into the spatial dimension (along the slit)

Functions

parameterTuning

tuning the spatial solution

API

soxspipe.recipes.soxs_spatial_solution.parameterTuning(p, log, recipeSettings, settings, multiPinholeFrame, disp_map_table, order_table, qc, products, sofName, lineDetectionTable)[source][source]

tuning the spatial solution

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

Bases: soxspipe.recipes.base_recipe.base_recipe

Enhance the wavelength solution achieved with soxs_disp_solution by expanding the solution into the spatial dimension (along the slit)

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

  • create2DMap – create the 2D image map of wavelength, slit-position and order from disp solution.

  • polyOrders – the orders of the x-y polynomials used to fit the dispersion solution. Overrides parameters found in the yaml settings file. e.g 345435 is order_x=3, order_y=4 ,wavelength_x=5 ,wavelength_y=4, slit_x=3 ,slit_y=5. Default False.

  • command – the command called to run the recipe

  • debug – debug mode. True or False. 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.

See produce_product method for usage.

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]

generate the 2D dispersion map

Return:

  • productPath – the path to the 2D dispersion map

Usage

from soxspipe.recipes import soxs_spatial_solution
recipe = soxs_spatial_solution(
    log=log,
    settings=settings,
    inputFrames=fileList
)
disp_map = 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 input frames match those required by the soxs_spatial_solution recipe

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]