===========
FindCluster
===========

Link to source: `FindCluster <https://github.com/XENONnT/fuse/blob/master/fuse/plugins/micro_physics/find_cluster.py>`_ 

Plugin Description
==================
Plugin to find clusters of energy deposits.

This plugin is performing the first half of the microclustering
process. Energy deposits are grouped into clusters based on their
proximity to each other in 3D space and time. The clustering is
performed using a 1D temporal clustering algorithm followed by 3D
DBSCAN spacial clustering.


Technical Details
-----------------

.. code-block:: python

   depends_on = ('geant4_interactions',)
   provides = ('cluster_index',)
   data_kind = geant4_interactions
   __version__ = 0.2.1


Provided Columns
================

cluster_index
-------------

.. list-table::
   :widths: 25 25 50
   :header-rows: 1

   * - Field Name
     - Data Type
     - Comment
   * - cluster_ids
     - int32
     - Cluster index of the energy deposit
   * - time
     - int64
     - Start time since unix epoch [ns]
   * - endtime
     - int64
     - Exclusive end time since unix epoch [ns]

Config Options
==============

.. list-table::
   :widths: 25 25 10 40
   :header-rows: 1

   * - Option
     - default
     - track
     - Help
   * - debug
     - False
     - False
     - Show debug informations
   * - deterministic_seed
     - True
     - True
     - Set the random seed from lineage and run_id, or pull the seed from the OS
   * - micro_separation
     - 0.005
     - True
     - DBSCAN clustering distance (mm)
   * - micro_separation_time
     - 10
     - True
     - Clustering time (ns)
   * - user_defined_random_seed
     - None
     - True
     - Define the random seed manually. You need to set deterministic_seed to False

Dependency Graph
================


.. raw:: html

    <!-- Title: %3 Pages: 1 -->
    <svg width="213pt" height="116pt"
     viewBox="0.00 0.00 213.38 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
    <g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
    <title>%3</title>
    <polygon fill="white" stroke="transparent" points="-4,4 -4,-112 209.38,-112 209.38,4 -4,4"/>
    <!-- cluster_index -->
    <g id="node1" class="node">
    <title>cluster_index</title>
    <g id="a_node1"><a xlink:href="#cluster-index" xlink:title="cluster_index">
    <ellipse fill="#40c4f3" stroke="black" cx="102.69" cy="-90" rx="72.59" ry="18"/>
    <text text-anchor="middle" x="102.69" y="-86.3" font-family="Times,serif" font-size="14.00">cluster_index</text>
    </a>
    </g>
    </g>
    <!-- geant4_interactions -->
    <g id="node2" class="node">
    <title>geant4_interactions</title>
    <g id="a_node2"><a xlink:href="#geant4-interactions" xlink:title="geant4_interactions">
    <ellipse fill="#40c4f3" stroke="black" cx="102.69" cy="-18" rx="102.88" ry="18"/>
    <text text-anchor="middle" x="102.69" y="-14.3" font-family="Times,serif" font-size="14.00">geant4_interactions</text>
    </a>
    </g>
    </g>
    <!-- cluster_index&#45;&gt;geant4_interactions -->
    <g id="edge1" class="edge">
    <title>cluster_index&#45;&gt;geant4_interactions</title>
    <path fill="none" stroke="black" d="M102.69,-71.7C102.69,-63.98 102.69,-54.71 102.69,-46.11"/>
    <polygon fill="black" stroke="black" points="106.19,-46.1 102.69,-36.1 99.19,-46.1 106.19,-46.1"/>
    </g>
    </g>
    </svg>