pastas.noisemodels.ArmaNoiseModel
=================================

.. toctree::
   :hidden:

   /api/pastas/noisemodels/ArmaNoiseModel.set_init_parameters
   /api/pastas/noisemodels/ArmaNoiseModel.simulate
   /api/pastas/noisemodels/ArmaNoiseModel.calculate_noise
   /api/pastas/noisemodels/ArmaNoiseModel.to_dict

.. py:class:: pastas.noisemodels.ArmaNoiseModel(name: str = 'noise', norm: bool = True)



   
   ARMA(1,1) Noise model to simulate the noise as defined in :cite:t:`collenteur_estimation_2021`.

   .. rubric:: Notes

   Calculates the noise according to:

   .. math::

       \\upsilon_t = r_t - r_{t-1} e^{-\\Delta t/\\alpha} - \\upsilon_{t-1}
       e^{-\\Delta t/\\beta}

   The units of the alpha and beta parameters are always in days.

   .. warning::

      This model has only been tested on regular time steps and should not be used for
      irregular time steps yet.















   ..
       !! processed by numpydoc !!

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


      
      Return number of parameters for the noise model.

      :returns: Number of parameters (2 for ArmaNoiseModel: alpha and beta).
      :rtype: int















      ..
          !! processed by numpydoc !!

Methods
-------

.. autoapisummary::

   pastas.noisemodels.ArmaNoiseModel.set_init_parameters
   pastas.noisemodels.ArmaNoiseModel.simulate
   pastas.noisemodels.ArmaNoiseModel.calculate_noise
   pastas.noisemodels.ArmaNoiseModel.to_dict