iddn_data.load_data
===================

.. py:module:: iddn_data.load_data

.. autoapi-nested-parse::

   Load resources in the iDDN package

   Include some example data and images. They are used in the tutorial and the testing part.



Attributes
----------

.. autoapisummary::

   iddn_data.load_data.data_dir


Functions
---------

.. autoapisummary::

   iddn_data.load_data.load_example
   iddn_data.load_data.get_image_path


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

.. py:data:: data_dir

.. py:function:: load_example(file_name='example.npz')

   Load example and testing data of iDDN

   :param file_name: The name of the data file to load. It should be a NumPy npz file.
   :type file_name: str

   :rtype: The loaded NumPy object


.. py:function:: get_image_path(img_name='three_layers.png')

   Get the full path of an image in the resource folder of the iDDN package

   :param img_name: The name of the image to load
   :type img_name: str

   :rtype: The full path of the image