cars.pipelines.analysis.report_tools
====================================

.. py:module:: cars.pipelines.analysis.report_tools

.. autoapi-nested-parse::

   CARS analysis pipeline report tools module



Functions
---------

.. autoapisummary::

   cars.pipelines.analysis.report_tools.make_paths_relative
   cars.pipelines.analysis.report_tools.merge_reports
   cars.pipelines.analysis.report_tools.generate_report_cars_output
   cars.pipelines.analysis.report_tools.safe_list_return
   cars.pipelines.analysis.report_tools.normalize_image
   cars.pipelines.analysis.report_tools.generate_epipolar_images
   cars.pipelines.analysis.report_tools.generate_envelope_images
   cars.pipelines.analysis.report_tools.generate_dsm_overview
   cars.pipelines.analysis.report_tools.save_robust_overview
   cars.pipelines.analysis.report_tools.generate_hillshade
   cars.pipelines.analysis.report_tools.generate_satellite_plot_mpl
   cars.pipelines.analysis.report_tools.generate_satelite_position_report


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

.. py:function:: make_paths_relative(html_content, output_file_path)

   Transform absolute paths in the HTML content.

   :param html_content: html content
   :param output_file_path:
   :return: htm content with relative paths


.. py:function:: merge_reports(reports_html_files, report_file_html, report_file_pdf)

   Merge the reports pdfs into one report pdf

   :param reports_html_files: list of paths to the reports htmls to merge
   :type reports_html_files: list of str
   :param report_file_html: path to the merged report html
   :type report_file_html: str
   :param report_file_pdf: path to the merged report pdf
   :type report_file_pdf: str


.. py:function:: generate_report_cars_output(report_file, output_dir, log_error, used_conf)

   Generate a report PDF using HTML and WeasyPrint.

   :param report_file: path to the report pdf to generate
   :param output_dir: cars output directory
   :param log_error: error log string or status
   :param used_conf: configuration dictionary


.. py:function:: safe_list_return(func)

   Wrapper to ensure that the decorated function returns a
   list even in case of exceptions.
   :param func:
   :return:


.. py:function:: normalize_image(img)

   Normalize image for better visualization
   :param img: input image
   :return: clipped and normalized image


.. py:function:: generate_epipolar_images(output_dir, used_resolution, images_dir)

   Generate the epipolar images overview

   :param output_dir: cars output directory
   :type output_dir: str
   :param used_resolution: used resolution for the report
   :type used_resolution: float
   :param images_dir: path to the directory to save the generated image
   :type images_dir: str

   :return path to the generated image
   :rtype: str


.. py:function:: generate_envelope_images(output_dir, used_resolution, images_dir)

   Generate the envelope interpretation image

   :param output_dir: cars output directory
   :type output_dir: str
   :param used_resolution: used resolution for the report
   :type used_resolution: float
   :param images_dir: path to the directory to save the generated image
   :type images_dir: str

   :return path to the generated image
   :rtype: str


.. py:function:: generate_dsm_overview(output_dir, images_dir)

   Generate the dsm overview image

   :param output_dir: cars output directory
   :type output_dir: str
   :param images_dir: path to the directory to save the generated image
   :type images_dir: str

   :return path to the generated image
   :rtype: str


.. py:function:: save_robust_overview(input_path, output_png, title, cmap=None)

   Convert to overview
   :param input_path:
   :param output_png:
   :param title:
   :param cmap:
   :return:


.. py:function:: generate_hillshade(dsm_path, output_path, azimuth=315, altitude=45)

   Generates a hillshade from a Digital Surface Model (DSM).

   Parameters:
   - dsm_path: Path to the input .tif file
   - output_path: Path to save the generated hillshade
   - azimuth: Direction of the light source (0-360, 315 is North-West)
   - altitude: Solar elevation angle (0-90)


.. py:function:: generate_satellite_plot_mpl(sat_positions, output_png)

   Generate a satellite position plot using Matplotlib.
   :param sat_positions: list of satelite positions
   :param output_png: path to save the generated image
   :return:


.. py:function:: generate_satelite_position_report(sat_positions, sat_infos, output_dir)

   Geneate a report with the satellite positions and infos
   :param sat_positions:
   :param sat_infos:
   :param output_dir:
   :return: