Commit 69c9cc39 authored by Katharina Dort's avatar Katharina Dort
Browse files

Minor corrections in README and logging

parent 984d0a60
......@@ -161,8 +161,9 @@ void Prealignment::finalise() {
throw InvalidValueError(m_config, "method", "Invalid prealignment method");
}
LOG(INFO) << "Detector " << m_detector->name() << ": x = " << Units::display(shift_X, {"mm", "um"})
<< " , y = " << Units::display(shift_Y, {"mm", "um"});
LOG(DEBUG) << "Shift (without damping factor)" << m_detector->name()
<< ": x = " << Units::display(shift_X, {"mm", "um"})
<< " , y = " << Units::display(shift_Y, {"mm", "um"});
LOG(INFO) << "Move in x by = " << Units::display(shift_X * damping_factor, {"mm", "um"})
<< " , and in y by = " << Units::display(shift_Y * damping_factor, {"mm", "um"});
m_detector->displacement(XYZPoint(m_detector->displacement().X() + damping_factor * shift_X,
......
......@@ -9,7 +9,7 @@ This module performs translational telescope plane alignment. The rotational ali
This initial alignment along the X and Y axes is designed to be performed before the `Alignment` module, 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 way in which the required translational shifts in X and Y are calculated is specified by the parameter `prealign_method`.
The way in which the required translational shifts in X and Y are calculated is specified by the parameter `method`.
Either the mean of the 1D correlation histogram, its maximum or the mean of a Gaussian fit can be used to determine the translational shifts.
As described in the alignment chapter of the user manual, the spatial correlations in X and Y should not be forced to be centered around zero for the final alignment as they correspond to the *physical displacement* of the detector plane in X and Y with respect to the reference plane.
However, for the prealignment this is a an acceptable estimation which works without any tracking.
......@@ -19,7 +19,8 @@ However, for the prealignment this is a an acceptable estimation which works wit
* `max_correlation_rms`: The maximum RMS of the 1D correlation histograms allowed for the shifts to be applied. This factor should be tuned for each run, and is combat the effect of flat distributions. Default value is `6mm`.
* `time_cut_rel`: Number of standard deviations the `time_resolution` of the detector plane will be multiplied by. This value is then used as the maximum time difference between a cluster on the current detector and a cluster on the reference plane to be considered in the prealignment. Absolute and relative time cuts are mutually exclusive. Defaults to `3.0`.
* `time_cut_abs`: Specifies an absolute value for the maximum time difference between a cluster on the current detector and a cluster on the reference plane to be considered in the prealignment. Absolute and relative time cuts are mutually exclusive. No default value.
* `method`: Specifies which method should be used to compute the translational shifts. With the option `mean` the mean of the 1D correlation histogram is used. The option `maximum` uses the maximum value of the histogram and with `gauss_fit` a Gaussian is fitted. The fit range is given by `fit_range_rel` times the spatial resolution of the corresponding detector around the maximum of the histogram. The mean of the fitted Gaussian is used for the translational shift. Default is to `mean`. The default of the relative fit range is `fit_range_rel` = 500.
* `method`: Specifies which method should be used to compute the translational shifts. With the option `mean` the mean of the 1D correlation histogram is used. The option `maximum` uses the maximum value of the histogram. With `method` set to `gauss_fit` a Gaussian is fitted and the mean of the fit is used for the translational shift. Default is to `mean`.
* `fit_range_rel`: Parameter to set the fit range of the Gaussian fit if `method` is set to `gauss_fit`. The absolute fit range is given by `fit_range_rel` times the spatial resolution of the corresponding detector around the maximum of the 1D correlation histogram. The default of the relative fit range is `fit_range_rel` = 500.
### Plots Created
......
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