Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • NDArrCalib uses the source and key_in parameters to get any ndarray<T,NDIM> object from the event store, where T stands for uint16_t, int, float, uint8_t, or double, 1≤NDim≤5,
  • automaticly gets parameters from calibration store for types pedestals, common_mode, pixel_status, pixel_gain, and pixel_rms,
  • get gets parameters from user-defined files fname_bkgd ,  and  fname_mask, and fname_nrms, if their names are specified,
  • the specified by the file name do_... parameter corrections are applied per-pixel to raw data  ndarray<T,NDIM> as follows:

...

  • and saves the corrected ndarray<double,NDim> in the event with key key_out

Oder of Control on corrections

Code Block
bgColor#F7F7ED
A_cor = A_raw
        (1) - pedestal               | if do_peds==true and pedestals are available in calib store
        (2) - common mode            | if do_cmod==true and common_mode parameters are available in calib store
        (3) - N*background           | if do_bkgd==true and the file name is specified in the parameter fname_bkgd and bkgd_ind_* are set
        (4) * gain                   | if do_gain==true and pixel_gain are available in calib store
        (5) apply hot/bad pixel maskstatus | if do_stat==true and pixel_status are available in calib store
        (6) apply mask               | if do_mask==true and the file name is specified in the parameter fname_mask and parameter masked_value is set
        (7) apply N*RMS threshold    | if do_nrms==true and pixel_rms theare fileavailable namein iscalib specifiedstore, inparameters thethreshold_nrms parameterand fname_nrmsbelow_thre_value are set
        (8) apply threshold          common threshold | if do_thre==true and theparameters threshold and below_thre_value are set

...

parameter

default value

description

source

DetInfo(:Camera)

source of data

key_in

 

key for input image ndarray<T,NDIM>

key_out

calibrated

output key for calibrated image saved in event

do_peds

false

true: pedestals subtracted if available in calib store

do_cmod

false

true: common mode correction is evaluated and applied

do_stat

false

true: bad/hot pixels in pixel_status are masked

do_mask

false

true: mask is applied if the file fname_mask is available

do_bkgd

false

true: normalized background is subtracted if the file fname_bkgd is available

do_gain

false

true: pixel_gain correction is applied if available in calib store

do_nrms

false

true: per-pixel threshold is applied if the file fnamepixel_nrmsrms  is available in calib store

do_thre

false

true: low level threshold in ADU is applied

fname_bkgd

 

input file name for background, applied if the file name is specified

fname_mask

 

input file name for mask, applied if the file name is specified

fname_rms

 

input file name for RMS, applied if the file name is specified

masked_value

0.

amplitude intensity value (in ADU) substituted for masked pixels

threshold_nrms

3.

threshold as a number of sigmas from file fname_nrmssigmas to pixel_rms parameters

threshold

0.

constant common low level threshold in ADU

below_thre_value

0.

the amplitude intensity substituted in for pixels below threshold

bkgd_ind_min

0

minimal index in flatten ndarray, which is used for background normalization

bkgd_ind_max

100

maximal index in flatten ndarray, which is used for background normalization

bkgd_ind_inc

2

index increment in flatten ndarray, which is used for background normalization

print_bits

0

verbosity:

  • =0 - print nothing
  • +1 - input pars
  • +2 - calibration parameters
  • +4 - common mode algorithm parameters
  • +8 - ndarray parameters; type, ndim, shape, etc.
  • +16- time stamp for each event
  • +32 - first 10 elements of the raw image data
  • +64 - first 10 elements of the calibrated image data

...