Fast Impedance Spectroscopy

              flowchart TD
              pypalmsens.FastImpedanceSpectroscopy[FastImpedanceSpectroscopy]
              pypalmsens._methods.base.BaseTechnique[BaseTechnique]
              pypalmsens._methods.mixins.CurrentRangeMixin[CurrentRangeMixin]
              pypalmsens._methods.mixins.PotentialRangeMixin[PotentialRangeMixin]
              pypalmsens._methods.mixins.PretreatmentMixin[PretreatmentMixin]
              pypalmsens._methods.mixins.VersusOCPMixin[VersusOCPMixin]
              pypalmsens._methods.mixins.PostMeasurementMixin[PostMeasurementMixin]
              pypalmsens._methods.mixins.MeasurementTriggersMixin[MeasurementTriggersMixin]
              pypalmsens._methods.mixins.EquilibrationTriggersMixin[EquilibrationTriggersMixin]
              pypalmsens._methods.mixins.GeneralMixin[GeneralMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.base.BaseTechnique --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.base.BaseTechnique
                

                pypalmsens._methods.mixins.CurrentRangeMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.CurrentRangeMixin
                

                pypalmsens._methods.mixins.PotentialRangeMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PotentialRangeMixin
                

                pypalmsens._methods.mixins.PretreatmentMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PretreatmentMixin
                

                pypalmsens._methods.mixins.VersusOCPMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.VersusOCPMixin
                

                pypalmsens._methods.mixins.PostMeasurementMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PostMeasurementMixin
                

                pypalmsens._methods.mixins.MeasurementTriggersMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.MeasurementTriggersMixin
                

                pypalmsens._methods.mixins.EquilibrationTriggersMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.EquilibrationTriggersMixin
                

                pypalmsens._methods.mixins.GeneralMixin --> pypalmsens.FastImpedanceSpectroscopy
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.GeneralMixin
                



              click pypalmsens.FastImpedanceSpectroscopy href "" "pypalmsens.FastImpedanceSpectroscopy"
              click pypalmsens._methods.base.BaseTechnique href "" "pypalmsens._methods.base.BaseTechnique"
              click pypalmsens._methods.mixins.CurrentRangeMixin href "" "pypalmsens._methods.mixins.CurrentRangeMixin"
              click pypalmsens._methods.mixins.PotentialRangeMixin href "" "pypalmsens._methods.mixins.PotentialRangeMixin"
              click pypalmsens._methods.mixins.PretreatmentMixin href "" "pypalmsens._methods.mixins.PretreatmentMixin"
              click pypalmsens._methods.mixins.VersusOCPMixin href "" "pypalmsens._methods.mixins.VersusOCPMixin"
              click pypalmsens._methods.mixins.PostMeasurementMixin href "" "pypalmsens._methods.mixins.PostMeasurementMixin"
              click pypalmsens._methods.mixins.MeasurementTriggersMixin href "" "pypalmsens._methods.mixins.MeasurementTriggersMixin"
              click pypalmsens._methods.mixins.EquilibrationTriggersMixin href "" "pypalmsens._methods.mixins.EquilibrationTriggersMixin"
              click pypalmsens._methods.mixins.GeneralMixin href "" "pypalmsens._methods.mixins.GeneralMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Create fast impedance spectroscopy method parameters.

Methods:

• from_dict –

  Structure technique instance from dict.

• from_method_id –

  Create new instance of appropriate technique from method ID.

• to_dict –

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

Attributes:

• ac_potential (float) –

  Potential amplitude in V (rms).

• current_range (CurrentRange) –

  Set the autoranging current.

• dc_potential (float) –

  Potential applied during measurement in V.

• equilibration_time (float) –

  Equilibration time in s.

• equilibrion_triggers (EquilibrationTriggers) –

  Set the trigger at equilibration settings.

• frequency (float) –

  Fixed frequency in Hz.

• general (General) –

  Sets general/other settings.

• interval_time (float) –

  The time between two samples in s.

• measurement_triggers (MeasurementTriggers) –

  Set the trigger at measurement settings.

• post_measurement (PostMeasurement) –

  Set the post measurement settings.

• potential_range (PotentialRange) –

  Set the autoranging potential.

• pretreatment (Pretreatment) –

  Set the pretreatment settings.

• run_time (float) –

  Total run time of the measurement in s.

• versus_ocp (VersusOCP) –

  Set the versus OCP settings.

ac_potential: float = 0.01

current_range: CurrentRange = Field(default_factory=CurrentRange)

dc_potential: float = 0.0

equilibration_time: float = 0.0

equilibrion_triggers: EquilibrationTriggers = Field(default_factory=EquilibrationTriggers)

frequency: float = 50000.0

general: General = Field(default_factory=General)

interval_time: float = 0.1

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

potential_range: PotentialRange = Field(default_factory=PotentialRange)

pretreatment: Pretreatment = Field(default_factory=Pretreatment)

run_time: float = 10.0

versus_ocp: VersusOCP = Field(default_factory=VersusOCP)

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

35
36
37
38
39
40

@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

42
43
44
45
46

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

to_dict() -> dict[str, Any]

31
32
33

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