sainsc.io.read_VisiumHD
=======================

.. py:function:: sainsc.io.read_VisiumHD(path, *, gene_name = False, raw = False, n_threads = None)

   Read a VisiumHD sample.

   :param path: Path to the 2um bin directory of the sample. The filtered or raw h5 file and the
                spatial/tissue_positions.parquet file are required.
   :type path: os.PathLike or str
   :param gene_name: If True will use the 'name' column otherwise the 'id' column is used as gene
                     identifier.
   :type gene_name: bool, optional
   :param raw: If `False` the filtered barcode-feature matrix will be used. If `True` the raw
               matrix is loaded.
   :type raw: bool, optional
   :param n_threads: Number of threads used for reading file and processing. If `None` or 0 this will
                     default to the number of available CPUs.
   :type n_threads: int | None, optional

   :rtype: sainsc.LazyKDE

   :raises FileNotFoundError: If either the h5-file or the barcode position file are not found at their
       default path.