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

Manual: add "role" description, add section on module types (keywords only)

parent 3e465bb4
...@@ -160,6 +160,11 @@ The detector configuration consists of a set of sections describing the detector ...@@ -160,6 +160,11 @@ The detector configuration consists of a set of sections describing the detector
Each section starts with a header describing the name used to identify the detector; all names are required to be unique. Each section starts with a header describing the name used to identify the detector; all names are required to be unique.
Every detector should contain all of the following parameters: Every detector should contain all of the following parameters:
\begin{itemize} \begin{itemize}
\item The \parameter{role} parameter is an array of strings indicating the function(s) of the respective detector. This can be \parameter{dut} or \parameter{reference}, the default is \parameter{none}. With the default, the respective detector participates in tracking but is neither used as reference plane for alignment and correlations, nur treated as DUT. As reference, the detector is used as anchor for relative alignments, and its position and orientation is used to produce correlation plots. As DUT, the detector is by default excluded from tracking, and all DUT-type modules are executed for this detector.
\begin{warning}
There always has to be exactly \emph{one} reference detector in the setup. For setups with a single detector only, the role should be configured as \parameter{dut, reference} for the detector to act as both.
\end{warning}
\item The \parameter{type} parameter is a string describing the type of detector, e.g.\ \parameter{Timepix3} or \parameter{CLICpix2}. This value might be used by some modules to distinguish between different types. \item The \parameter{type} parameter is a string describing the type of detector, e.g.\ \parameter{Timepix3} or \parameter{CLICpix2}. This value might be used by some modules to distinguish between different types.
\item The \parameter{position} in the world frame. \item The \parameter{position} in the world frame.
This is the position of the geometric center of the sensor given in world coordinates as X, Y and Z as defined in Section~\ref{sec:coordinate_systems}. This is the position of the geometric center of the sensor given in world coordinates as X, Y and Z as defined in Section~\ref{sec:coordinate_systems}.
......
...@@ -84,6 +84,16 @@ Another (additional) location to write to can be specified on the command line u ...@@ -84,6 +84,16 @@ Another (additional) location to write to can be specified on the command line u
\item \parameter{library_directories}: Additional directories to search for module libraries, before searching the default paths. \item \parameter{library_directories}: Additional directories to search for module libraries, before searching the default paths.
\end{itemize} \end{itemize}
\section{Module Types}
\begin{itemize}
\item Global
\item Detector
\item DUT
\end{itemize}
restrictions to detector type
\section{Logging and Verbosity Levels} \section{Logging and Verbosity Levels}
\label{sec:logging_verbosity} \label{sec:logging_verbosity}
\corry is designed to identify mistakes and implementation errors as early as possible and to provide the user with clear indications about the problem. \corry is designed to identify mistakes and implementation errors as early as possible and to provide the user with clear indications about the problem.
......
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