Skip to content

Linear Sweep Potentiometry

This page documents the Linear Sweep Potentiometry (LSP) method.

pypalmsens.LinearSweepPotentiometry

Create linear sweep potentiometry method parameters.

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 class-attribute instance-attribute

general: General = Field(default_factory=General)

Sets general/other settings.

multiplexer class-attribute instance-attribute

multiplexer: Multiplexer = Field(default_factory=Multiplexer)

Set the multiplexer settings.

data_processing class-attribute instance-attribute

data_processing: DataProcessing = Field(default_factory=DataProcessing)

Set the data processing settings.

delay_triggers class-attribute instance-attribute

delay_triggers: DelayTriggers = Field(default_factory=DelayTriggers)

Set the delayed trigger at measurement settings.

measurement_triggers class-attribute instance-attribute

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

Set the trigger at measurement settings.

potential_limits class-attribute instance-attribute

potential_limits: PotentialLimits = Field(default_factory=PotentialLimits)

Set the potential limit settings.

post_measurement class-attribute instance-attribute

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

Set the post measurement settings.

pretreatment class-attribute instance-attribute

pretreatment: Pretreatment = Field(default_factory=Pretreatment)

Set the pretreatment settings.

potential_range class-attribute instance-attribute

potential_range: PotentialRange = Field(default_factory=PotentialRange)

Set the autoranging potential.

current_range class-attribute instance-attribute

current_range: CurrentRange = Field(default_factory=CurrentRange)

Set the autoranging current.

id class-attribute instance-attribute

id: Literal['lsp'] = 'lsp'

Unique method identifier.

applied_current_range class-attribute instance-attribute

applied_current_range: AllowedCurrentRanges = '100uA'

Applied current range.

See pypalmsens.settings.AllowedCurrentRanges for options.

current_begin class-attribute instance-attribute

current_begin: float = -1.0

Current applied at beginning of measurement.

This value is multiplied by the defined current range.

current_end class-attribute instance-attribute

current_end: float = 1.0

Current applied at end of measurement.

This value is multiplied by the defined current range.

current_step class-attribute instance-attribute

current_step: float = 0.01

Current step.

This value is multiplied by the defined current range.

scan_rate class-attribute instance-attribute

scan_rate: float = 1.0

Scan rate (current/time) in V/s.

The applicable range depends on the value of current_step since the data acquisition rate is limited by the connected instrument.

This value is multiplied by the defined current range.

record_auxiliary_input class-attribute instance-attribute

record_auxiliary_input: bool = False

Record auxiliary input.

record_we_current class-attribute instance-attribute

record_we_current: bool = False

Record working electrode current.

to_dict

to_dict() -> dict[str, Any]

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

Source code in src/pypalmsens/_methods/base.py
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 classmethod

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

Structure technique instance from dict.

Opposite of .to_dict()

Source code in src/pypalmsens/_methods/base.py
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 classmethod

from_method_id(id: str) -> BaseTechnique

Create new instance of appropriate technique from method ID.

Source code in src/pypalmsens/_methods/base.py
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()