Commit 3191933a authored by remi.clement@inrae.fr's avatar remi.clement@inrae.fr
Browse files

add doc for python api example

Showing with 11 additions and 8 deletions
+11 -8
...@@ -73,6 +73,7 @@ Ohmpi 2 step by step ...@@ -73,6 +73,7 @@ Ohmpi 2 step by step
Ohmpi_V2_00/V2_00_step_02 Ohmpi_V2_00/V2_00_step_02
Ohmpi_V2_00/V2_00_step_03 Ohmpi_V2_00/V2_00_step_03
Ohmpi_V2_00/V2_00_step_04 Ohmpi_V2_00/V2_00_step_04
Ohmpi_V2_00/V2_00_usage
......
...@@ -527,31 +527,34 @@ class OhmPi(object): ...@@ -527,31 +527,34 @@ class OhmPi(object):
def run_measurement(self, quad=[1, 2, 3, 4], nb_stack=None, injection_duration=None, def run_measurement(self, quad=[1, 2, 3, 4], nb_stack=None, injection_duration=None,
tx_volt=5, autogain=True, best_tx_injtime=0.1, strategy='constant'): autogain=True, strategy='constant', tx_volt=5, best_tx_injtime=0.1):
"""Do a 4 electrode measurement and measure transfer resistance obtained. """Do a 4 electrode measurement and measure transfer resistance obtained.
Parameters Parameters
---------- ----------
quad : list of int quad : list of int
Quadrupole to measure. Quadrupole to measure, just for labelling. Only switch_mux_on/off
really create the route to the electrodes.
nb_stack : int, optional nb_stack : int, optional
Number of stacks. A stacl is considered two half-cycles (one Number of stacks. A stacl is considered two half-cycles (one
positive, one negative). positive, one negative).
injection_duration : int, optional injection_duration : int, optional
Injection time in seconds. Injection time in seconds.
tx_volt : float, optional
If specified, voltage will be imposed. If 0, we will look
for the best voltage. If a best Tx cannot be found, no
measurement will be taken and values will be NaN.
autogain : bool, optional autogain : bool, optional
If True, will adapt the gain of the ADS1115 to maximize the If True, will adapt the gain of the ADS1115 to maximize the
resolution of the reading. resolution of the reading.
strategy : str, optional strategy : str, optional
If we search for best voltage (tx_volt == 0), we can choose (V3.0 only) If we search for best voltage (tx_volt == 0), we can choose
different strategy: different strategy:
- vmin: find lowest voltage that gives us a signal - vmin: find lowest voltage that gives us a signal
- vmax: find max voltage that are in the range - vmax: find max voltage that are in the range
For a constant value, just set the tx_volt. For a constant value, just set the tx_volt.
tx_volt : float, optional
(V3.0 only) If specified, voltage will be imposed. If 0, we will look
for the best voltage. If a best Tx cannot be found, no
measurement will be taken and values will be NaN.
best_tx_injtime : float, optional
(V3.0 only) Injection time in seconds used for finding the best voltage.
""" """
# check arguments # check arguments
if nb_stack is None: if nb_stack is None:
......
...@@ -11,7 +11,6 @@ seq = np.c_[a, b, m, n] ...@@ -11,7 +11,6 @@ seq = np.c_[a, b, m, n]
k = OhmPi(idps=True) k = OhmPi(idps=True)
k.pardict['injection_duration'] = 0.5 k.pardict['injection_duration'] = 0.5
k.pardict['nb_stack'] = 1 k.pardict['nb_stack'] = 1
k.pardict['tx_volt'] = 0
k.pardict['nbr_meas'] = 1 k.pardict['nbr_meas'] = 1
#k.sequence = seq #k.sequence = seq
#k.reset_mux() #k.reset_mux()
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment