Page History
...
The only difference in interface of this module from previous is in the default name for the source parameter and the output file name.
parameter | default value | description |
---|---|---|
| "DetInfo(SxrBeamline.0:Opal1000.1)" | source of data for Opal camera |
or:
parameter | default value | description |
---|---|---|
| "DetInfo(:Princeton)" | source of data for Princeton camera |
See also Example for Package ImgPixSpectra.
...
This module measures the time interval for entire job and for each dn
events and prints the rate info as requested by the print_bits
parameter.Module configuration parameters:
parameter | default value | description |
---|---|---|
|
...
100 | number of events between printout | |
|
...
2 | filter verbosity:
|
...
|
...
|
...
|
...
|
...
See also Example for Module ImgAlgos::Tahometer.
...
This module passes only the events if their time stamp is in the requested range.
The range of allowed time stamps is defined by the configuration parameters.
Module configuration parameters:
...
parameter | default value | description |
---|---|---|
| "1970-01-01 00:00:00.000000000 / 2100-01-01 00:00:00.000000000" |
...
time-stamp interval string | |
|
...
"1970-01-01 00:00:00.000000000" |
...
minimal time-stamp string | |
|
...
"2100-01-01 00:00:00.000000000" |
...
maximal time-stamp string | |
|
...
true | On/Off the filter | |
|
...
0 | filter verbosity:
|
...
|
...
|
...
|
...
|
...
The time-stamp string is accepted in various formats:
...
Note |
---|
The unique parameter associated with the event is a time-stamp. The event number is not defined in the xtc file and is not a recommended to use parameter. The events are counted locally inside this filter from the beginning of job starting from 0. Be cautious of using this filter in consecutive jobs for different runs! For example, this filter returns different subsets of events for the files with raw and selected events. |
Module configuration parameters:
...
parameter | default value | description |
---|---|---|
| true | On/Off filter |
...
|
...
0 | the first event from the beginning of job, starting from 0 |
...
|
...
1<<31 | the last event from the beginning of job |
...
|
...
| the string of events of intervals from the beginning of job |
...
|
...
0 | filter verbosity:
|
...
|
...
|
...
|
...
There are two modes of operation of this filter.
...
- gets the pnccd data from the event, based on specified
source
andinkey
parameters, - puts the
ndarray<double,2>
object with pnccd 1024x1024 image in the event using specifiedoutimgkey
parameter.
...
parameter | default value | description |
---|---|---|
|
...
"DetInfo(:pnCCD)" |
...
source of data |
...
|
...
| key for input data |
...
|
...
"pnccdimg" |
...
output key for image saved in event |
...
|
...
0 | verbosity:
|
...
|
...
|
...
|
...
See also Example for Module ImgAlgos::PnccdImageProducer.
...
- gets any camera image data from the event, based on specified
source
andkey_in
parameters, - puts the
ndarray<double,2>
object with camera image in the event using specifiedkey_out
parameter.
Module configuration parameters:
...
parameter | default value | description |
---|---|---|
| "DetInfo(:Opal1000)" |
...
source of data |
...
|
...
| key for input data |
...
|
...
"pnccdimg" |
...
output key for image saved in event |
...
|
...
true | on/off the amplitude offset using configuration data | |
|
...
0 | verbosity:
|
...
|
...
|
...
|
...
|
...
See also Example for Module ImgAlgos::CameraImageProducer.
...
- gets the Princeton camera image data from the event, based on specified
source
andkey_in
parameters, - puts the
ndarray<uint16_t,2>
object with image in the event using specifiedkey_out
parameter.
Module configuration parameters:
...
parameter | default value | description |
---|---|---|
| "DetInfo(:Princeton)" |
...
source of data |
...
|
...
| key for input data |
...
|
...
"image" |
...
output key for image saved in event |
...
|
...
0 | verbosity:
|
...
|
...
|
...
|
...
|
...
|
...
See also Example for Module ImgAlgos::PrincetonImageProducer.
...
- 0-stage: the pixel amplitudes are averaged without any constrains for events from 0 to
evts_stage1
, the preliminary averaged and rms values are defined for each pixel at the end of this stage. - 1-stage: starting from event
evts_stage1
the pixel data are collected only forabs(amplitude-average0) < gate_width1
. At the end of this stage the preliminary averaged and rms values are defined for each pixel. - 2-stage: starting from the event
evts_stage1 + evts_stage2
the pixel data are collected only forabs(amplitude-average1) < gate_width2
. At the end of this stage the preliminary averaged and rms values are defined for each pixel and saved in the files specified by theavefile
andrmsfile
parameters, respectively.
This 3-stage averaging algorithm eliminates large statistical fluctuations in the pixel amplitude spectrum.
Module configuration parameters:
...
parameter | default value | description |
---|---|---|
| "DetInfo(:Opal1000") |
...
input source of data | |
|
...
| key for input data, for example, it might be "calibrated" | |
|
...
"img-ave.dat" |
...
out file with averaged amplitudes | |
|
...
"img-rms.dat" |
...
out file with rms | |
|
...
| out file with hot pixel mask, saved if the name is not empty | |
|
...
"10000." |
...
threshold on rms (in ADU); if rms exceeds this threshold - pixel is hot |
...
|
...
1000000 | number of events before stage 1 | |
|
...
0 | additional number of events before stage 2 | |
|
...
0 | gate_width for stage 1 | |
|
...
0 | gate_width for stage 2 | |
|
...
0 | module verbosity:
|
...
|
...
|
...
|
...
|
...
|
...
Default parameters are set for regular single-stage averaging without any constrains.
See also Example for Module ImgAlgos::ImgAverage.
...
The S/N is estimated by averaging over neigbouring pixels.
Module configuration parameters:
...
parameter | default value | description |
---|---|---|
| "DetInfo(:Opal1000") |
...
input source of data |
...
|
...
| key for input data, for example, it might be "calibrated" |
...
|
...
"img-mask-satu.dat" |
...
out file with saturated mask |
...
|
...
"img-mask-nois.dat" |
...
out file with noise mask |
...
|
...
"img-mask-comb.dat" |
...
out file with combined mask |
...
|
...
"img-frac-satu.dat" |
...
out file with fraction of saturated events |
...
|
...
"img-frac-nois.dat" |
...
out file with fraction of noisy events |
...
|
...
1000000 | saturation-threshold (in ADU if the gain correction was not applied to image) |
...
|
...
0 | allowed fraction of saturated events |
...
|
...
1 | radial size of the area for S/N evaluation | |
|
...
3 | noise-threshold ( in ADU if the gain correction was not applied to image) |
...
|
...
0.5 |
...
allowed fraction of noisy events |
...
|
...
0 | module verbosity:
|
...
|
...
|
...
|
...
|
...
|
...
See also Example for Module ImgAlgos::ImgMaskEvaluation.
...
- All files with input calibration parameters should have the same shape as image and formatted as regular text file containing 2d matrix (table) of float (or integer) values, with columns separated by space(s), ' ', and rows(lines) terminated by the '\n'.
- Background normalization is performed in window defined by the parameters
bkgd_row_min
,bkgd_row_max
,bkgd_col_min
, andbkgd_col_max
. Normalization factorN
is evaluated for pixel amplitudes in this window as:
N = sum(A_raw - pedestal) / sum(A_bkgd)
. - Masking algorithm assumes that good pixels in the
fname_mask
file should be marked by '1' (ones) and bad pixels – by '0' (zeros). Mask is applied as a last correction. The bad masked pixel amplitudes are substituted by themasked_value
.
Module configuration parameters:
...
parameter | default value | description |
---|---|---|
| "DetInfo(:Camera)" |
...
source of data |
...
|
...
| key for input image |
...
|
...
"calibrated" |
...
output key for calibrated image saved in event |
...
|
...
| input file name for pedestals, applied if the file name is specified |
...
|
...
| input file name for background, applied if the file name is specified |
...
|
...
| input file name for gain, applied if the file name is specified |
...
|
...
| input file name for mask, applied if the file name is specified |
...
|
...
| input file name for RMS, applied if the file name is specified |
...
|
...
0. |
...
amplitude value (in ADU) substituted for masked pixels |
...
|
...
3. |
...
threshold as a number of sigmas from file |
...
|
...
0. |
...
constant low level threshold in ADU |
...
|
...
0. |
...
the amplitude substituted in pixels below threshold |
...
|
...
false | if true - low level |
...
|
...
0 | the window in image, which is used for background normalization |
...
|
...
10 | the window in image, which is used for background normalization |
...
|
...
0 | the window in image, which is used for background normalization |
...
|
...
10 | the window in image, which is used for background normalization |
...
|
...
0 | verbosity:
|
...
|
...
|
...
|
...
|
The pedestal, background, gain, mask, and N*RMS corrections are applied if associated file name is specified.
The constant low level threshold is applied if do_threshold
is true.
Corrections are not applied by default or with empty file names.
...