gnn_tracking.postprocessing.clusterscanner
==========================================

.. py:module:: gnn_tracking.postprocessing.clusterscanner


Classes
-------

.. autoapisummary::

   gnn_tracking.postprocessing.clusterscanner.ClusterScanner
   gnn_tracking.postprocessing.clusterscanner.CombinedClusterScanner


Module Contents
---------------

.. py:class:: ClusterScanner(*args, **kwargs)

   Bases: :py:obj:`pytorch_lightning.core.mixins.hparams_mixin.HyperparametersMixin`, :py:obj:`abc.ABC`


   Base class for cluster scanners. Use any of its subclasses.


   .. py:method:: __call__(data: torch_geometric.data.Data, out: dict[str, torch.Tensor], i_batch: int) -> None
      :abstractmethod:



   .. py:method:: reset() -> None


   .. py:method:: get_foms() -> dict[str, Any]


.. py:class:: CombinedClusterScanner(scanners: list[ClusterScanner])

   Bases: :py:obj:`ClusterScanner`


   Combine multiple `ClusterScanner` objects.


   .. py:attribute:: _scanners


   .. py:method:: __call__(*args, **kwargs)


   .. py:method:: reset() -> None


   .. py:method:: get_foms() -> dict[str, Any]