Commit 6da11b0a authored by Morag Williams's avatar Morag Williams
Browse files

Adding line to readme.md files to explain global parameters

parent 3cbaa107
......@@ -24,3 +24,4 @@ Outdated as data format and decoding for this device has since changed.
DUT = "W0005_H03"
inputDirectory = /user/data/directory
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -41,3 +41,4 @@ masked = "W0005_H03" #excluding the DUT from the alignment
number_of_tracks = 1000000
log_level = INFO
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -40,3 +40,4 @@ spatialCut = 0.3 #300um
timingCut = 0.0000002 #200ns
excludeDUT = true
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -23,3 +23,4 @@ The algorithm opens and reads one data file in the specified input directory wit
DUT = "W0005_H03"
inputDirectory = /user/data/directory
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
## Algorithm: CLICpix2Correlator
**Maintainer**: Daniel Hynds (<daniel.hynds@cern.ch>)
**Status**: Functional
**Status**: Functional
#### Description
This algorithm makes plots of the correlations in X and Y for angles between 0 and 2pi in steps of 0.6 radians.
......@@ -19,3 +19,4 @@ This algorithm makes plots of the correlations in X and Y for angles between 0 a
[CLICpix2Correlator]
DUT = "W0005_H03"
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -22,3 +22,4 @@ The algorithm opens and reads one data file in the specified input directory. Fo
DUT = "W0005_H03"
inputDirectory = /user/data/directory
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -24,7 +24,7 @@ For the DUT the following plots are produced:
* Cluster width histogram (rows, Y-axis)
* Cluster width histogram (columns, X-axis)
* Global track difference
* Global track difference
* Global track difference in Y
* Global residuals in X
* Global residuals in Y
......@@ -37,7 +37,7 @@ For the DUT the following plots are produced:
* Global residuals in X vs row width
* Global residuals in Y vs column width
* Global residuals in Y vs row width
*
*
* Track intercept in rows
* Track intercept in columns
* Absolute residual map histogram
......@@ -76,14 +76,14 @@ For the DUT the following plots are produced:
* Pixel ToT for columns for 2-pixel clusters
* Cluster ToT ratio for rows for 2-pixel clusters
* Cluster ToT ratio for rows for 2-pixel clusters
* Local residuals for rows for 2-pixel clusters
* Local residuals for rows for 2-pixel clusters
* 2D track intercepts
* 2D associatedd track intercepts
* 2D cluster positions in global coordinates
* 2D associated cluster positions in global coordinates
* 2D track-pixel intercepts
* 2D track-associated pixel intercepts
* 2D track-pixel intercepts
* 2D track-associated pixel intercepts
* 2D track-chip intercepts
* 2D track-associated chip intercepts
* 2D track-unassociated chip intercepts
......@@ -106,3 +106,4 @@ proximityCut = 0.005
timepix3Telescope = true
DUT = "W0003_H05"
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
## Algorithm: DUTAnalysis
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>) ; Daniel Hynds (<daniel.hynds@cern.ch>)
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>) ; Daniel Hynds (<daniel.hynds@cern.ch>)
**Status**: Functional
#### Description
......@@ -38,3 +38,4 @@ digitalPowerPusling = false
useMCtruth = true
DUT = "W0005_H03"
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -18,4 +18,5 @@ No plots are produced.
DeviceToDumpData = "W0005_H03"
inputDirectory = "path/to/directory"
```
\ No newline at end of file
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -9,7 +9,7 @@ This algorithm takes data from Timepix3 devices from the clipboard and plots the
No parameters are used from the configuration file.
#### Plots produced
* Histogram of event numbers
* Histogram of event numbers
For each detector the following plots are produced:
* 2D histogram of pixel hit positions
......@@ -19,3 +19,4 @@ For each detector the following plots are produced:
[EtaCorrection]
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -16,7 +16,7 @@ This algorithm reads in an input file containing trees with data previously writ
* `DUT`: Name of the DUT plane.
#### Plots produced
No plots are produced.
No plots are produced.
#### Usage
```toml
......@@ -30,3 +30,4 @@ fileName = "input_file.root"
timeWindow = 1
DUT = "W0005_H03"
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -25,4 +25,5 @@ writePixels = true
writeClusters = true
writeTracks = true
fileName = "output.root"
```
\ No newline at end of file
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -25,3 +25,4 @@ Plots produced on screen for each device:
DUT = "W000_H03"
updateNumber = 400
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -9,7 +9,7 @@ This algorithm takes data from a Timepix3 device from the clipboard and plots th
No parameters are used from the configuration file.
#### Plots produced
* Histogram of event numbers
* Histogram of event numbers
For each detector the following plots are produced:
* 2D histogram of pixel hit positions
......@@ -19,3 +19,4 @@ For each detector the following plots are produced:
[GenericAlgorithm]
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -8,7 +8,7 @@ This algorithm opens a GUI to monitor the progress of Corryvreckan reconstructio
Users should be able to exit `OnlineMonitor` and leave the reconstruction still running, but currently this causes a crash.
#### Parameters
* `reference`: Name of the reference plane.
* `reference`: Name of the reference plane.
#### Plots produced
Overview canvas:
......@@ -33,3 +33,4 @@ For each detector the following plots are produced:
[OnlineMonitor]
reference = "W0013_E03"
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -7,7 +7,7 @@ This algorithm performs translational telescope plane alignment.
This initial alignment along the X and Y axes is designed to be performed before the `Alignment` algorithm, which carries out translational and rotational alignment of the planes. To not include the DUT in this transaltional alignment, it will need to be masked in the configuration file.
The required translational shifts in X and Y are calculated for each detector as the mean of the 1D correlation histogram along the axis.
The required translational shifts in X and Y are calculated for each detector as the mean of the 1D correlation histogram along the axis.
#### Parameters
* `reference`: Name of the detector used as the alignment reference plane. All other telescope planes are aligned with respect to the reference plane.
......@@ -32,14 +32,4 @@ masked = "W0005_H03" #excluding the DUT from the prelaignment
max_correlation_rms = 6.0
damping_factor = 1.0
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -21,3 +21,4 @@ For each detector the following plots are produced:
[NAME]
ALLPARAMETERS = VALUE
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -17,3 +17,4 @@ No plots are produced.
[SpatialClustering]
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
......@@ -31,3 +31,4 @@ minHitsOnTrack = 5
excludeDUT = true
DUT = "W0005_H03"
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
## Algorithm: TestAlgorithm
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>) ; Daniel Hynds (<daniel.hynds@cern.ch>)
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>) ; Daniel Hynds (<daniel.hynds@cern.ch>)
**Status**: Functional
#### Description
......@@ -29,3 +29,4 @@ For each device the following plots are produced:
makeCorrelations = true
reference = "W0013_E03"
```
Parameters to be used in multiple algorithms can also be defined globally at the top of the configuration file. This is highly encouraged for parameters such as `DUT` and `reference`.
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