Skip to content

Corrected get_onboard_QC_values docstring to include sweeps. #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MichaelClerx merged 1 commit into from
Oct 17, 2025
Merged

Corrected get_onboard_QC_values docstring to include sweeps. #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions syncropatch_export/trace.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,10 +274,16 @@ def get_onboard_QC_values(self, sweeps=None):
"""
Return the quality control values Rseal, Cslow (Cm), and Rseries.

Args:
sweeps (list): A list of sweep indexes to return, e.g.
``[0, 1, 2]``. If left at its default value ``None``, data for all
sweeps will be returned.

Returns:
A dict mapping well names ('A01' up to 'P24') to tuples
``(R_seal, Cm, R_series)`` containing the seal resistance, membrane
capacitance, and series resistance.
A dict mapping well names ('A01' up to 'P24') to lists of tuples
(one tuple per sweep), where each tuple ``(R_seal, Cm, R_series)``
provides the seal resistance, membrane capacitance, and series
resistance.

"""

Expand Down