Methods
This page contains a listing of all available techniques in PyPalmSens.
For example to set up a CV experiment:
import pypalmsens as ps
method = pypalmsens.CyclicVoltammetry(
begin_potential = -1,
vertex1_potential = -1,
vertex2_potential = 1,
step_potential = 0.25,
scanrate = 5,
n_scans = 2,
current_range = pypalmsens.settings.CurrentRange(
max = pypalmsens.settings.CURRENT_RANGE.cr_1_mA,
min = pypalmsens.settings.CURRENT_RANGE.cr_100_nA,
start = pypalmsens.settings.CURRENT_RANGE.cr_100_uA,
),
)
Shared settings
Many configuration settings are shared between methods, like the current ranges above or versus OCP or trigger settings. These are listed in Method settings. |
pypalmsens
Classes:
-
ACVoltammetry – Create AC Voltammetry method parameters.
-
ChronoAmperometry – Create chrono amperometry method parameters.
-
ChronoCoulometry – Create linear sweep method parameters.
-
ChronoPotentiometry – Create potentiometry method parameters.
-
CyclicVoltammetry – Create cyclic voltammetry method parameters.
-
DifferentialPulseVoltammetry – Create differential pulse voltammetry method parameters.
-
ElectrochemicalImpedanceSpectroscopy – Create potentiometry method parameters.
-
FastAmperometry – Create fast amperometry method parameters.
-
FastCyclicVoltammetry – Create fast cyclic voltammetry method parameters.
-
FastGalvanostaticImpedanceSpectroscopy – Create fast galvanostatic impededance spectroscopy method parameters.
-
FastImpedanceSpectroscopy – Create fast impedance spectroscopy method parameters.
-
GalvanostaticImpedanceSpectroscopy – Create potentiometry method parameters.
-
LinearSweepPotentiometry – Create linear sweep potentiometry method parameters.
-
LinearSweepVoltammetry – Create linear sweep method parameters.
-
MethodScript – Create a method script sandbox object.
-
MultiplePulseAmperometry – Create multiple pulse amperometry method parameters.
-
MultiStepAmperometry – Create multi-step amperometry method parameters.
-
MultiStepPotentiometry – Create multi-step potentiometry method parameters.
-
NormalPulseVoltammetry – Create normal pulse voltammetry method parameters.
-
OpenCircuitPotentiometry – Create open circuit potentiometry method parameters.
-
PulsedAmperometricDetection – Create pulsed amperometric detection method parameters.
-
SquareWaveVoltammetry – Create square wave method parameters.
-
StrippingChronoPotentiometry – Create stripping potentiometry method parameters.
ACVoltammetry
Create AC Voltammetry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
begin_potential (float) – Begin potential in V.
-
end_potential (float) – End potential in V.
-
step_potential (float) – Step potential in V.
-
ac_potential (float) – Sine wave amplitude in V as rms value.
-
measure_dc_current (bool) – Measure the DC current seperately.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
ChronoAmperometry
Create chrono amperometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
current_limits (CurrentLimits) – Set the current limit settings.
-
charge_limits (ChargeLimits) – Set the charge limit settings
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
interval_time (float) – Interval time in s.
-
enable_bipot_current (bool) – Enable bipot current.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
current_limits
current_limits: settings.CurrentLimits = attrs.field(factory=(settings.CurrentLimits))
Set the current limit settings.
charge_limits
charge_limits: settings.ChargeLimits = attrs.field(factory=(settings.ChargeLimits))
Set the charge limit settings
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
ChronoCoulometry
Create linear sweep method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
current_limits (CurrentLimits) – Set the current limit settings.
-
charge_limits (ChargeLimits) – Set the charge limit settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
interval_time (float) – Interval time in s.
-
step1_potential (float) – Potential applied during first step in V.
-
step1_run_time (float) – Run time for the first step.
-
step2_potential (float) – Potential applied during second step in V.
-
step2_run_time (float) – Run time for the second step.
-
bandwidth (None | float) – Override bandwidth on MethodSCRIPT devices if set.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
current_limits
current_limits: settings.CurrentLimits = attrs.field(factory=(settings.CurrentLimits))
Set the current limit settings.
charge_limits
charge_limits: settings.ChargeLimits = attrs.field(factory=(settings.ChargeLimits))
Set the charge limit settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
ChronoPotentiometry
Create potentiometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
potential_limits (PotentialLimits) – Set the potential limit settings
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
current (float) – The current to apply in the given current range.
-
applied_current_range (CURRENT_RANGE) – Applied current range.
-
interval_time (float) – Interval time in s (default: 0.1)
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_current (bool) – Record working electrode current.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
potential_limits
potential_limits: settings.PotentialLimits = attrs.field(factory=(settings.PotentialLimits))
Set the potential limit settings
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
current
current: float = 0.0
The current to apply in the given current range.
Note that this value acts as a multiplier in the applied current range.
So if 10 uA is the applied current range and 1.5 is given as current value, the applied current will be 15 uA.
applied_current_range
applied_current_range: CURRENT_RANGE = CURRENT_RANGE.cr_100_uA
Applied current range.
Use CURRENT_RANGE
to define the range.
CyclicVoltammetry
Create cyclic voltammetry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
equilibration_time (float) – Equilibration time in s
-
begin_potential (float) – Begin potential in V
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
vertex1_potential (float) – Vertex 1 potential in V
-
vertex2_potential (float) – Vertex 2 potential in V
-
step_potential (float) – Step potential in V
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
enable_bipot_current (bool) – Enable bipot current.
-
current_limits (CurrentLimits) – Set the current limit settings.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
data_processing (DataProcessing) – Set the data processing settings.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
current_limits
current_limits: settings.CurrentLimits = attrs.field(factory=(settings.CurrentLimits))
Set the current limit settings.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
record_we_potential
record_we_potential: bool = False
Record applied working electrode potential.
Reference electrode vs ground.
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
DifferentialPulseVoltammetry
Create differential pulse voltammetry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
begin_potential (float) – Begin potential in V.
-
end_potential (float) – End potential in V.
-
step_potential (float) – Step potential in V.
-
pulse_potential (float) – Pulse potential in V.
-
pulse_time (float) – Pulse time in s.
-
enable_bipot_current (bool) – Enable bipot current.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
ElectrochemicalImpedanceSpectroscopy
Create potentiometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
equilibration_time (float) – Equilibration time in s.
-
dc_potential (float) – DC potential in V.
-
ac_potential (float) – AC potential in V RMS.
-
n_frequencies (int) – Number of frequencies.
-
max_frequency (float) – Maximum frequency in Hz.
-
min_frequency (float) – Minimum frequency in Hz.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
FastAmperometry
Create fast amperometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
current_limits (CurrentLimits) – Set the current limit settings.
-
charge_limits (ChargeLimits) – Set the charge limit settings
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
current_range (CURRENT_RANGE) – Fixed current range.
-
equilibration_time (float) – Equilibration time in s.
-
equilibration_potential (float) – Equilibration potential in V.
-
interval_time (float) – Interval time in s.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
current_limits
current_limits: settings.CurrentLimits = attrs.field(factory=(settings.CurrentLimits))
Set the current limit settings.
charge_limits
charge_limits: settings.ChargeLimits = attrs.field(factory=(settings.ChargeLimits))
Set the charge limit settings
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
FastCyclicVoltammetry
Create fast cyclic voltammetry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
data_processing (DataProcessing) – Set the data processing settings.
-
current_range (CURRENT_RANGE) – Fixed current range.
-
equilibration_time (float) – Equilibration time in s
-
begin_potential (float) – Begin potential in V
-
vertex1_potential (float) – Vertex 1 potential in V
-
vertex2_potential (float) – Vertex 2 potential in V
-
step_potential (float) – Step potential in V
-
n_avg_scans (int) – Number of scans to be averaged.
-
n_equil_scans (int) – Number of equilibration scans.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
FastGalvanostaticImpedanceSpectroscopy
Create fast galvanostatic impededance spectroscopy method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
applied_current_range (CURRENT_RANGE) – Applied current range.
-
interval_time (float) – Interval time in s.
-
ac_current (float) – AC current in applied current range RMS.
-
dc_current (float) – DC current in applied current range.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
applied_current_range
applied_current_range: CURRENT_RANGE = CURRENT_RANGE.cr_100_uA
Applied current range.
Use CURRENT_RANGE
to define the range.
ac_current
ac_current: float = 0.01
AC current in applied current range RMS.
This value is multiplied by the applied current range.
FastImpedanceSpectroscopy
Create fast impedance spectroscopy method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
equilibration_time (float) – Equilibration time in s.
-
interval_time (float) – Interval time in s.
-
dc_potential (float) – Potential applied during measurement in V.
-
ac_potential (float) – Potential amplitude in V (rms).
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
GalvanostaticImpedanceSpectroscopy
Create potentiometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
applied_current_range (CURRENT_RANGE) – Applied current range.
-
equilibration_time (float) – Equilibration time in s.
-
ac_current (float) – AC current in applied current range RMS.
-
dc_current (float) – DC current in applied current range.
-
n_frequencies (int) – Number of frequencies.
-
max_frequency (float) – Maximum frequency in Hz.
-
min_frequency (float) – Minimum frequency in Hz.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
LinearSweepPotentiometry
Create linear sweep potentiometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
potential_limits (PotentialLimits) – Set the potential limit settings
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
delay_triggers (DelayTriggers) – Set the delayed trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
applied_current_range (CURRENT_RANGE) – Applied current range.
-
current_begin (float) – Current applied at beginning of measurement.
-
current_end (float) – Current applied at end of measurement.
-
current_step (float) – Current step.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_we_current (bool) – Record working electrode current.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
potential_limits
potential_limits: settings.PotentialLimits = attrs.field(factory=(settings.PotentialLimits))
Set the potential limit settings
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
delay_triggers
delay_triggers: settings.DelayTriggers = attrs.field(factory=(settings.DelayTriggers))
Set the delayed trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
applied_current_range
applied_current_range: CURRENT_RANGE = CURRENT_RANGE.cr_100_uA
Applied current range.
Use CURRENT_RANGE
to define the range.
current_begin
current_begin: float = -1.0
Current applied at beginning of measurement.
This value is multiplied by the defined current range.
current_end
current_end: float = 1.0
Current applied at end of measurement.
This value is multiplied by the defined current range.
current_step
current_step: float = 0.01
Current step.
This value is multiplied by the defined current range.
LinearSweepVoltammetry
Create linear sweep method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
current_limits (CurrentLimits) – Set the current limit settings.
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
begin_potential (float) – Begin potential in V.
-
end_potential (float) – End potential in V.
-
step_potential (float) – Step potential in V.
-
enable_bipot_current (bool) – Enable bipot current.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
current_limits
current_limits: settings.CurrentLimits = attrs.field(factory=(settings.CurrentLimits))
Set the current limit settings.
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
MethodScript
Create a method script sandbox object.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
script
script: str = 'e\nwait 100m\nif 1 < 2\n send_string "Hello world"\nendif\n\n'
Script to run.
For more info on MethodSCRIPT, see: https://www.palmsens.com/methodscript/ for more information.
MultiplePulseAmperometry
Create multiple pulse amperometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
duration_1 (float) – Duration of the first applied potential in s.
-
duration_2 (float) – Duration of the first applied potential in s.
-
duration_3 (float) – Duration of the first applied potential in s.
-
potential_1 (float) – First applied potential level at which the current is recorded in V.
-
potential_2 (float) – Second applied potential level at which the current is recorded in V.
-
potential_3 (float) – Third applied potential level at which the current is recorded in V.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
potential_1
potential_1: float = 0.0
First applied potential level at which the current is recorded in V.
potential_2
potential_2: float = 0.0
Second applied potential level at which the current is recorded in V.
MultiStepAmperometry
Create multi-step amperometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
current_limits (CurrentLimits) – Set the current limit settings.
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
interval_time (float) – Interval time in s.
-
levels (link:#list[link:#pypalmsens._methods._shared.ELevel]) – List of levels.
-
enable_bipot_current (bool) – Enable bipot current.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
current_limits
current_limits: settings.CurrentLimits = attrs.field(factory=(settings.CurrentLimits))
Set the current limit settings.
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
levels
levels: list[ELevel] = attrs.field(factory=(lambda: [ELevel()]))
List of levels.
Use ELevel()
to create levels.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
MultiStepPotentiometry
Create multi-step potentiometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
potential_limits (PotentialLimits) – Set the potential limit settings
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
applied_current_range (CURRENT_RANGE) – Applied current range.
-
interval_time (float) – Interval time in s.
-
levels (link:#list[link:#pypalmsens._methods._shared.ILevel]) – List of levels.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_we_current (bool) – Record applied working electrode potential.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
potential_limits
potential_limits: settings.PotentialLimits = attrs.field(factory=(settings.PotentialLimits))
Set the potential limit settings
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
applied_current_range
applied_current_range: CURRENT_RANGE = CURRENT_RANGE.cr_1_uA
Applied current range.
Use CURRENT_RANGE
to define the range.
levels
levels: list[ILevel] = attrs.field(factory=(lambda: [ILevel()]))
List of levels.
Use ILevel()
to create levels.
NormalPulseVoltammetry
Create normal pulse voltammetry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
begin_potential (float) – Begin potential in V.
-
end_potential (float) – End potential in V.
-
step_potential (float) – Step potential in V.
-
pulse_time (float) – Pulse time in s.
-
enable_bipot_current (bool) – Enable bipot current.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
OpenCircuitPotentiometry
Create open circuit potentiometry method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
potential_limits (PotentialLimits) – Set the potential limit settings
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
interval_time (float) – Interval time in s.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_we_current (bool) – Record working electrode current.
-
record_we_current_range (CURRENT_RANGE) – Record working electrode current range.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
potential_limits
potential_limits: settings.PotentialLimits = attrs.field(factory=(settings.PotentialLimits))
Set the potential limit settings
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
PulsedAmperometricDetection
Create pulsed amperometric detection method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
delay_triggers (DelayTriggers) – Set the delayed trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
pulse_potential (float) – Pulse potential in V.
-
pulse_time (float) – Pulse time in s.
-
interval_time (float) – Interval time in s.
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
delay_triggers
delay_triggers: settings.DelayTriggers = attrs.field(factory=(settings.DelayTriggers))
Set the delayed trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
SquareWaveVoltammetry
Create square wave method parameters.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
versus_ocp (VersusOCP) – Set the versus OCP settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
-
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
-
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
-
multiplexer (Multiplexer) – Set the multiplexer settings
-
data_processing (DataProcessing) – Set the data processing settings.
-
equilibration_time (float) – Equilibration time in s.
-
begin_potential (float) – Begin potential in V.
-
end_potential (float) – End potential in V.
-
step_potential (float) – Step potential in V.
-
amplitude (float) – Amplitude in V as half peak-to-peak value.
-
enable_bipot_current (bool) – Enable bipot current.
-
record_auxiliary_input (bool) – Record auxiliary input.
-
record_cell_potential (bool) – Record cell potential.
-
record_we_potential (bool) – Record applied working electrode potential.
-
record_forward_and_reverse_currents (bool) – Record forward and reverse currents
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
versus_ocp
versus_ocp: settings.VersusOCP = attrs.field(factory=(settings.VersusOCP))
Set the versus OCP settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
ir_drop_compensation
ir_drop_compensation: settings.IrDropCompensation = attrs.field(factory=(settings.IrDropCompensation))
Set the iR drop compensation settings.
equilibrion_triggers
equilibrion_triggers: settings.EquilibrationTriggers = attrs.field(factory=(settings.EquilibrationTriggers))
Set the trigger at equilibration settings.
measurement_triggers
measurement_triggers: settings.MeasurementTriggers = attrs.field(factory=(settings.MeasurementTriggers))
Set the trigger at measurement settings.
multiplexer
multiplexer: settings.Multiplexer = attrs.field(factory=(settings.Multiplexer))
Set the multiplexer settings
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
record_cell_potential
record_cell_potential: bool = False
Record cell potential.
Counter electrode vs ground.
record_we_potential
record_we_potential: bool = False
Record applied working electrode potential.
Reference electrode vs ground.
StrippingChronoPotentiometry
Create stripping potentiometry method parameters.
If the stripping current is set to 0, then chemical stripping is performed, otherwise it is chemical constant current stripping. The applicable range is +- 0.001 microampere to +- 2 milliampere.
Functions:
-
to_dict – Return the technique instance as a new key/value dictionary mapping.
-
from_method_id – Create new instance of appropriate technique from method ID.
Attributes:
-
current_range (CurrentRange) – Set the autoranging current.
-
potential_range (PotentialRange) – Set the autoranging potential.
-
pretreatment (Pretreatment) – Set the pretreatment settings.
-
post_measurement (PostMeasurement) – Set the post measurement settings.
-
data_processing (DataProcessing) – Set the data processing settings.
-
current (float) – The stripping current to apply in the given current range.
-
applied_current_range (CURRENT_RANGE) – Applied current range.
-
end_potential (float) – Potential in V where measurement ends.
-
measurement_time (float) – Measurement time in s (default: 1.0)
current_range
current_range: settings.CurrentRange = attrs.field(factory=(settings.CurrentRange), converter=current_converter)
Set the autoranging current.
potential_range
potential_range: settings.PotentialRange = attrs.field(factory=(settings.PotentialRange), converter=potential_converter)
Set the autoranging potential.
pretreatment
pretreatment: settings.Pretreatment = attrs.field(factory=(settings.Pretreatment))
Set the pretreatment settings.
post_measurement
post_measurement: settings.PostMeasurement = attrs.field(factory=(settings.PostMeasurement))
Set the post measurement settings.
data_processing
data_processing: settings.DataProcessing = attrs.field(factory=(settings.DataProcessing))
Set the data processing settings.
general
general: settings.General = attrs.field(factory=(settings.General))
Sets general/other settings.
current
current: float = 0.0
The stripping current to apply in the given current range.
Note that this value acts as a multiplier in the applied current range.
So if 10 uA is the applied current range and 1.5 is given as current value, the applied current will be 15 uA.