ovrlpy.io.read_CosMx
====================

.. py:function:: ovrlpy.io.read_CosMx(filepath, scale = {'xy': 0.12028, 'z': 0.8}, *, remove_targets = COSMX_CTRLS, additional_columns = [], n_threads = None)

   Read a Nanostring CosMx transcripts file.

   :param filepath: Path to the CosMx transcripts file.
   :type filepath: os.PathLike or str
   :param scale: The factors for scaling the coordinates from pixel space to um.
   :type scale: collections.abc.Mapping[str, float]
   :param remove_targets: List of regex patterns to filter the 'target' column,
                          :py:attr:`ovrlpy.io.COSMX_CTRLS` by default.
   :type remove_targets: 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