astrohack.utils.verification_tools
==================================

.. py:module:: astrohack.utils.verification_tools


Functions
---------

.. autoapisummary::

   astrohack.utils.verification_tools.are_lists_equal
   astrohack.utils.verification_tools.are_fits_files_close
   astrohack.utils.verification_tools.are_png_files_close
   astrohack.utils.verification_tools.capture_prints_from_function
   astrohack.utils.verification_tools.are_txt_files_equal
   astrohack.utils.verification_tools.is_captured_output_equal_to_txt_reference
   astrohack.utils.verification_tools.are_dicts_close
   astrohack.utils.verification_tools.are_data_trees_close
   astrohack.utils.verification_tools.add_data_folder_to_names_in_class
   astrohack.utils.verification_tools.relative_difference
   astrohack.utils.verification_tools.analyse_summary
   astrohack.utils.verification_tools.create_origin_dict


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

.. py:function:: are_lists_equal(list_a, list_b)

.. py:function:: are_fits_files_close(fits_path1, fits_path2, tol=1e-05)

.. py:function:: are_png_files_close(img_path1, img_path2, tol=1e-05)

.. py:function:: capture_prints_from_function(function, args=None)

.. py:function:: are_txt_files_equal(txt_path1, txt_path2, ignored_key_words=())

.. py:function:: is_captured_output_equal_to_txt_reference(function, txt_ref, args=None)

.. py:function:: are_dicts_close(dict_a, dict_b, tol=1e-08, ignored_keys=None)

   Compares dictionaries and returns True if data is close up to tolerance.

   :param dict_a: First dictionary
   :type dict_a: dict

   :param dict_b: Second dictionary
   :type dict_b: dict

   :param tol: Tolerance
   :type tol: float

   :param ignored_keys: Keys to be ignored in comparison
   :type ignored_keys: list, NoneType

   :return: is_close
   :rtype: bool


.. py:function:: are_data_trees_close(tree_a, tree_b, tol=1e-08)

   Compares data trees and returns True if data is close up to tolerance.
   :param tree_a: First data tree
   :type tree_a: xarray.DataTree

   :param tree_b: Second data tree
   :type tree_b: xarray.DataTree

   :param tol: Tolerance
   :type tol: float

   :return: is_close
   :rtype: bool


.. py:function:: add_data_folder_to_names_in_class(class_ref)

.. py:function:: relative_difference(result, expected)

.. py:function:: analyse_summary(mds_obj, exp_file_name, exp_input_pars, exp_ant_keys_list)

   analyse summary file


.. py:function:: create_origin_dict(caller)