pastas.rfunc.RfuncBase.update_rfunc_settings

RfuncBase.update_rfunc_settings(up='nochange', gain_scale_factor=None, cutoff=None)

Internal method to set the settings of the response function.

Parameters

• up (bool or None, optional) – indicates whether a positive stress will cause the head to go up (True, default) or down (False), if None the head can go both ways.

• gain_scale_factor (float, optional) – the scale factor is used to set the initial value and the bounds of the gain parameter, computed as 1 / gain_scale_factor.

• cutoff (float, optional) – proportion after which the step function is cut off.

Return type

None

Notes

Only change the settings if values are provided!