functions
=========

.. py:module:: functions


Functions
---------

.. autoapisummary::

   functions.combine_series
   functions.bepaal_N_vak
   functions.window_collect
   functions.scaled_collect


Module Contents
---------------

.. py:function:: combine_series(list_pf)

   Combineert de faalkansen uit een lijst naar
    - een elementaire ondergrens op basis van volledige afhankelijkheid. De ondergrens wordt bepaald door max(pf[i]) van alle doorsneden.
    - een elementaire bovengrens op basis van volledige onafhankelijkheid. De bovengrens wordt bepaald door 1 - prod(1-pf[i]) van alle
      doorsneden.

   :param list_pf: Lijst met faalkansen van de elementen.
   :return: bovengrens en ondergrens


.. py:function:: bepaal_N_vak(L, a, dL)

   Bepaalt de lengte-effect-factor N met een minimum van 1,0. Conform de Rode draad #10 assembleren (October 2024).

   :param L: Lengte van het element.
   :param a: Mechanismegevoelige fractie
   :param dL: De equivalente onafhankelijke lengte voor STPH

   :raises ValueError: Parameter a moet groter zijn dan 0.
   :raises ValueError: De lengte L en dL moeten groter zijn dan 0.

   :return N_vak: Lengte-effect voor het vak


.. py:function:: window_collect(window_size, point_list, m_van, m_tot, vak_id = None)

   Hier worden de faalkansen verzamelt op basis van een window. Van alle doorsneden die in de window vallen wordt
   de faalkans voor de window bepaalt op basis van de max. De kans voor het element waar de windows over genomen zijn
   wordt bepaald met `combine_series()`. Kan voor zowel een vak of het gehele traject worden uitgevoerd.

   :param window_size: Grootte van de window.
   :param point_list: Lijst met alle uittredepunten in het element.
   :param m_van: Beginpunt van het element in meters.
   :param m_tot: Eindpunt van het element in meters.
   :param vak_id: Id van het vak als de windows over een vak element worden
       bepaald. Defaults to None.

   :return sum_pf: Samengestelde faalkans op basis van de som van de
       faalkansen.
   :return max_pf: Samengestelde faalkans op basis van max().
   :return window_elements: Lijst met `WindowElement` object met gegevens van de
       windows.


.. py:function:: scaled_collect(dL, point_list, m_van, m_tot, vak_id = None)

   Verzamel de uittredepunten per element en geef deze een lengte op basis van de afstand tussen de punten. Deze
   blokken worden als een window beschouwt. Als er meerdere punten binnen 5 m van elkaar liggen wordt hieruit de
   grootste faalkans genomen. De kans voor het element wordt bepaald met `combine_series()`. Kan voor zowel een vak of
   het gehele traject worden uitgevoerd.

   :param dL: De equivalente onafhankelijke lengte voor STPH
   :param point_list: Lijst met alle uittredepunten in het element.
   :param m_van: Beginpunt van het element in meters.
   :param m_tot: Eindpunt van het element in meters.
   :param vak_id: Id van het vak als de windows over een vak element worden
       bepaald. Defaults to None.

   :return sum_pf: Samengestelde faalkans op basis van de som van de
       faalkansen.
   :return max_pf: Samengestelde faalkans op basis van max().
   :return window_elements: Lijst met `WindowElement` object met gegevens van de
       windows.