utopia.results_processing.process_results
=========================================

.. py:module:: utopia.results_processing.process_results


Classes
-------

.. autoapisummary::

   utopia.results_processing.process_results.ResultsProcessor


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

.. py:class:: ResultsProcessor(model)

   Provides functionalities for restructuring, analysing and plotting the UTOPIA model results.


   .. py:attribute:: processed_results


   .. py:attribute:: model


   .. py:attribute:: R


   .. py:attribute:: Results_extended
      :value: None



   .. py:method:: process_results()

      Reformat results dataframe for easier analysis by specifying size fractions, MP forms and compartments and deriving mass and number fractions, input and outup flows.



   .. py:method:: addFlows_to_results_df(Results_extended)

      Calculate inflows and outflows (mass and number) and update Results_extended.



   .. py:method:: plot_fractionDistribution_heatmaps(fraction)

      Plots the mass and number fractions after they have been extracted to the Results_extended df.



   .. py:method:: generate_flows_dict()


   .. py:method:: estimate_flows()


   .. py:method:: extract_results_by_compartment()


   .. py:method:: create_rateConstants_table()


   .. py:method:: plot_rateConstants()


   .. py:method:: plot_compartment_distribution(mass_or_number)

      Bar chart plot of the mass or particle number distribution of particles by compartment.



   .. py:method:: process_all()

      Runs all processing steps in order automatically and stores the results in the processed_results dictionary of the the class.



   .. py:method:: estimate_exposure_indicators()

      Estimate overall size dependent exposure indicators



   .. py:method:: estimate_emission_fractions()

      Estimate mass emission fractions:
      - Environmentally Dispersed Fraction (ϕ1): quantifies the relative extent to which the pollutants (MPs) can reach remote regions.
      - Remotely transferred fraction of mass (ϕ2) expresses the relative extent to which the MPs are (net) transferred to the target remote compartment following environmental dispersion to the remote region.