pastas.transform.ThresholdTransform

class pastas.transform.ThresholdTransform(value: float = np.nan, vmin: float = np.nan, vmax: float = np.nan, name: str = 'transform', nparam: int = 2)

ThresholdTransform lowers the simulation when it exceeds a certain value.

Parameters:

• value (float, optional) – The initial starting value above which the simulation is lowered.

• vmin (float, optional) – The minimum value above which the simulation is lowered.

• vmax (float, optional) – The maximum value above which the simulation is lowered.

• name (str, optional) – Name of the transform.

• nparam (int, optional) – The number of parameters. Default is nparam=2. The first parameter then is the threshold, and the second parameter is the factor with which the simulation is lowered.

Notes

In geohydrology this transform can be used in a situation where the groundwater level reaches the surface level and forms a lake. Because of the larger storage of the lake, the (groundwater) level then rises slower when it rains.