3.1.11. stackDarks

Stack MAROON-X dark frames with etalon intensity scaling.

MX-specific version of stack darks allowing scaling for etalon intensity drift that is in MX ‘darks’.

3.1.11.1. Parameters

adinputslist of AstroData

Input frames to be combined

suffixstr

Suffix to be added to output files

scale_modestr

Scaling mode for the input frames. Options are ‘mean_frame’ or ‘first_frame’.

lsigmafloat

Lower sigma clipping threshold for the rejection method

hsigmafloat

Upper sigma clipping threshold for the rejection method

max_itersint

Maximum number of iterations for the rejection method

reject_methodstr

Rejection method to be used. Currently only ‘sigclip’ is supported.

3.1.11.2. Returns

list of AstroData

Combined output frame

3.1.11.3. Parameter defaults and options

suffix               '_stack'             Filename suffix
apply_dq             True                 Use DQ to mask bad pixels?
statsec              None                 Section for statistics (1-indexed, inclusive-max, x-first)
operation            'mean'               Averaging operation
   Allowed values:
     mean    arithmetic mean
     wtmean  variance-weighted mean
     median  median
     lmedian low-median

reject_method        'sigclip'            Pixel rejection method
   Allowed values:
     none    no rejection
     minmax  reject highest and lowest pixels
     sigclip reject pixels based on scatter
     varclip reject pixels based on variance array

hsigma               2.0                  High rejection threshold (sigma)
     Valid Range = [0,inf)
lsigma               2.0                  Low rejection threshold (sigma)
     Valid Range = [0,inf)
mclip                True                 Use median for sigma-clipping?
max_iters            5                    Maximum number of clipping iterations
     Valid Range = [1,inf)
nlow                 0                    Number of low pixels to reject
     Valid Range = [0,inf)
nhigh                0                    Number of high pixels to reject
     Valid Range = [0,inf)
memory               1.0                  Memory available for stacking (GB)
     Valid Range = [0.01,inf)
save_rejection_map   False                Save rejection map?
separate_ext         True                 Handle extensions separately?
scale_mode           'first_frame'        Scaling method for frames

3.1.11.4. Algorithm

Todo

add description

3.1.11.5. Issues and Limitations

Todo

add description