pastas.rfunc.Spline
===================

.. toctree::
   :hidden:

   /api/pastas/rfunc/Spline.get_init_parameters
   /api/pastas/rfunc/Spline.get_tmax
   /api/pastas/rfunc/Spline.step
   /api/pastas/rfunc/Spline.to_dict

.. py:class:: pastas.rfunc.Spline(cutoff: float = 0.999, kind: str = 'quadratic', t: list[int] | None = None, **kwargs)



   
   Spline response function with parameters: A and a factor for every t.

   :param up: 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.
   :type up: bool or None, optional
   :param gain_scale_factor: the scale factor is used to set the initial value and the bounds of the gain
                             parameter, computed as 1 / gain_scale_factor.
   :type gain_scale_factor: float, optional
   :param cutoff: proportion after which the step function is cut off. default is 0.999. this
                  parameter has no influence for this response function.
   :type cutoff: float, optional
   :param kind: see scipy.interpolate.interp1d. Most useful for a smooth response function
                are 'quadratic' and 'cubic'.
   :type kind: string, optional
   :param t: times at which the response function is defined.
   :type t: list, optional

   .. rubric:: Notes

   The spline response function generates a response function from factors at t = 1,
   2, 4, 8, 16, 32, 64, 128, 256, 512 and 1024 days by default. This response
   function is more data-driven than existing response functions and has no physical
   background. Therefore, it can primarily be used to compare to other more physical
   response functions, that probably describe the groundwater system better.















   ..
       !! processed by numpydoc !!
Methods
-------

.. autoapisummary::

   pastas.rfunc.Spline.get_init_parameters
   pastas.rfunc.Spline.get_tmax
   pastas.rfunc.Spline.step
   pastas.rfunc.Spline.to_dict