pastas.transform.ThresholdTransform
===================================

.. toctree::
   :hidden:

   /api/pastas/transform/ThresholdTransform.set_model
   /api/pastas/transform/ThresholdTransform.set_init_parameters
   /api/pastas/transform/ThresholdTransform.simulate
   /api/pastas/transform/ThresholdTransform.to_dict

.. py: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.

   :param value: The initial starting value above which the simulation is lowered.
   :type value: float, optional
   :param vmin: The minimum value above which the simulation is lowered.
   :type vmin: float, optional
   :param vmax: The maximum value above which the simulation is lowered.
   :type vmax: float, optional
   :param name: Name of the transform.
   :type name: str, optional
   :param nparam: 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.
   :type nparam: int, optional

   .. rubric:: 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.















   ..
       !! processed by numpydoc !!

   .. py:property:: nparam
      :type: int


      
      Return the number of parameters.
















      ..
          !! processed by numpydoc !!

Methods
-------

.. autoapisummary::

   pastas.transform.ThresholdTransform.set_model
   pastas.transform.ThresholdTransform.set_init_parameters
   pastas.transform.ThresholdTransform.simulate
   pastas.transform.ThresholdTransform.to_dict