Versions Compared

Old Version 89

changes.mady.by.user Mikhail Dubrovin

Saved on

compared with

New Version 90

changes.mady.by.user Mikhail Dubrovin

Saved on

Key

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

...

If all file names are empty (by default), the files with pre-defined names "arr-ave-<exp>-r<run>.dat" and "arr-rms-<exp>-r<run>.dat" will be saved for averaged and rms arrays, respectively. Otherwise, the files with specified names will be saved.
Default parameters are set for regular single-stage averaging without any constrains.
See also Example for Module ImgAlgos::NDArrAverage.

Module ImgAlgos::NDArrCalib

  • ImgCalib uses the source and key_in parameters to get the input raw image (as ndarray<T,NDIM> object), where T stands for uint16_t, int, float, uint8_t, or double, NDim≤5,
  • automaticly gets parameters from calibration store for types pedestals, common_mode, pixel_status, pixel_gain,
  • get parameters from user-defined files fname_bkgd,  fname_mask, and fname_nrms, if their names are specified,

  • the specified by the file name corrections are applied per-pixel to raw data  ndarray<T,NDIM> as follows:

    1. subtracts pedestals,
    2. subtracts common mode,
    3. subtracts normalized background,
    4. apply gain factors,
    5. apply hot/bad pixel_status mask,
    6. apply mask, and
    7. apply threshold as a constant low level,
    8. apply threshold as N*RMS,
  • and saves the corrected ndarray<double,NDim> in the event with key key_out

 

 

Code Block
bgColor#F7F7ED
A_cor = A_raw
        (1) - pedestal               | if pedestals are available in calib store
        (2) - N*background           | if the file name is specified in the parameter "fname_bkgd"
        (3) * gain                   | if pixel_gain are available in calib store
        (4) apply hot/bad pixel mask | if pixel_status are available in calib store
        (5) apply mask               | if the file name is specified in the parameter "fname_mask"
        (6) apply N*RMS threshold    | if the file name is specified in the parameter "fname_nrms"
        (7) apply threshold          | if the "do_threshold" = true

 


Configuration parameters

parameter

default value

description

source

DetInfo(:Camera)

source of data

key_in

 

key for input image

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 filefname_nrms  is available

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 value (in ADU) substituted for masked pixels

threshold_nrms

3.

threshold as a number of sigmas from file fname_nrms

threshold

0.

constant low level threshold in ADU

below_thre_value

0.

the amplitude substituted in 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

See also Example for Module ImgAlgos::NDArrCalib.

Module ImgAlgos::ImgAverage

This module averages over events the per-pixel data of the image array (ndarray<double,2>) and saves files for averaged, rms values, and, if requested, the hot pixel mask. Input data can be specified by the source and key parameters. Averaging may have up to three stages, depending on configuration parameters:

...