Documentation. Add parameters reference#341
Open
h-mayorquin wants to merge 3 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
12 tasks
Collaborator
pauladkisson
left a comment
pauladkisson
left a comment
There was a problem hiding this comment.
Awesome, very helpful.
| @@ -0,0 +1,259 @@ | |||
| # Input parameter reference | |||
|
|
|||
| Every parameter the GuPPy GUI exposes, organized to match what you see on screen. The page mirrors the three cards on the homepage (**Individual Analysis**, **Group Analysis**, **Visualization Parameters**) and the visual sub-groupings inside each card. Each row gives the parameter as it appears in the GUI, a one-line description of what it does, the data type, the default value, and the accepted values or range. Prose paragraphs underneath cover the parameters that need more than a single line. | |||
Collaborator
There was a problem hiding this comment.
The GUI now uses five cards in the homepage. Could you update this reference with the two new ones: Input folder selection and Output folder selection?
| | Eliminate first few seconds | Drop the LED-warmup transient at the start. | int | `1` | non-negative seconds | | ||
| | Window for Moving Average filter | Width of the smoothing kernel. | int | `100` | positive integer, in samples (not seconds) | | ||
|
|
||
| **Isosbestic Control Channel?** declares whether the recording includes a 405 nm control channel. When `True`, preprocessing fits the control trace to the signal trace by linear regression and subtracts the fitted control to remove motion artifacts and photobleaching that affect both wavelengths equally. When `False`, the regression-and-subtract step is skipped and only the signal trace is z-scored. See the [isosbestic correction explainer](../explanation/isosbestic_correction.md) for the underlying biology and math. |
Collaborator
There was a problem hiding this comment.
When false, a synthetic control channel is created.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As in the title.
https://guppy--341.org.readthedocs.build/reference/parameters.html