Option to randomly override a hard veto
Created by: sophiaandaloro
Let's try this again:) What is the problem / what does the code in this PR do
- Adds an additional setting to the Software HE Veto step in pulse_processing, requested for certain commissioning & calibration applications, for us to optionally pass some random (configurable) fraction of peaks that are otherwise vetoed. This allows us to keep statistics rather than a hard cutoff at a certain PE.
Can you briefly describe how it works?
- Set the
'fractional_pass'
configuration option to non-zero (between 0 and 1) and that fraction of peaks which are vetoed in the current configuration will randomly get selected to pass anyway.
Can you give a minimal working example (or illustrate with a figure)? See this note which uses it, especially in the plots of the peaks. (Plots not included here since the data may be sensitive at the moment)
Please include the following if applicable:
- Update the docstring(s) --> Done.
- Update the documentation --> Done.
- Tests to check the (new) code is working as desired. --> Done in study (linked above)
- Does it solve one of the open issues on github?
Please make sure that all automated tests have passed before asking for a review (you can save the PR as a draft otherwise).