reduction.preproc.darkcor

reduction.preproc.darkcor(
    ccd,
    mdark=None,
    mdarkpath=None,
    exptime_key='EXPTIME',
    exptime_data=None,
    exptime_dark=None,
    dark_scale=False,
    copy=True,
    verbose=1,
)

Subtract a master dark frame, optionally scaled by exposure time.

Parameters

ccd : ~astropy.nddata.CCDData

CCD image to correct.

mdark : ~astropy.nddata.CCDData or ~numpy.ndarray = None

Master dark frame. Default: None.

mdarkpath : path - like = None

Path to the master dark frame. Default: None.

exptime_key : str = 'EXPTIME'

Header keyword for exposure time. Used only when dark_scale=True. Default: "EXPTIME".

exptime_data : numeric = None

Exposure times of the data and dark frame in the same unit. If either is None, header.get(exptime_key, 1) supplies that value; explicit values override the header. Ignored when dark_scale=False. Default: None.

exptime_dark : numeric = None

Exposure times of the data and dark frame in the same unit. If either is None, header.get(exptime_key, 1) supplies that value; explicit values override the header. Ignored when dark_scale=False. Default: None.

dark_scale : bool = False

Multiply the dark frame by exptime_data / exptime_dark before subtraction. Default: False.

copy : bool = True

Return a copy when True; when False, modify the input in place. The latter is slightly faster and uses less memory. Default: True.

verbose : int = 1

Header logging level. Default: 1.

Returns

: ~astropy.nddata.CCDData

Dark-corrected CCD. When both master inputs are None, this is an unchanged copy or the original object according to copy.