RoiCollection¶
The Roi collection plugin can be used to do data reduction on the image by providing a large number of Roi. The result will a spectrum of data. The spectrum (command readSpectrum) is containing the ROI integration value of the pixels.
In addition to the statistics calculation you can provide a mask file (setMask command or MaskFile property/attribute) where null pixel will not be taken into account.
If you have a detector with pixels which randomly return wrong high count rate, you can use the OverflowThreshold attribute to cut off those defective pixels.
Properties¶
Property name |
Mandatory |
Default value |
Description |
---|---|---|---|
BufferSize |
No |
128 |
Circular buffer size in image |
MaskFile |
No |
“” |
A mask file |
Attributes¶
Attribute name |
RW |
Type |
Description |
---|---|---|---|
BufferSize |
rw |
DevLong |
Circular buffer size in image, default is 128 |
CounterStatus |
ro |
DevLong |
Counter related to the current number of proceeded images |
OverflowThreshold |
rw |
DevLong |
cut off pixels above the threshold value |
MaskFile |
rw |
DevString |
The mask file |
RunLevel |
rw |
DevLong |
Run level in the processing chain, from 0 to N |
State |
ro |
State |
OFF or ON (stopped or started) |
Status |
ro |
DevString |
“OFF” “ON” (stopped or started) |