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

.. toctree::
   :hidden:

   /api/pastas/rfunc/Spline.get_init_parameters
   /api/pastas/rfunc/Spline.get_tmax
   /api/pastas/rfunc/Spline.gain
   /api/pastas/rfunc/Spline.step
   /api/pastas/rfunc/Spline.moment
   /api/pastas/rfunc/Spline.impulse
   /api/pastas/rfunc/Spline.to_dict

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



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

   :param cutoff: Fraction of the step response after which the response is truncated. This
                  setting has no effect for this response function.
   :type cutoff: float, optional
   :param use_block: Must be True as Spline does not have an impulse response function
   :type use_block: bool
   :param kind: Interpolation kind passed to :func:`scipy.interpolate.interp1d`.
                Common choices are `"quadratic"` and `"cubic"`.
   :type kind: str, optional
   :param t: Times at which the response function is defined. Defaults to
             `[1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024]`.
   :type t: list[int], optional

   .. attribute:: up

      Whether a positive stress causes the head to go up (`True`), down
      (`False`), or either direction (`None`).

      :type: bool or None, optional

   .. attribute:: gain_scale_factor

      Scale factor used to set the initial value and bounds of the gain
      parameter, computed as `1 / gain_scale_factor`.

      :type: float, 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 !!

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


      
      Number of parameters of the response function.
















      ..
          !! processed by numpydoc !!

Methods
-------

.. autoapisummary::

   pastas.rfunc.Spline.get_init_parameters
   pastas.rfunc.Spline.get_tmax
   pastas.rfunc.Spline.gain
   pastas.rfunc.Spline.step
   pastas.rfunc.Spline.moment
   pastas.rfunc.Spline.impulse
   pastas.rfunc.Spline.to_dict