============
pIMZ Modules
============



imzML Parser
------------
a imzML


.. automodule:: pIMZ.imzml
    :members:
    :inherited-members:
    :show-inheritance:

SpectraRegion
-------------
a SpectraRegion


.. automodule:: pIMZ.regions
    :members:
    :inherited-members:
    :show-inheritance:

Clustering Module
-----------------
a Clustering

.. autoclass:: pIMZ.clustering.RegionEmbedding
    :members:
    :inherited-members:

.. autoclass:: pIMZ.clustering.PCAEmbedding
    :members:
    :inherited-members:

.. autoclass:: pIMZ.clustering.UMAPEmbedding
    :members:
    :inherited-members:

.. autoclass:: pIMZ.clustering.UMAP_WARD_Clusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.DENSMAP_WARD_Clusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.UMAP_DBSCAN_Clusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.DENSMAP_DBSCAN_Clusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.KMeansClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.ModifiedKMeansClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.ShrunkenCentroidClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.SARegionClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.SASARegionClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.UPGMAClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.WPGMAClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.WARDClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.MedianClusterer
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: pIMZ.clustering.CentroidClusterer
    :members:
    :inherited-members:
    :show-inheritance:

Comparative
-----------

a Comparative


.. automodule:: pIMZ.comparative
   :members:

HuBMap Downloader
-----------------

a downloader


.. automodule:: pIMZ.hubmap_downloader
   :members: