darsia.ClipModel#

class ClipModel(min_value=None, max_value=None, key=None, **kwargs)[source]#

Bases: Model

Model clipping away signal at some min and max values.

Clipping model initialization.

Parameters:
min_valuefloat | None

Lower clip value.

max_valuefloat | None

Upper clip value.

keystr

Additional key (prefix) for kwargs.

**kwargskeyword arguments

Key + ‘_min_value’: lower clip value key + ‘_max_value’: upper clip value.

Methods

calibrate()

Calibration routine of model.

update([min_value, max_value])

Update of internal parameters.

update_model_parameters(parameters[, dofs])

Short cut to update scaling and offset parameters using a general function signature.
update(min_value=None, max_value=None)[source]#

Update of internal parameters.

Parameters:
min_valuefloat, optional

Lower clip value.

max_valuefloat, optional

Upper clip value.

update_model_parameters(parameters, dofs=None)[source]#

Short cut to update scaling and offset parameters using a general function signature.

Parameters:
parametersnp.ndarray

2-array containing min and max values.