Updated docstrings for k-gain and non-linearity calibration #216
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.
Describe your changes
As part of the effort to review the doc in the calibration functions before moving to e2e simulations, I have updated docstrings for calibrate_kgain.py and calibrate_nonlin.py
Type of change
I have updated the main docstrings of calibrate_kgain.py and calibrate_nonlin.py describing what the data structure is in a common fashion for both calibration functions. The same information can be found on Confluence (link). It has been run thru Guillermo Gonzalez.
I also fixed a condition on the number of frames used to calibrate non-linearity in calibrate_nonlin.py
I have checked that e2e tests pass the same way as before the docstring changes.
Checklist before requesting a review