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

.. py:module:: geoprob_pipe.results.construct_dataframes


Functions
---------

.. autoapisummary::

   geoprob_pipe.results.construct_dataframes.collect_df_beta_limit_state
   geoprob_pipe.results.construct_dataframes.combine_df_beta_per_limit_state
   geoprob_pipe.results.construct_dataframes.collect_df_beta_scenario_rp
   geoprob_pipe.results.construct_dataframes.collect_df_beta_scenario_cp
   geoprob_pipe.results.construct_dataframes.collect_df_beta_scenario_final
   geoprob_pipe.results.construct_dataframes.combine_df_beta_per_scenario_rp
   geoprob_pipe.results.construct_dataframes.combine_df_beta_per_scenario_cp
   geoprob_pipe.results.construct_dataframes.combine_df_beta_per_scenario_final
   geoprob_pipe.results.construct_dataframes.calculate_df_beta_per_uittredepunt
   geoprob_pipe.results.construct_dataframes.construct_df_beta_per_vak


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

.. py:function:: collect_df_beta_limit_state(calculation)

.. py:function:: combine_df_beta_per_limit_state(calc_results)

.. py:function:: collect_df_beta_scenario_rp(calc)

.. py:function:: collect_df_beta_scenario_cp(calc)

.. py:function:: collect_df_beta_scenario_final(calc)

   Converts a SystemCalculation-object to a single-row DataFrame with the final result of the scenario
   calculations. Because there are several calculation methods, and the preferred result also depends on convergence,
   we use the below flow chart to determine the final result.

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

   :param calc:
   :return:


.. 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: