sainsc.GridCounts
=================

.. toctree::
   :hidden:

   /autoapi/sainsc/GridCounts.as_dataframe
   /autoapi/sainsc/GridCounts.crop
   /autoapi/sainsc/GridCounts.filter_genes_by_count
   /autoapi/sainsc/GridCounts.filter_mask
   /autoapi/sainsc/GridCounts.from_dataframe
   /autoapi/sainsc/GridCounts.gene_counts
   /autoapi/sainsc/GridCounts.genes
   /autoapi/sainsc/GridCounts.get
   /autoapi/sainsc/GridCounts.grid_counts
   /autoapi/sainsc/GridCounts.select_genes
   /autoapi/sainsc/GridCounts.n_threads
   /autoapi/sainsc/GridCounts.resolution
   /autoapi/sainsc/GridCounts.shape

.. py:class:: sainsc.GridCounts(counts, *, resolution = None, n_threads = None)

   Object holding each gene as count data in a sparse 2D-grid.

   :param counts: Gene counts.
   :type counts: dict[str, scipy.sparse.csr_array | scipy.sparse.csr_matrix | scipy.sparse.csc_array | scipy.sparse.csc_matrix]
   :param resolution: Resolution as nm / pixel.
   :type resolution: float, optional
   :param n_threads: Number of threads used for processing. If `None` or 0 this will default to
                     the number of logical CPUs.
   :type n_threads: int, optional

   :raises ValueError: If genes in `counts` do not all have the same shape.

Attributes
----------

.. autoapisummary::

   sainsc.GridCounts.shape


Properties
----------

.. autoapisummary::

   sainsc.GridCounts.n_threads
   sainsc.GridCounts.resolution


Methods
-------

.. autoapisummary::

   sainsc.GridCounts.as_dataframe
   sainsc.GridCounts.crop
   sainsc.GridCounts.filter_genes_by_count
   sainsc.GridCounts.filter_mask
   sainsc.GridCounts.from_dataframe
   sainsc.GridCounts.gene_counts
   sainsc.GridCounts.genes
   sainsc.GridCounts.get
   sainsc.GridCounts.grid_counts
   sainsc.GridCounts.select_genes