Mixed Mode

              flowchart TD
              pypalmsens.mixed_mode.MixedMode[MixedMode]
              pypalmsens._methods.base.BaseTechnique[BaseTechnique]
              pypalmsens._methods.mixins.CurrentRangeMixin[CurrentRangeMixin]
              pypalmsens._methods.mixins.PretreatmentMixin[PretreatmentMixin]
              pypalmsens._methods.mixins.PostMeasurementMixin[PostMeasurementMixin]
              pypalmsens._methods.mixins.DataProcessingMixin[DataProcessingMixin]
              pypalmsens._methods.mixins.GeneralMixin[GeneralMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.base.BaseTechnique --> pypalmsens.mixed_mode.MixedMode
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.base.BaseTechnique
                

                pypalmsens._methods.mixins.CurrentRangeMixin --> pypalmsens.mixed_mode.MixedMode
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.CurrentRangeMixin
                

                pypalmsens._methods.mixins.PretreatmentMixin --> pypalmsens.mixed_mode.MixedMode
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PretreatmentMixin
                

                pypalmsens._methods.mixins.PostMeasurementMixin --> pypalmsens.mixed_mode.MixedMode
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PostMeasurementMixin
                

                pypalmsens._methods.mixins.DataProcessingMixin --> pypalmsens.mixed_mode.MixedMode
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.DataProcessingMixin
                

                pypalmsens._methods.mixins.GeneralMixin --> pypalmsens.mixed_mode.MixedMode
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.GeneralMixin
                



              click pypalmsens.mixed_mode.MixedMode href "" "pypalmsens.mixed_mode.MixedMode"
              click pypalmsens._methods.base.BaseTechnique href "" "pypalmsens._methods.base.BaseTechnique"
              click pypalmsens._methods.mixins.CurrentRangeMixin href "" "pypalmsens._methods.mixins.CurrentRangeMixin"
              click pypalmsens._methods.mixins.PretreatmentMixin href "" "pypalmsens._methods.mixins.PretreatmentMixin"
              click pypalmsens._methods.mixins.PostMeasurementMixin href "" "pypalmsens._methods.mixins.PostMeasurementMixin"
              click pypalmsens._methods.mixins.DataProcessingMixin href "" "pypalmsens._methods.mixins.DataProcessingMixin"
              click pypalmsens._methods.mixins.GeneralMixin href "" "pypalmsens._methods.mixins.GeneralMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Create mixed mode method parameters.

Mixed mode is a flexible technique that allows for switching between potentiostatic, galvanostatic, and open circuit measurements during a single run.

The mixed mode uses different stages similar to the levels during Multistep Amperometry or Potentiometry, but each stage can be galvanostatic or potentiostatic independent of the previous stage.

The available stage types are ConstantE, ConstantI, SweepE, OpenCircuit and Impedance.

• ConstantE: Apply constant potential
• ConstantI: Apply constant current
• SweepE: potential linear sweep (ramp) similar to a regular LSV step
• OpenCircuit: Measure the OCP value
• Impedance: the impedance is measured by applying a small AC potential superimposed with a DC potential. This corresponds to an EIS single frequency step (scan_type = 'fixed', freq_type = 'fixed')

Each stage can use the previous stage’s potential as a reference point, for example, a constant current is applied for a fixed period and afterward, the reached potential is kept constant for a fixed period.

Furthermore, each stage can end because a fixed period has elapsed, or certain criteria are met. Available criteria include reaching a maximum current, minimum current, maximum potential, and minimum potential.

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:

• current_range (CurrentRange) –

  Set the autoranging current.

• cycles (int) –

  Number of times to go through all stages.

• data_processing (DataProcessing) –

  Set the data processing settings.

• general (General) –

  Sets general/other settings.

• interval_time (float) –

  Time between two samples in s.

• post_measurement (PostMeasurement) –

  Set the post measurement settings.

• pretreatment (Pretreatment) –

  Set the pretreatment settings.

• stages (list[StageType]) –

  List of stages to run through.

• use_triggers –

  True if any of the stages has triggers set.

current_range: CurrentRange = Field(default_factory=CurrentRange)

cycles: int = 1

data_processing: DataProcessing = Field(default_factory=DataProcessing)

general: General = Field(default_factory=General)

interval_time: float = 0.1

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

pretreatment: Pretreatment = Field(default_factory=Pretreatment)

stages: list[StageType] = Field(default_factory=list)

use_triggers

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

              flowchart TD
              pypalmsens.mixed_mode.ConstantE[ConstantE]
              pypalmsens._methods.mixed_mode.BaseStage[BaseStage]
              pypalmsens._methods.mixins.CurrentLimitsMixin[CurrentLimitsMixin]
              pypalmsens._methods.mixins.MeasurementTriggersMixin[MeasurementTriggersMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.mixed_mode.BaseStage --> pypalmsens.mixed_mode.ConstantE
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixed_mode.BaseStage
                

                pypalmsens._methods.mixins.CurrentLimitsMixin --> pypalmsens.mixed_mode.ConstantE
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.CurrentLimitsMixin
                

                pypalmsens._methods.mixins.MeasurementTriggersMixin --> pypalmsens.mixed_mode.ConstantE
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.MeasurementTriggersMixin
                



              click pypalmsens.mixed_mode.ConstantE href "" "pypalmsens.mixed_mode.ConstantE"
              click pypalmsens._methods.mixed_mode.BaseStage href "" "pypalmsens._methods.mixed_mode.BaseStage"
              click pypalmsens._methods.mixins.CurrentLimitsMixin href "" "pypalmsens._methods.mixins.CurrentLimitsMixin"
              click pypalmsens._methods.mixins.MeasurementTriggersMixin href "" "pypalmsens._methods.mixins.MeasurementTriggersMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Amperometric detection stage.

Apply constant potential during this stage.

Methods:

• from_stage_type –

  Create new instance of appropriate stage from its type.

Attributes:

• current_limits (CurrentLimits) –

  Set the current limit settings.

• measurement_triggers (MeasurementTriggers) –

  Set the trigger at measurement settings.

• potential (float) –

  Potential during measurement in V.

• run_time (float) –

  Run time of the stage in s.

current_limits: CurrentLimits = Field(default_factory=CurrentLimits)

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

potential: float = 0.0

run_time: float = 1.0

from_stage_type(id: str) -> BaseStage

31
32
33
34
35

@classmethod
def from_stage_type(cls, id: str) -> BaseStage:
    """Create new instance of appropriate stage from its type."""
    new = cls._registry[str(id)]
    return new()

              flowchart TD
              pypalmsens.mixed_mode.ConstantI[ConstantI]
              pypalmsens._methods.mixed_mode.BaseStage[BaseStage]
              pypalmsens._methods.mixins.PotentialLimitsMixin[PotentialLimitsMixin]
              pypalmsens._methods.mixins.MeasurementTriggersMixin[MeasurementTriggersMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.mixed_mode.BaseStage --> pypalmsens.mixed_mode.ConstantI
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixed_mode.BaseStage
                

                pypalmsens._methods.mixins.PotentialLimitsMixin --> pypalmsens.mixed_mode.ConstantI
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PotentialLimitsMixin
                

                pypalmsens._methods.mixins.MeasurementTriggersMixin --> pypalmsens.mixed_mode.ConstantI
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.MeasurementTriggersMixin
                



              click pypalmsens.mixed_mode.ConstantI href "" "pypalmsens.mixed_mode.ConstantI"
              click pypalmsens._methods.mixed_mode.BaseStage href "" "pypalmsens._methods.mixed_mode.BaseStage"
              click pypalmsens._methods.mixins.PotentialLimitsMixin href "" "pypalmsens._methods.mixins.PotentialLimitsMixin"
              click pypalmsens._methods.mixins.MeasurementTriggersMixin href "" "pypalmsens._methods.mixins.MeasurementTriggersMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Potentiometry stage.

Apply constant fixed current during this stage.

Methods:

• from_stage_type –

  Create new instance of appropriate stage from its type.

Attributes:

• applied_current_range (AllowedCurrentRanges) –

  Applied current range.

• current (float) –

  The current to apply in the given current range.

• measurement_triggers (MeasurementTriggers) –

  Set the trigger at measurement settings.

• potential_limits (PotentialLimits) –

  Set the potential limit settings.

• run_time (float) –

  Run time of the stage in s.

applied_current_range: AllowedCurrentRanges = '100uA'

current: float = 0.0

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

potential_limits: PotentialLimits = Field(default_factory=PotentialLimits)

run_time: float = 1.0

from_stage_type(id: str) -> BaseStage

31
32
33
34
35

@classmethod
def from_stage_type(cls, id: str) -> BaseStage:
    """Create new instance of appropriate stage from its type."""
    new = cls._registry[str(id)]
    return new()

              flowchart TD
              pypalmsens.mixed_mode.SweepE[SweepE]
              pypalmsens._methods.mixed_mode.BaseStage[BaseStage]
              pypalmsens._methods.mixins.CurrentLimitsMixin[CurrentLimitsMixin]
              pypalmsens._methods.mixins.MeasurementTriggersMixin[MeasurementTriggersMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.mixed_mode.BaseStage --> pypalmsens.mixed_mode.SweepE
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixed_mode.BaseStage
                

                pypalmsens._methods.mixins.CurrentLimitsMixin --> pypalmsens.mixed_mode.SweepE
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.CurrentLimitsMixin
                

                pypalmsens._methods.mixins.MeasurementTriggersMixin --> pypalmsens.mixed_mode.SweepE
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.MeasurementTriggersMixin
                



              click pypalmsens.mixed_mode.SweepE href "" "pypalmsens.mixed_mode.SweepE"
              click pypalmsens._methods.mixed_mode.BaseStage href "" "pypalmsens._methods.mixed_mode.BaseStage"
              click pypalmsens._methods.mixins.CurrentLimitsMixin href "" "pypalmsens._methods.mixins.CurrentLimitsMixin"
              click pypalmsens._methods.mixins.MeasurementTriggersMixin href "" "pypalmsens._methods.mixins.MeasurementTriggersMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Linear sweep detection stage.

Ramp the voltage from begin_potential to end_potential during this stage.

Methods:

• from_stage_type –

  Create new instance of appropriate stage from its type.

Attributes:

• begin_potential (float) –

  Potential where the scan starts in V.

• current_limits (CurrentLimits) –

  Set the current limit settings.

• end_potential (float) –

  Potential where the scan stops in V.

• measurement_triggers (MeasurementTriggers) –

  Set the trigger at measurement settings.

• scanrate (float) –

  The applied scan rate. in V/s.

• step_potential (float) –

  Potential step in V.

begin_potential: float = -0.5

current_limits: CurrentLimits = Field(default_factory=CurrentLimits)

end_potential: float = 0.5

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

scanrate: float = 1.0

step_potential: float = 0.1

from_stage_type(id: str) -> BaseStage

31
32
33
34
35

@classmethod
def from_stage_type(cls, id: str) -> BaseStage:
    """Create new instance of appropriate stage from its type."""
    new = cls._registry[str(id)]
    return new()

              flowchart TD
              pypalmsens.mixed_mode.OpenCircuit[OpenCircuit]
              pypalmsens._methods.mixed_mode.BaseStage[BaseStage]
              pypalmsens._methods.mixins.PotentialLimitsMixin[PotentialLimitsMixin]
              pypalmsens._methods.mixins.MeasurementTriggersMixin[MeasurementTriggersMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.mixed_mode.BaseStage --> pypalmsens.mixed_mode.OpenCircuit
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixed_mode.BaseStage
                

                pypalmsens._methods.mixins.PotentialLimitsMixin --> pypalmsens.mixed_mode.OpenCircuit
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PotentialLimitsMixin
                

                pypalmsens._methods.mixins.MeasurementTriggersMixin --> pypalmsens.mixed_mode.OpenCircuit
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.MeasurementTriggersMixin
                



              click pypalmsens.mixed_mode.OpenCircuit href "" "pypalmsens.mixed_mode.OpenCircuit"
              click pypalmsens._methods.mixed_mode.BaseStage href "" "pypalmsens._methods.mixed_mode.BaseStage"
              click pypalmsens._methods.mixins.PotentialLimitsMixin href "" "pypalmsens._methods.mixins.PotentialLimitsMixin"
              click pypalmsens._methods.mixins.MeasurementTriggersMixin href "" "pypalmsens._methods.mixins.MeasurementTriggersMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Open Circuit stage.

Measure the open circuit potential during this stage.

Methods:

• from_stage_type –

  Create new instance of appropriate stage from its type.

Attributes:

• measurement_triggers (MeasurementTriggers) –

  Set the trigger at measurement settings.

• potential_limits (PotentialLimits) –

  Set the potential limit settings.

• run_time (float) –

  Run time of the stage in s.

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

potential_limits: PotentialLimits = Field(default_factory=PotentialLimits)

run_time: float = 1.0

from_stage_type(id: str) -> BaseStage

31
32
33
34
35

@classmethod
def from_stage_type(cls, id: str) -> BaseStage:
    """Create new instance of appropriate stage from its type."""
    new = cls._registry[str(id)]
    return new()

              flowchart TD
              pypalmsens.mixed_mode.Impedance[Impedance]
              pypalmsens._methods.mixed_mode.BaseStage[BaseStage]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.mixed_mode.BaseStage --> pypalmsens.mixed_mode.Impedance
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixed_mode.BaseStage
                



              click pypalmsens.mixed_mode.Impedance href "" "pypalmsens.mixed_mode.Impedance"
              click pypalmsens._methods.mixed_mode.BaseStage href "" "pypalmsens._methods.mixed_mode.BaseStage"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Electostatic impedance stage.

This is like EIS with a single frequency step (scan_type = 'fixed', freq_type = 'fixed').

Methods:

• from_stage_type –

  Create new instance of appropriate stage from its type.

Attributes:

• ac_potential (float) –

  AC potential in V RMS.

• dc_potential (float) –

  DC potential applied during the scan in V.

• frequency (float) –

  Fixed frequency in Hz.

• max_equilibration_time (float) –

  Max equilibration time in s.

• min_sampling_time (float) –

  Minimum sampling time in s.

• run_time (float) –

  Run time of the scan in s.

ac_potential: float = 0.01

dc_potential: float = 0.0

frequency: float = 50000.0

max_equilibration_time: float = 5.0

min_sampling_time: float = 0.5

run_time: float = 10.0

from_stage_type(id: str) -> BaseStage

31
32
33
34
35

@classmethod
def from_stage_type(cls, id: str) -> BaseStage:
    """Create new instance of appropriate stage from its type."""
    new = cls._registry[str(id)]
    return new()