diff --git a/doc/LaTex/DD4hep-setup.tex b/doc/LaTex/DD4hep-setup.tex index 19a5a5d796058ebe84d919f3f0485d6274bb6b01..2f2380b149c679ba933f671f585e2b8d14918748 100644 --- a/doc/LaTex/DD4hep-setup.tex +++ b/doc/LaTex/DD4hep-setup.tex @@ -39,9 +39,11 @@ % \newcommand{\DDE}{{$\tt{DDEve}$\space}} \newcommand{\DDhep}{{$\tt{DD4hep}$\space}} +\newcommand{\DDH}{{$\tt{DD4hep}$\space}} \newcommand{\DDG}{{\tt{DDG4}\space}} \newcommand{\DDA}{{\tt{DDAlign}\space}} -% +\newcommand{\DDR}{{\tt{DDRec}\space}} +%% % \newcommand{\docline}[2]{\vspace{0.1cm}{\bf{#1}} & \parbox{14.5cm}{#2}\\} % @@ -81,7 +83,7 @@ % % === Title page command =============================== % -\newcommand{\mytitle}[2]{ +\newcommand{\mytitle}[3]{ \begin{titlepage} % \pagestyle{empty} @@ -101,13 +103,13 @@ {\Huge\bf{#2}} \vspace{5cm} -M.Frank%\textsuperscript{1}, +{#3} +%M.Frank%\textsuperscript{1}, %F.Gaede\textsuperscript{2}, %C.Grefe\textsuperscript{1}, %P.Mato\textsuperscript{1} - %{\textsuperscript{1} -{CERN, 1211 Geneva 23, Switzerland} +%{CERN, 1211 Geneva 23, Switzerland} %{\textsuperscript{2} Desy, 22607 Hamburg, Germany} \end{center} \end{titlepage} diff --git a/doc/LaTex/DD4hepManual.tex b/doc/LaTex/DD4hepManual.tex index 55ba58a60388bf110217018dcb4587af732811a8..29505865ee6d0a9da1c9826497ea412f202a8b1a 100644 --- a/doc/LaTex/DD4hepManual.tex +++ b/doc/LaTex/DD4hepManual.tex @@ -15,6 +15,15 @@ A Detector Description Toolkit\\ for High Energy Physics\\ \vspace{0.3cm} Experiments +}{ +M.Frank%\textsuperscript{1}, +%F.Gaede\textsuperscript{2}, +%C.Grefe\textsuperscript{1}, +%P.Mato\textsuperscript{1} + +%{\textsuperscript{1} +{CERN, 1211 Geneva 23, Switzerland} +%{\textsuperscript{2} Desy, 22607 Hamburg, Germany} } % % diff --git a/doc/LaTex/DDAlignManual.tex b/doc/LaTex/DDAlignManual.tex index 2e6421191a5bb60a27d13436a2e564a79476b309..4095631b2bf0dde40767e4397e8040472c6890e2 100644 --- a/doc/LaTex/DDAlignManual.tex +++ b/doc/LaTex/DDAlignManual.tex @@ -17,7 +17,17 @@ DD4hep Geometry Description \\ \vspace{0.5cm} Toolkit \vspace{2cm} -}{DDAlign User Manual} +}{ +M.Frank%\textsuperscript{1}, +%F.Gaede\textsuperscript{2}, +%C.Grefe\textsuperscript{1}, +%P.Mato\textsuperscript{1} + +%{\textsuperscript{1} +{CERN, 1211 Geneva 23, Switzerland} +%{\textsuperscript{2} Desy, 22607 Hamburg, Germany} +} +{DDAlign User Manual} % % %== Abstract =============================================================== diff --git a/doc/LaTex/DDConditionsManual.tex b/doc/LaTex/DDConditionsManual.tex index 103da1d9a72004fd3e5c9978cccae7ce306d29df..7ff618bfe996d7dedbc127ddd1f83f51199b2655 100644 --- a/doc/LaTex/DDConditionsManual.tex +++ b/doc/LaTex/DDConditionsManual.tex @@ -16,7 +16,17 @@ DD4hep Geometry Description \\ \vspace{0.5cm} Toolkit \vspace{2cm} -}{DDAlign User Manual} +}{ +M.Frank%\textsuperscript{1}, +%F.Gaede\textsuperscript{2}, +%C.Grefe\textsuperscript{1}, +%P.Mato\textsuperscript{1} + +%{\textsuperscript{1} +{CERN, 1211 Geneva 23, Switzerland} +%{\textsuperscript{2} Desy, 22607 Hamburg, Germany} +} +{DDAlign User Manual} % % %== Abstract =============================================================== diff --git a/doc/LaTex/DDEveManual.tex b/doc/LaTex/DDEveManual.tex index 034ac70f2486fa508ed10f12fb13cbb001c8b01b..09b87f2595723feedfcfbfd572b4aef01adcd745 100644 --- a/doc/LaTex/DDEveManual.tex +++ b/doc/LaTex/DDEveManual.tex @@ -15,7 +15,17 @@ An Event Display for \\ DD4hep Geometries \\ \vspace{2.5cm} -- DRAFT -- \\ -}{DDEve User Manual} +}{ +M.Frank%\textsuperscript{1}, +%F.Gaede\textsuperscript{2}, +%C.Grefe\textsuperscript{1}, +%P.Mato\textsuperscript{1} + +%{\textsuperscript{1} +{CERN, 1211 Geneva 23, Switzerland} +%{\textsuperscript{2} Desy, 22607 Hamburg, Germany} +} +{DDEve User Manual} % % %== Abstract =============================================================== diff --git a/doc/LaTex/DDRecManual.tex b/doc/LaTex/DDRecManual.tex new file mode 100644 index 0000000000000000000000000000000000000000..af63090932eda70cb81d49b7fbf3cab23659a029 --- /dev/null +++ b/doc/LaTex/DDRecManual.tex @@ -0,0 +1,173 @@ +%============================================================================= +\documentclass[10pt,a4paper]{article} +% +\input{DD4hep-setup.tex} +% +\pagestyle{fancyplain}{\fancyfoot[C]{\sffamily{DDRec User Manual}}} +% +\usepackage{amsmath} +\begin{document} +% +\mytitle{ +DDRec +}{ +Reconstruction Interface for the \\ +\vspace{0.5cm} +DD4hep Geometry Description \\ +\vspace{0.5cm} +Toolkit +\vspace{2cm} +}{ +%M.Frank%\textsuperscript{1}, +F.Gaede%\textsuperscript{2}, +%C.Grefe\textsuperscript{1}, +%P.Mato\textsuperscript{1} + +%{\textsuperscript{1} +{CERN, 1211 Geneva 23, Switzerland} + +%{\textsuperscript{2} +{Desy, 22607 Hamburg, Germany} +} +% +% +%== Abstract =============================================================== +\pagestyle{plain} +\pagenumbering{Roman} +\setcounter{page}{1} +\begin{abstract} +%============================================================================= + +\noindent +\normalsize +The reconstruction of particle tracks and clusters in an High Energy Physics detector +requires information about the geometrical and material properties of the various +tracking and calorimeter subdetectors. +In general, a higher level view on the detector geometry is needed than for the purpose +of simulating the detailed detector response with tools such as Geant4\cite{bib:geant4}. +This higher level view typically involves the abstraction of detector layers, the corresponding +measurment surfaces, accumulation of dead material along a path and conversion between cellIDs and +positions. +While in principle it is of course possible to extract this information from the detailed +detector geometry model used for simulation, doing so would tightly couple the reconstruction +code to the specific implementation of the simulation model. +\DDR provides a generalized API for reconstruction that can be used to decouple the details of +the \DDH\cite{bib:DD4hep} detector geometry model from the reconstruction algorithms. + +\end{abstract} + +\vspace{8cm} + +\begin{center} +{\large{\bf{ +\begin{tabular} {| l | l | l |} +\hline +\multicolumn{3}{| c |}{} \\[0.2cm] +\multicolumn{3}{| c |}{Document History} \\[0.2cm] +\multicolumn{3}{| c |}{} \\[0.2cm] +\hline + & & \\ +Document & & \\ +version & Date & Author \\[0.2cm] \hline + & & \\ +1.0 & 11/11/2014 & Frank Gaede CERN/DESY \\ + & & \\ \hline +\end{tabular} +}}} +\end{center} + +\clearpage +% +% +%== TOC ==================================================================== +\tableofcontents +\clearpage +% +% +%============================================================================= +% Manual +%============================================================================= +\pagenumbering{arabic} +\setcounter{page}{1} + +%============================================================================= +\section{Introduction} +\label{sec:ddrec-manual-introduction} +%============================================================================= +\noindent +This manual introduces the \DDR package which is part of \DDH and provides the +high level view on the HEP detector geometry that is needed during reconstruction and +analysis. +In the detailed simulation of the response of a typical High Energy Physics detector +very little information is needed in principle on the actual structure of the material +distribution in the detector. This becomes obvious if one considers the fact that +the Geant4 program is also used in medical applications where the human body +is approximated by a voxelised phantom. +During the reconstruction of particle trajectories and calorimeter clusters, in particular +in the phase of pattern recognition, one typically regards the detector in an abstract +structure of measurement surfaces or volumes that generally follow a layering structure. +\DDR provides an API that provides this information for reconstruction algorithms, thereby +decoupling the details of the actual simulation model used from the reconstruction code. +\noindent +The \DDR API provides the following functionality: + +\begin{itemize}\itemcompact +\item description of measurement surfaces with coordinate systems for + track finding and fitting +\item description of non-active surfaces with material properties in + order to take efffects of multiple scattering and energy loss + into account +\item conversion of cellIDs assigned to simulated tracker and calorimeter hits + to positions of readout cells and vice versa +\item access to a list of materials between any two points inside the world + volume of the detector +\item average material properties between two points +\item computation of radiation and interaction lenghts for detector layers, modules + or arbitrary sections through the detector +\item ... +\end{itemize} + +\noindent +In this manual we describe the different classes in \DDR and how they can be used +in the construction of the detector geometry and at reconstruction. + +%============================================================================= +\section{Surfaces} +\label{sec:ddrec-manual-surfaces} +%============================================================================= + +\begin{figure}[h] + \begin{center} + \includegraphics[height=180mm] {DDRec_surface_classes.png} + \caption{Class diagram with the main classes describing detector + surfaces and their relations.} + \label{fig:ddrec_surfaces_classes} + \end{center} +\end{figure} +\vspace{-0.1cm} + +%============================================================================= +\subsection{namespace DDSurfacess} +\label{subsec:ddrec-ddsurfaces} +%============================================================================= + + + +\newpage +%============================================================================= +\begin{thebibliography}{9} +\bibitem{bib:DD4hep} M. Frank et al, "DD4hep: A Detector Description Toolkit + for High Energy Physics Experiments", + International Conference on Computing in High Energy and Nuclear Physics + (CHEP 2013), \\ + Amsterdam, Netherlands, 2013, proceedings. + +\bibitem{bib:ROOT-tgeo} R.Brun, A.Gheata, M.Gheata, "The ROOT geometry package",\\ + Nuclear Instruments and Methods {\bf{A}} 502 (2003) 676-680. +\bibitem{bib:geant4} S. Agostinelli et al., + "Geant4 - A Simulation Toolkit", \\ + Nuclear Instruments and Methods {\bf{A}} 506 (2003) 250-303. + +\end{thebibliography} +%============================================================================= +\end{document} diff --git a/doc/LaTex/DDRec_surface_classes.png b/doc/LaTex/DDRec_surface_classes.png new file mode 100644 index 0000000000000000000000000000000000000000..dfa85ce1a52ca9fdc45adff11d9c8af1ec7c3819 Binary files /dev/null and b/doc/LaTex/DDRec_surface_classes.png differ