quadsv
======

.. py:module:: quadsv

.. autoapi-nested-parse::

   quadsv: kernel-based spatial pattern detection and comparison for spatial omics.

   The public top-level API is organised in four layers:

   1. **Kernels** — :class:`MatrixKernel` (dense / sparse), :class:`FFTKernel`
      (regular grid), :class:`NUFFTKernel` (irregular 2D coordinates). The
      :class:`~quadsv.kernels.Kernel` and
      :class:`~quadsv.kernels.MatrixKernelBase` ABCs live in
      :mod:`quadsv.kernels` and are intended for backend authors.
   2. **Statistical tests** — :func:`spatial_q_test` and :func:`spatial_r_test`.
      A single entry point per test dispatches on the kernel type (matrix, FFT,
      or NUFFT). Signature: ``(x, kernel, null_params=None, return_pval=True,
      is_standardized=False)``.
   3. **Detectors** — :class:`DetectorIrregular` consumes :class:`anndata.AnnData`
      (irregular grids, matrix/NUFFT backends); :class:`DetectorGrid` consumes
      :class:`spatialdata.SpatialData` (regular grids, FFT backend).
   4. **Comparators** — cross-sample pattern comparison:
      :class:`ComparatorIrregular` on a list of AnnData (NUFFT backend);
      :class:`ComparatorGrid` on a list of SpatialData (FFT backend).



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/quadsv/api/index
   /autoapi/quadsv/comparators/index
   /autoapi/quadsv/detectors/index
   /autoapi/quadsv/kernels/index
   /autoapi/quadsv/statistics/index
   /autoapi/quadsv/utils/index