User guide updates bpm panel #197
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JoschD
added
Type: Documentation
…e_updates_bpm_panel
…e_updates_bpm_panel
fsoubelet
reviewed
Aug 19, 2025
Comment on lines
+138
to
+147
| ### Averages, Removal of Turns and Splitting Files | ||
|
|
||
| !!! warning "Broken Functionality" | ||
| These features [are currently broken][issue283] and we are considering whether they are actually needed. | ||
|
|
||
| It contains BPM names and corresponding threshold which identified a BPM as faulty. | ||
| The buttons on the top left side of the pane provide some features to handle the BPM data. | ||
|
|
||
| !!! note | ||
| - ++"Create Average"++ allows loading several data files too visualize their average repesentations on the same graph, which helps detecting differences or reducing noise. | ||
| - ++"Remove Turns"++ can be used to cut turns from the start or the end, to focus on a specified range of the data. | ||
| - ++"Split Files"++ splits the current BPM data file into N files, where N is specified in the dialog and the resulting files will have old-turns/N turns. |
There was a problem hiding this comment.
Curious to get the opinion of @emaclean. I'd rather have these disappears, as stated on the linked issue we can just do that, but another way.
There was a problem hiding this comment.
Discuss on the linked issue?
There was a problem hiding this comment.
Yes but it also impacts this PR so if it's a quick discussion we might settle it here
There was a problem hiding this comment.
still a long way to merge into the master branch ;)
JoschD
removed
the
Status: Blocked
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a description of the BPM panel to the Beta-Beat-GUI section.
Requires #188 to be merged first and back into this branch (will then also reduce the number of files changed)