Skip to content

Fast Impedance Spectroscopy

This page documents the Fast Impedance Spectroscopy (FIS or FEIS) method.

pypalmsens.FastImpedanceSpectroscopy

Create fast impedance spectroscopy 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.

equilibrion_triggers class-attribute instance-attribute

equilibrion_triggers: EquilibrationTriggers = Field(default_factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

measurement_triggers class-attribute instance-attribute

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

Set the trigger at measurement settings.

post_measurement class-attribute instance-attribute

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

Set the post measurement settings.

versus_ocp class-attribute instance-attribute

versus_ocp: VersusOCP = Field(default_factory=VersusOCP)

Set the versus OCP 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['fis'] = 'fis'

Unique method identifier.

equilibration_time class-attribute instance-attribute

equilibration_time: float = 0.0

Equilibration time in s.

interval_time class-attribute instance-attribute

interval_time: float = 0.1

The time between two samples in s.

run_time class-attribute instance-attribute

run_time: float = 10.0

Total run time of the measurement in s.

dc_potential class-attribute instance-attribute

dc_potential: float = 0.0

Potential applied during measurement in V.

ac_potential class-attribute instance-attribute

ac_potential: float = 0.01

Potential amplitude in V (rms).

frequency class-attribute instance-attribute

frequency: float = 50000.0

Fixed frequency in Hz.

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()