Sweep#

class Sweep(parameter, options=None, *, data=None)#

Bases: BaseModel

Base immutable class for sweeps.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Module: exa.common.control.sweep.sweep

Attributes

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

parameter

The Sweep represents changing the values of this Parameter.

data

List of values for parameter

Methods

model_post_init

Override this method to perform additional initialization after __init__ and model_construct.

Parameters:
parameter: Parameter#

The Sweep represents changing the values of this Parameter.

data: list[Any] | ndarray[Any]#

List of values for parameter

model_post_init(_Sweep__context)#

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Parameters:

_Sweep__context (Any) –

Return type:

None

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'frozen': True, 'ser_json_inf_nan': 'constants', 'validate_assignment': True, 'validate_default': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].