paidiverpy.models.step_config

Contents

paidiverpy.models.step_config#

Step configuration module.

Classes#

`StepConfig`	Step configuration model.
`PositionConfig`	Position configuration model.
`ColourConfig`	Colour configuration model.
`ConvertConfig`	Convert configuration model.
`SamplingConfig`	Sampling configuration model.
`CustomConfig`	Custom configuration model.

Module Contents#

class paidiverpy.models.step_config.StepConfig[source]#

Bases: paidiverpy.utils.base_model.BaseModel

Step configuration model.

classmethod resolve_params_schema(values: dict[str, Any]) → dict[str, Any][source]#

Resolve the parameters schema based on the step name and mode.

Parameters:: values (dict) – The values to validate.
Returns:: The validated values.
Return type:: dict

update(**updates: dict[str, Any]) → StepConfig[source]#: Update the model in-place with new values.

class paidiverpy.models.step_config.PositionConfig[source]#

Bases: StepConfig

Position configuration model.

class paidiverpy.models.step_config.ColourConfig[source]#

Bases: StepConfig

Colour configuration model.

class paidiverpy.models.step_config.ConvertConfig[source]#

Bases: StepConfig

Convert configuration model.

class paidiverpy.models.step_config.SamplingConfig[source]#

Bases: StepConfig

Sampling configuration model.

class paidiverpy.models.step_config.CustomConfig[source]#

Bases: paidiverpy.utils.base_model.BaseModel

Custom configuration model.