Commit 27cfd8f4 authored by Morag Jean Williams's avatar Morag Jean Williams
Browse files

Update README.md

parent 30178d4b
Pipeline #263272 passed with stages
in 3 minutes and 41 seconds
## 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>)
**Status**: Functional
#### 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.
This algorithm uses the tracks produced by the `BasicTracking` algorithm to align the telescope planes. If fewer than half of the tracks have associated clusters, a warning is produced on termina.
This algorithm uses the tracks produced by the `BasicTracking` algorithm 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:
......@@ -22,7 +23,7 @@ For the detector specified by the `detectorToAlign` parameter, this method moves
* `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.
* `prune_tracks`: Boolean to set if tracks with number of associated tracks > `max_associated_clusters` or with a track chi^2 > `` 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`.
* `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`.
* `max_associated_clusters`: Maximum number of associated clusters per track allowed when `prune_tracks=True` for the track to be used in the alignment. Default value is `1`.
* `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`.
......
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