ultrasound_metrics.data.uff
===========================

.. py:module:: ultrasound_metrics.data.uff

.. autoapi-nested-parse::

   UFF dataset utilities for ultrasound data.

   This module provides functions for loading UFF datasets that require pyuff_ustb.
   If you don't work with UFF files, you can use the general utilities in visualize_bmode.py
   without needing to install pyuff_ustb.



Attributes
----------

.. autoapisummary::

   ultrasound_metrics.data.uff.CACHE_DIR
   ultrasound_metrics.data.uff.USTB_DATASETS


Classes
-------

.. autoapisummary::

   ultrasound_metrics.data.uff.DatasetInfo


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

.. py:class:: DatasetInfo

   Bases: :py:obj:`TypedDict`


   Type definition for dataset information.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: description
      :type:  str


   .. py:attribute:: filename
      :type:  str


   .. py:attribute:: size
      :type:  int


   .. py:attribute:: url
      :type:  str


.. py:data:: CACHE_DIR

.. py:data:: USTB_DATASETS
   :type:  dict[str, DatasetInfo]