geoprob_pipe.results
====================

.. py:module:: geoprob_pipe.results


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/geoprob_pipe/results/alphas_and_physical_values/index
   /autoapi/geoprob_pipe/results/construct_dataframes/index


Classes
-------

.. autoapisummary::

   geoprob_pipe.results.Results


Functions
---------

.. autoapisummary::

   geoprob_pipe.results.combine_df_beta_per_limit_state
   geoprob_pipe.results.combine_df_beta_per_scenario_rp
   geoprob_pipe.results.combine_df_beta_per_scenario_cp
   geoprob_pipe.results.combine_df_beta_per_scenario_final
   geoprob_pipe.results.calculate_df_beta_per_uittredepunt
   geoprob_pipe.results.construct_df_beta_per_vak
   geoprob_pipe.results.construct_df


Package Contents
----------------

.. py:function:: combine_df_beta_per_limit_state(calc_results)

.. py:function:: combine_df_beta_per_scenario_rp(calc_results)

.. py:function:: combine_df_beta_per_scenario_cp(calc_results)

.. py:function:: combine_df_beta_per_scenario_final(calc_results)

.. py:function:: calculate_df_beta_per_uittredepunt(geoprob_pipe, results)

   Generates the DataFrame of the final result for the exit points.

   Because there is an automated decision-making in the scenario calculations (see flow chart over there), for the exit
   points the flow chart is extended below.

   .. image:: /_static/flow-chart-final-result-uittredepunt-calculations.png
      :alt: Flow chart final result exit point calculations
      :align: center

   :param geoprob_pipe:
   :param results:
   :return:


.. py:function:: construct_df_beta_per_vak(results)

   Constructs the DataFrame of the final result for the vakken.

   Because there is an automated decision-making in the scenario and exit point calculations (see flow charts over
   there), for the vakken the flow chart is extended below.

   .. image:: /_static/flow-chart-final-result-vak-calculations.png
      :alt: Flow chart final result vak calculations
      :align: center

   :param results:
   :return:


.. py:function:: construct_df(geoprob_pipe)

.. py:class:: Results(geoprob_pipe)

   Subclass to intuitively group the results.


   .. py:attribute:: geoprob_pipe


   .. py:attribute:: df_beta_limit_states


   .. py:attribute:: df_beta_scenarios_rp


   .. py:attribute:: df_beta_scenarios_cp


   .. py:attribute:: df_beta_scenarios_final


   .. py:attribute:: _df_alphas_influence_factors_and_physical_values
      :type:  Optional[pandas.DataFrame]
      :value: None



   .. py:attribute:: df_beta_uittredepunten


   .. py:attribute:: df_beta_vakken


   .. py:method:: df_alphas_influence_factors_and_physical_values(filter_deterministic = True, filter_derived = False)


   .. py:property:: export_dir
      :type: str



   .. py:method:: export_results(bool_beta_limit_states = True, bool_beta_scenarios_rp = True, bool_beta_scenarios_cp = True, bool_beta_scenarios_final = True, bool_alphas_influence_factors_and_physical_values = True, bool_beta_uittredepunten = True, bool_beta_vakken = True)