pastas.rfunc.FourParam
======================

.. toctree::
   :hidden:

   /api/pastas/rfunc/FourParam.get_init_parameters
   /api/pastas/rfunc/FourParam.impulse
   /api/pastas/rfunc/FourParam.get_tmax
   /api/pastas/rfunc/FourParam.step
   /api/pastas/rfunc/FourParam.to_dict

.. py:class:: pastas.rfunc.FourParam(cutoff: float = 0.999, quad: bool = False, **kwargs)



   
   Four Parameter response function with 4 parameters A, a, b, and n.

   :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.
   :type cutoff: float, optional
   :param quad: If true, use the 'quad' method from scipy.integrate to integrate the impulse
                response function. This may be more accurate but increases computation times.
   :type quad: bool, optional

   .. rubric:: Notes

   The impulse response function for this class can be viewed on the Documentation
   website or using `latexify` by running the following code in a Jupyter notebook
   environment::

       ps.FourParam.impulse

   The function is explained in :cite:t:`bakker_calibration_2008`.















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

.. autoapisummary::

   pastas.rfunc.FourParam.get_init_parameters
   pastas.rfunc.FourParam.impulse
   pastas.rfunc.FourParam.get_tmax
   pastas.rfunc.FourParam.step
   pastas.rfunc.FourParam.to_dict