soxs_order_centres ∞

The purpose of the soxs_order_centres recipe is to find and fit the order centres with low-level polynomials.

Input ∞

Data Type Content Related OB
FITS Image Flat lamp through a single-pinhole mask SOXS_slt_cal_VISLampFlatPinhole, SOXS_slt_cal_NIRLampFlatPinhole
FITS Image Master Dark Frame (VIS only) -
FITS Image Master Bias Frame (VIS only) -
FITS Image Dark frame (Lamp-Off) of equal exposure length as single-pinhole frame (Lamp-On) (NIR only) SOXS_slt_cal_NIRLampFlatPinhole
CSV File First guess dispersion solution -

Parameters ∞

Parameter Description Type Entry Point Related Util
order-sample-count number of times along the order in the dispersion direction to measure the order-centre trace int settings file

detect_continuum utility
peak-sigma-limit minimum value a peak must be above the median value of pixel to be considered for order-trace fitting int settings file

detect_continuum utility
disp-axis-deg degree of dispersion axis component of polynomal fit to order-centre traces int settings file
order-deg degree of order component of polynomal fit to order-centre traces int settings file
poly-fitting-residual-clipping-sigma sigma distance limit, where distance is the difference between the detected and polynomial fitted positions of the order-trace, outside of which to remove lines from the fit float settings file

detect_continuum utility
poly-clipping-iteration-limit number of sigma-clipping iterations to perform before settings on a polynomial fit for the order-centre traces int settings file

detect_continuum utility

Method ∞

Once the single-pinhole flat-lamp frame has had the bias, dark and background subtracted it is passed to the detect_continuum utility to fit the order centres.

Output ∞

Data Type Content
CSV File

order table containing coefficients to the polynomial fits describing the order centre locations

QC Metrics ∞

Plots similar to the one below are generated after each execution of soxs_order_centres.

Metric Description
TBC …

Recipe API ∞

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

The soxs_order_centres 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 prodcut file if it already exists. Default False

Usage

from soxspipe.recipes import soxs_order_centres
order_table = soxs_order_centres(
    log=log,
    settings=settings,
    inputFrames=a["inputFrames"]
).produce_product()

Todo

  • add a tutorial about soxs_order_centres to documentation

verify_input_frames()[source] ∞

verify input frames match those required by the soxs_order_centres 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] ∞

generate the order-table with polynomal fits of order-centres

Return:

  • productPath – the path to the order-table