From 4c9cc940f99630f0290dfacf83eb055faa453879 Mon Sep 17 00:00:00 2001 From: Robert Moerland Date: Fri, 14 Jul 2023 13:45:54 +0200 Subject: [PATCH] force_calibration: minor docstring fixes --- lumicks/pylake/force_calibration/detail/hydrodynamics.py | 8 ++++---- lumicks/pylake/force_calibration/detail/power_models.py | 1 - 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/lumicks/pylake/force_calibration/detail/hydrodynamics.py b/lumicks/pylake/force_calibration/detail/hydrodynamics.py index 16ff46751..92f4e38a6 100644 --- a/lumicks/pylake/force_calibration/detail/hydrodynamics.py +++ b/lumicks/pylake/force_calibration/detail/hydrodynamics.py @@ -29,7 +29,7 @@ def calculate_dissipation_frequency(gamma0, bead_radius, rho_bead): Parameters ---------- gamma0 : float - drag coefficient [mPas] + drag coefficient [m Pa s] bead_radius : float radius of the bead [m] rho_bead : float @@ -57,7 +57,7 @@ def calculate_complex_drag(f, gamma0, rho_sample, bead_radius, distance_to_surfa f : array_like Frequency [Hz] gamma0 : float - Drag coefficient [mPas] + Drag coefficient [m Pa s] bead_radius : float Bead radius [m] rho_sample : float @@ -132,7 +132,7 @@ def passive_power_spectrum_model_hydro( diffusion_constant : float Diffusion constant, in (a.u.)^2/s gamma0 : float - Drag coefficient, in mPas. + Drag coefficient, in m Pa s. bead_radius : float Bead radius, in m. rho_sample : float @@ -173,7 +173,7 @@ def theoretical_driving_power_hydrodynamics( driving_amplitude : float Driving amplitude [m] gamma0 : float - Drag coefficient [mPas] + Drag coefficient [m Pa s] bead_radius : float Bead radius [m] rho_sample : float diff --git a/lumicks/pylake/force_calibration/detail/power_models.py b/lumicks/pylake/force_calibration/detail/power_models.py index 8287655d0..4bb5b4ddb 100644 --- a/lumicks/pylake/force_calibration/detail/power_models.py +++ b/lumicks/pylake/force_calibration/detail/power_models.py @@ -25,7 +25,6 @@ def fit_analytical_lorentzian(ps): - `sigma_fc`, `sigma_D`: 1-sigma confidence intervals for `fc` and `D` - `ps_fit`: :class:`~lumicks.pylake.force_calibration.power_spectrum.PowerSpectrum` object with model fit - Note: returns None if the fit fails. """ FitResults = namedtuple( "AnalyticalLorentzianFitResults", ["fc", "D", "sigma_fc", "sigma_D", "ps_fit"]