Stop Conditions

Stop conditions allow for the premature termination of a measurement DC primitive, enabling the development of more complex and responsive experimental protocols. For example, a constant current polarization can be stopped once a specific voltage limit is reached.

It should be noted that the stop conditions are monitored using the output data rate, which must therefore be set appropriately to ensure that the job is terminated quickly enough.

class IntegratingLimitStopCondition(self: zahner_link._zahner_link.meas.stop.IntegratingLimitStopCondition, for_dimension: str, over_dimension: str, maximum: SupportsFloat)

Integrating limit stop condition

The job is canceled when the integrated absolute value of one dimension over another dimension exceeds the maximum threshold.

Parameters:

• for_dimension – dimension to integrate (e.g., “current”, “voltage”)

• over_dimension – dimension to integrate over (e.g., “time”)

• maximum – maximum integrated value for the specified dimension

WebSocket JSON Example

{
    "type": "integrating",
    "parameters": {
        "for_dimension": "voltage",
        "over_dimension": "time",
        "maximum": 10E0
    }
}

class MaxLimitStopCondition(self: zahner_link._zahner_link.meas.stop.MaxLimitStopCondition, for_dimension: str, maximum: SupportsFloat)

Maximum limit stop condition

Parameters:

• for_dimension – dimension to apply the limit to (e.g., “time”, “voltage”, “current”)

• maximum – maximum value for the specified dimension

WebSocket JSON Example

{
    "type": "max",
    "parameters": {
        "for_dimension": "voltage",
        "maximum": 3E0
    }
}

class MinLimitStopCondition(self: zahner_link._zahner_link.meas.stop.MinLimitStopCondition, for_dimension: str, minimum: SupportsFloat)

Minimum limit stop condition

Parameters:

• for_dimension – dimension to apply the limit to (e.g., “time”, “voltage”, “current”)

• minimum – minimum value for the specified dimension

WebSocket JSON Example

{
    "type": "min",
    "parameters": {
        "for_dimension": "voltage",
        "minimum": 1E0,
    }
}

class MinMaxLimitStopCondition(self: zahner_link._zahner_link.meas.stop.MinMaxLimitStopCondition, for_dimension: str, minimum: SupportsFloat, maximum: SupportsFloat)

Minimum and maximum limit stop condition

Parameters:

• for_dimension – dimension to apply the limits to (e.g. “voltage”, “current”)

• minimum – minimum value for the specified dimension

• maximum – maximum value for the specified dimension

WebSocket JSON Example

{
    "type": "min_max",
    "parameters": {
        "for_dimension": "voltage",
        "minimum": -2E0,
        "maximum": 3E0
    }
}

class StabilityToleranceLimitStopCondition(self: zahner_link._zahner_link.meas.stop.StabilityToleranceLimitStopCondition, for_dimension: str, stability_tolerance: SupportsFloat, minimum_duration: SupportsFloat)

Stability tolerance limit stop condition

This limit can be used to stop when a stability criterion is met and something has settled, for example.

Parameters:

• for_dimension – dimension to integrate (e.g., “current”, “voltage”)

• stability_tolerance – absolute tolerance value for a change in dimension per second below which the job stops

• minimum_duration – time after that the stability tolerance is checked

WebSocket JSON Example

{
    "type": "stability_tolerance",
    "parameters": {
        "for_dimension": "voltage",
        "stability_tolerance": 1E-4,
        "minimum_duration": 3E0
    }
}