README.md 1.15 KB
Newer Older
1
# Clustering4D
2
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>)  
3
4
**Module Type**: *DETECTOR*  
**Detector Type**: *all*  
5
**Status**: Functional
6

7
### Description
8
This module performs clustering on data from a Timepix3 device. The clustering method is a charge-weighted centre of gravity calculation, using a positional cut and a timing cut on proximity.
9

10
11
Split clusters can be recovered using a larger search radius for neighbouring pixels.

12
### Parameters
13
* `timing_cut`: The maximum value of the time difference between two pixels for them to be associated in a cluster. Default value is `100ns`.
14
15
* `neighbour_radius_col`: Search radius for neighbouring pixels in column direction, defaults to `1` (do not allow split clusters)
* `neighbour_radius_row`:  Search radius for neighbouring pixels in row direction, defaults to `1` (do not allow split clusters)
16

17
### Plots produced
18
For each detector the following plots are produced:
19

20
21
22
23
24
25
* Cluster size histogram
* Cluster width (rows, in X) histogram
* Cluster width (columns, in Y) histogram
* Cluster ToT histogram
* 2D cluster positions in global coordinates

26
### Usage
27
28
```toml
[Timepix3Clustering]
29
timing_cut = 200ns
30
```