Commit 3e465bb4 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Update README files of all modules

parent 59ca10a9
# AlignmentDUTResidual
# Alignment
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>), Simon Spannagel (<simon.spannagel@cern.ch>)
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>), Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *DUT*
**Detector Type**: *all*
**Status**: Functional
### Description
......
# Millepede
# AlignmentMillepede
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *GLOBAL*
**Status**: Work in progress
### Description
......
# Alignment
# AlignmentTrackChi2
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>), Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *GLOBAL*
**Status**: Functional
### Description
This module performs translational and rotational telescope plane alignment. The alignment is performed with respect to the reference plane set in the configuration file.
This module uses the tracks produced by the `BasicTracking` module to align the telescope planes. If fewer than half of the tracks have associated clusters, a warning is produced on terminal.
There are two methods available for alignment:
##### 1) Minimising the track chi^2
For each telescope detector except the reference plane, this method moves the detector, refits all of the tracks, and minimises the chi^2 of these new tracks. The parameters `detectorToAlign` and `DUT` are not used in this method as it automatically iterates through all telescope planes except the DUT (if a DUT is present).
#### 2) Minimising the track (unbiased) residuals
For the detector specified by the `detectorToAlign` parameter, this method moves the detector, refits all the tracks, and minimises the unbiased residuals calculated from the track intercepts with the plane.
### Parameters
* `number_of_tracks`: Number of tracks used in the alignment method chosen. Default value is `20000`.
* `iterations`: Number of times the chosen alignment method is to be iterated. Default value is `3`.
* `alignmentMethod`: Determines the alignment method used. To use the track chi^2 minimisation `alignmentMethod = 0`; to use the track residual minimisation `alignmentMethod = 1`.
* `detectorToAlign`: Parameter to set a particular plane to align. This parameter is only used in the residuals method (`alignmentMethod = 1`). The default is the `DUT` plane.
* `DUT`: Name of the DUT plane.
* `reference`: Name of the detector used as the alignment reference plane. All other telescope planes are aligned with respect to the reference plane.
* `alignPosition`: Boolean to select whether to align the X and Y displacements of the detector or not. Note that the Z displacement is never aligned. The default value is `true`.
* `alignOrientation`: Boolean to select whether to align the three rotations of the detector under consideration or not. The default value is `true`.
* `prune_tracks`: Boolean to set if tracks with a number of associated clusters > `max_associated_clusters` or with a track chi^2 > `max_track_chi2ndof` should be excluded from use in the alignment. This parameter was designed for `alignmentMethod=1`. The number of discarded tracks is outputted on terminal. Default is `False`.
......@@ -29,7 +19,7 @@ For the detector specified by the `detectorToAlign` parameter, this method moves
* `max_track_chi2ndof`: Maximum track chi^2 value allowed when `prune_tracks=True` for the track to be used in the alignment. Default value is `10.0`.
### Plots produced
For each detector the following plots are produced when using `alignmentMethod = 0`:
For each detector the following plots are produced:
* Translational shift along X-axis vs. iteration number
* Translational shift along Y-axis vs. iteration number
......@@ -38,20 +28,9 @@ For each detector the following plots are produced when using `alignmentMethod =
* Rotational shift around Y-axis vs. iteration number
* Rotational shift around Z-axis vs. iteration number
For the `detectorToAlign` the following plots are produced when using `alignmentMethod = 1`:
* Residual in X (calculated in local coordinates)
* Residual in Y
* Profile plot of residual in X vs. X position
* Profile plot of residual in X vs. Y position
* Profile plot of residual in Y vs. X position
* Profile plot of residual in Y vs. Y position
### Usage
```toml
[Alignment]
alignmentMethod = 0
[AlignmentTrackChi2]
number_of_tracks = 1000000
log_level = INFO
```
# CLICpixAnalysis
# AnalysisCLICpix
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>)
**Module Type**: *DUT*
**Detector Type**: *CLICpix*
**Status**: Functional
### Description
......
# CLICpix2Analysis
# AnalysisDUT
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *DUT*
**Detector Type**: *all*
**Status**: Work in progress
### Description
......
# AnalysisEfficiency
**Maintainer**: Simon Spannagel (simon.spannagel@cern.ch)
**Module Type**: *DUT*
**Detector Type**: *all*
**Status**: Functional
### Description
......
# AnalysisPowerPulsing
**Maintainer**: Estel Perez Codina
**Module Type**: *DUT*
**Module Type**: *Timepix3*
**Status**: Immature
### Description
......
# TelescopeAnalysis
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
# AnalysisTelescope
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *GLOBAL*
**Status**: Work in progress
### Description
......
# Timepix3Clustering
# Clustering4D
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *all*
**Status**: Functional
### Description
......
# SpatialClustering
# ClusteringSpatial
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *all*
**Status**: Functioning
### Description
......
# DUTAssociation
**Maintainer**: Simon Spannagel (simon.spannagel@cern.ch)
**Maintainer**: Simon Spannagel (simon.spannagel@cern.ch)
**Module Type**: *DUT*
**Detector Type**: *all*
**Status**: Functional
### Description
......
# Dummy
**Maintainer**: *NAME* (*EMAIL*)
**Module Type**: *GLOBAL*
**Status**: Functional
### Description
......
# EtaCalculation
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>), Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *all*
**Status**: Under development
### Description
......
# EtaCorrection
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>), Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *all*
**Status**: Under development
### Description
......
# ATLASpixEventLoader
# EventLoaderATLASpix
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *ATLASpix*
**Status**: Functional
### Description
......
# CLICpixEventLoader
# EventLoaderCLICpix
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *CLICpix*
**Status**: Functional
### Description
......
# CLICpix2EventLoader
# EventLoaderCLICpix2
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>), Simon Spannagel (<simon.spannagel@cern.ch>), Morag Williams (<morag.williams@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *CLICpix2*
**Status**: Functional
### Description
......
# EUDAQEventLoader
# EventLoaderEUDAQ
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *GLOBAL*
**Status**: Functional
### Description
......
# Timepix1EventLoader
# EventLoaderTimepix1
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>)
**Module Type**: *GLOBAL*
**Status**: Functional
### Description
......
# Timepix3EventLoader
# EventLoaderTimepix3
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>), Simon Spannagel (<simon.spannagel@cern.ch>)
**Module Type**: *DETECTOR*
**Detector Type**: *Timepix3*
**Status**: Functional
### Description
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment