soxspipe.commonutils.flux_calibration

Flux calibrate an extracted science spectrum using an instrument response function

Author

David Young

Date Created

July 28, 2023

Module Contents

Classes

flux_calibration

The worker class for the flux_calibration module

API

class soxspipe.commonutils.flux_calibration.flux_calibration(log, responseFunction, extractedSpectrum, settings=False, airmass=1.0, exptime=1.0, extinctionPath='', arm='', header=None, recipeName='', startNightDate='', sofName='', debug=False)[source][source]

Bases: object

The worker class for the flux_calibration module

Key Arguments:

  • log – logger

  • responseFunction – the instrument response function.

  • extractedSpectrum – the extracted science spectrum

  • settings – the settings dictionary

Usage:

To setup your logger, settings and database connections, please use the fundamentals package (see tutorial here https://fundamentals.readthedocs.io/en/master/initialisation.html).

To initiate a flux_calibration object, use the following:

Todo

- add usage info
- create a sublime snippet for usage
- create cl-util for this class
- add a tutorial about ``flux_calibration`` to documentation
- create a blog post about what ``flux_calibration`` does

usage code

Initialization

calibrate()[source][source]

flux calibrate the science spectrum

Return:

  • flux_calibration

Usage:

Todo

- add usage info
- create a sublime snippet for usage
- create cl-util for this method
- update the package tutorial if needed

usage code