ovrlpy.io.read_MERSCOPE
=======================

.. py:function:: ovrlpy.io.read_MERSCOPE(filepath, z_scale = 1.5, *, remove_genes = MERSCOPE_CTRLS, additional_columns = [], n_threads = None)

   Read a Vizgen transcripts file.

   :param filepath: Path to the Vizgen transcripts file. Both, .csv(.gz) and .parquet files, are supported.
   :type filepath: os.PathLike or str
   :param z_scale: Factor to scale z-plane index to um, i.e. distance between z-planes.
   :type z_scale: float
   :param remove_genes: List of regex patterns to filter the 'gene' column,
                        :py:attr:`ovrlpy.io.MERSCOPE_CTRLS` by default.
   :type remove_genes: collections.abc.Collection[str], optional
   :param additional_columns: Additional columns to load from the transcripts file.
   :type additional_columns: collections.abc.Collection[str], optional
   :param n_threads: Number of threads used for parsing the input file.
                     If None, will default to number of available CPUs.
   :type n_threads: int | None, optional

   :rtype: polars.DataFrame