Introduce trigger count bin mode to replace AVERAGE with DISTRIBUTION
Explanation of changes
Introduce a new bin mode specifically for the trigger count acquisition, when it creates a distribution for the number of triggers. This replaces the AVERAGE bin mode for trigger count.
The proposed bin mode name: DISTRIBUTION.
Motivation of changes
the AVERAGE bin mode for trigger count works very differently than for other protocols when AVERAGE is used. If AVERAGE is used in the current form for the trigger count, then the AVERAGE bin mode works inconsistently.
Merge checklist
See also merge request guidelines
-
Merge request has been reviewed (in-depth by a knowledgeable contributor), and is approved by a project maintainer. -
New code is covered by unit tests (or N/A). -
New code is documented and docstrings use numpydoc format (or N/A). -
New functionality: considered making private instead of extending public API (or N/A). -
Public API changed: added @deprecatedand entry in deprecated code suggestions (or N/A). -
Newly added/adjusted documentation and docstrings render properly (or N/A). -
Pipeline fix or dependency update: post in #software-for-developerschannel to mergemainback in or update local packages (or N/A). -
Tested on hardware (or N/A). -
CHANGELOG.mdfor breaking changes andAUTHORS.mdhave been updated (or N/A). -
Update Hardware backends documentation if backend interface change or N/A -
Check whether performance is significantly affected by looking at the Performance metrics results. -
Windows tests in CI pipeline pass (manually triggered by maintainers before merging). - Maintainers do not hit Auto-merge, we need to actively check as manual tests do not block pipeline
For reference, the issues workflow is described in the contribution guidelines.
Summary by CodeRabbit
Release Notes
-
New Features
- Introduced a new bin mode,
BinMode.DISTRIBUTION, for the "Trigger Count" acquisition protocol. - Updated tutorials and documentation with detailed examples for various acquisition protocols.
- Introduced a new bin mode,
-
Bug Fixes
- Adjusted handling of trigger count data to support the new distribution format.
-
Documentation
- Enhanced clarity and comprehensiveness of acquisition protocols documentation.
- Updated tutorial to reflect changes in bin modes and their implications.
-
Tests
- Updated test cases to reflect the transition from
BinMode.AVERAGEtoBinMode.DISTRIBUTION. - Added tests for deprecation warnings related to the use of
BinMode.AVERAGE.
- Updated test cases to reflect the transition from
Edited by Gábor Oszkár Dénes