Multi-step Potentiometry

Create multi-step potentiometry method parameters.

MultiStep Potentiometry you can specify the number of current steps to apply and how long each step should last. The current is continuously sampled with the specified interval.

A whole cycle of steps can be repeated several times.

Levels can be specified using pypalmsens.settings.ILevel().

Methods:

• to_dict –

  Return the technique instance as a new key/value dictionary mapping.

• from_dict –

  Structure technique instance from dict.

• from_method_id –

  Create new instance of appropriate technique from method ID.

Attributes:

• general (General) –

  Sets general/other settings.

• multiplexer (Multiplexer) –

  Set the multiplexer settings.

• data_processing (DataProcessing) –

  Set the data processing settings.

• potential_limits (PotentialLimits) –

  Set the potential limit settings.

• post_measurement (PostMeasurement) –

  Set the post measurement settings.

• pretreatment (Pretreatment) –

  Set the pretreatment settings.

• potential_range (PotentialRange) –

  Set the autoranging potential.

• current_range (CurrentRange) –

  Set the autoranging current.

• id (Literal['mp']) –

  Unique method identifier.

• applied_current_range (AllowedCurrentRanges) –

  Applied current range.

• interval_time (float) –

  The time between two samples in s.

• n_cycles (int) –

  Number of repetitions.

• levels (list[ILevel]) –

  The currents to apply within a cycle.

• record_auxiliary_input (bool) –

  Record auxiliary input.

• record_we_current (bool) –

  Record applied working electrode potential.

general: General = Field(default_factory=General)

multiplexer: Multiplexer = Field(default_factory=Multiplexer)

data_processing: DataProcessing = Field(default_factory=DataProcessing)

potential_limits: PotentialLimits = Field(default_factory=PotentialLimits)

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

pretreatment: Pretreatment = Field(default_factory=Pretreatment)

potential_range: PotentialRange = Field(default_factory=PotentialRange)

current_range: CurrentRange = Field(default_factory=CurrentRange)

id: Literal['mp'] = 'mp'

applied_current_range: AllowedCurrentRanges = '1uA'

interval_time: float = 0.1

n_cycles: int = 1

levels: list[ILevel] = Field(default_factory=lambda: [ILevel()])

record_auxiliary_input: bool = False

record_we_current: bool = False

to_dict() -> dict[str, Any]

30
31
32

def to_dict(self) -> dict[str, Any]:
    """Return the technique instance as a new key/value dictionary mapping."""
    return self.model_dump()

from_dict(obj: dict[str, Any]) -> BaseTechnique

34
35
36
37
38
39

@classmethod
def from_dict(cls, obj: dict[str, Any]) -> BaseTechnique:
    """Structure technique instance from dict.

    Opposite of `.to_dict()`"""
    return cls.model_validate(obj)

from_method_id(id: str) -> BaseTechnique

41
42
43
44
45

@classmethod
def from_method_id(cls, id: str) -> BaseTechnique:
    """Create new instance of appropriate technique from method ID."""
    new = cls._registry[id]
    return new()