demcompare.report
=================

.. py:module:: demcompare.report

.. autoapi-nested-parse::

   Generate demcompare report from DEM comparison results (graphs, stats, ...)

   Steps:
   - init SphinxProjectManager class structure
   - create all data and documentation structure for each classif_layer and mode
   - create sphinx source rst report and add to SphinxProjectManager object
   - Compile SphinxProjectManager object to generate html and pdf report



Functions
---------

.. autoapisummary::

   demcompare.report.fill_report_stats
   demcompare.report.fill_report_image_views
   demcompare.report.fill_report
   demcompare.report.generate_report


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

.. py:function:: fill_report_stats(working_dir: str, stats_dataset: demcompare.stats_dataset.StatsDataset, src: str) -> str

   Fill report with statistics information for all cases:
   without coreg:
   - two dems : diff of the two dems
   - one dsm : stats on the dem alone.

   with coreg and two dems: diff of two coregistered dems.

   TODO: if refacto report, use only csv or stats_dataset but not both

   :param working_dir: directory in which to find
        *mode*.csv files for each mode in modename
   :type working_dir: str
   :param stats_dataset: StatsDataset object
   :type stats_dataset: StatsDataset
   :param src: report source
   :type src: str
   :return: filled src
   :rtype:


.. py:function:: fill_report_image_views(working_dir: str, stats_dataset: demcompare.stats_dataset.StatsDataset, src: str) -> str

   Fill report with image views: snapshots, cdf, pdf information

   :param working_dir: directory in which to find
        *mode*.csv files for each mode in modename
   :param src: report source
   :return: filled src


.. py:function:: fill_report(cfg: demcompare.internal_typing.ConfigType, stats_datasets: List[demcompare.stats_dataset.StatsDataset] = None) -> str

   Fill sphinx demcompare report into a string from cfg and stats_dataset

   :param cfg: input demcompare configuration
   :param stats_dataset: stats dataset demcompare object containing results


.. py:function:: generate_report(cfg: demcompare.internal_typing.ConfigType, stats_datasets: List[demcompare.stats_dataset.StatsDataset] = None)

   Generate demcompare report

   :param cfg: input demcompare configuration
   :param stats_dataset: stats dataset demcompare object containing results