Commit 3cbaa107 authored by Morag Williams's avatar Morag Williams
Browse files

Changes to readme.md files from Simon Spannagel comments

parent b3e051ab
......@@ -5,12 +5,12 @@
#### Description
This algorithm performs translational and rotational telescope plane alignment.
The alignment is performed with respect to the reference plane set in the configuration file. To not include the DUT in this translational and rotational alignment, it will need to be masked in the configuration file.
The alignment is performed with respect to the reference plane set in the configuration file.
This algorithm uses the tracks produced by the `BasicTracking` algorithm to align the telescope planes. There are two methods available for alignment:
This algorithm uses the tracks produced by the `BasicTracking` algorithm to align the telescope planes. 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 parameter `detectorToAlign` is not used in this method as it automatically iterates through all telescope planes except the DUT.
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.
##### 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.
......@@ -19,7 +19,7 @@ For the detector specified by the `detectorToAlign` parameter, this method moves
* `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.
* `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.
......
......@@ -3,9 +3,9 @@
**Status**: Functional
#### Description
This algorithm performs a basic tracking method.
This algorithm performs a basic tracking method.
Clusters from the first plane in Z (named the seed plane) are related to clusters on the other detector planes using straight line tracks. The DUT plane can be excluded from the track finding and DUT clusters potentially associated with the track stored.
Clusters from the first plane in Z (named the seed plane) are related to clusters close in time on the other detector planes using straight line tracks. The DUT plane can be excluded from the track finding and DUT clusters potentially associated with the track stored.
#### Parameters
* `timingCut`: Maximum time difference allowed between clusters for association. In units of seconds. Default value is `0.0000002` (200ns).
......
## Algorithm: DUTAnalysis
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>) ; Daniel Hynds (<daniel.hynds@cern.ch>)
**Status**: Functional
#### Description
......@@ -25,7 +25,7 @@ Using the appropriate parameter settings in the configuration file, plots using
* Track correlations in time
* Cluster ToT vs time
* Residual in time vs time
* 2D histogram of associated track global positions
* 2D histogram of associated track global positions
* 2D histogram of unassociated track global positions
* Residual in X using MC truth information, only produced if `usingMCtruth = true`
* Tracks vs time since power on, only produced in `digitalPowerPusling = true`
......
## Algorithm: TestAlgorithm
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>) ; Daniel Hynds (<daniel.hynds@cern.ch>)
**Status**: Functional
#### Description
This algorithm collects `pixel` and `cluster` objects from the clipboard and creates correlation and timing plots.
This algorithm collects `pixel` and `cluster` objects from the clipboard and creates correlation and timing plots.
#### Parameters
......@@ -21,7 +21,7 @@ For each device the following plots are produced:
* 2D correlation in X in local coordinates
* 2D correlation in Y in local coordinates
* Correlation times histogram
* Correlation times (integer values) histogram
* Correlation times (integer values) histogram
#### Usage
```toml
......
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