Skip to content

Docs: Add docstring to _calibrate method in AnalogInput #264

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

Open
vabhravi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs: Add docstring to _calibrate method in AnalogInput #264

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bbaa17
Docs: Add docstring to _calibrate method in AnalogInput
vabhravi Jan 28, 2026
c7d6293
Docs: Remove placeholder text and fix whitespace
vabhravi Jan 28, 2026
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
30 changes: 18 additions & 12 deletions pslab/instrument/analog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,20 @@ def resolution(self, value: int):
self._resolution = 2**value - 1
self._calibrate()

def _calibrate(self):
A = INPUT_RANGES[self._name][0] / self._gain
B = INPUT_RANGES[self._name][1] / self._gain
slope = B - A
intercept = A
self._scale = np.poly1d([slope / self._resolution, intercept])
self._unscale = np.poly1d(
def _calibrate(self):
"""
Calculates the scaling coefficients based on current gain and resolution.

This updates the internal _scale and _unscale callables as a side effect,
preparing them to convert between raw integer ADC values and floating
point voltages.
"""
A = INPUT_RANGES[self._name][0] / self._gain
B = INPUT_RANGES[self._name][1] / self._gain
slope = B - A
intercept = A
self._scale = np.poly1d([slope / self._resolution, intercept])
self._unscale = np.poly1d(
[self._resolution / slope, -self._resolution * intercept / slope]
)

Expand Down Expand Up @@ -239,8 +246,7 @@ def lowres_waveform_table(self) -> np.ndarray:
"""numpy.ndarray: 32-value waveform table loaded on this output."""
# Max PWM duty cycle out of 64 clock cycles.
return self._range_normalize(self._waveform_table[::16], 63)

def _range_normalize(self, x: np.ndarray, norm: int = 1) -> np.ndarray:
"""Normalize waveform table to the digital output range."""
x = (x - self.RANGE[0]) / (self.RANGE[1] - self.RANGE[0]) * norm
return np.int16(np.round(x)).tolist()
def _range_normalize(self, x: np.ndarray, norm: int = 1) -> np.ndarray:
"""Normalize waveform table to the digital output range."""
x = (x - self.RANGE[0]) / (self.RANGE[1] - self.RANGE[0]) * norm
return np.int16(np.round(x)).tolist()