ATO-98 - connect distortion trees - with custom description ()
[u/mrichter/AliRoot.git] / TPC / doc / Definitions / naming_convention.tex
CommitLineData
a65a7e70 1\documentclass[11pt,a4paper]{article}
2\usepackage[latin1]{inputenc}
3\usepackage[english]{babel}
4\usepackage{amsmath}
5\usepackage{amsfonts}
6\usepackage{amssymb}
7\usepackage{hyperref}
8\usepackage[a4paper, left=1.5cm, right=1cm, top=2cm]{geometry}
9%\author{Marian Ivano, Nicole Martin, Patrick Reichelt and Jens Wiechula}
10%\title{Naming conventions for trending variables and QA WEB directory}
11\begin{document}
12\title{Naming conventions for trending variables and QA WEB directory}
13\author{Marian Ivano, Nicole Martin, Patrick Riechelt and Jens Wiechula}
14\maketitle
15
16This file explains the definition of the naming convention for trending variables and the QA WEB directory. You can also find a presentation explaining the naming conventions for the trending variables here:
17\url{https://indico.cern.ch/getFile.py/access?contribId=4&resId=0&materialId=slides&confId=171449} .
18As well as a presentation explaining the naming conventions for the QA WEB directory here:
19\url{https://indico.cern.ch/getFile.py/access?contribId=3&resId=0&materialId=slides&confId=235865}.
20
21\section{Trending variables}
22
23\subsection{General}
24
25\begin{itemize}
26
27\item Seperate `properties' by a `\_' : \\ \setlength{\parskip}{1pt}
28
29Variable name as main identifyer \hspace*{3cm} Statisctics and fit propertie \\
30\hspace*{0.3cm} $ \downarrow $ \hspace*{10cm} $ \downarrow $
31
32 \small{Type\_ SideA/C\_ ChargePlus/Minus\_ StatisicType(StatMean/StatRMS/StatChi2/FitSlope/FitMean/FitSigma)\_ Err} \\
33 \hspace*{1.5cm} $ \uparrow $\hspace*{2cm} $ \uparrow $ \hspace*{13.1cm} $ \uparrow $ \\
34 \hspace*{1cm} Further type specifications \hspace*{10cm} Error of an-\hspace*{15.5cm} other variable
35
36\item Further description: \\
37 Type: Variable name as main identifyer \\
38 SideA/C and ChargePlus/Minus: Further type specifications $ \rightarrow $ Side and particle type \\
39 StatisicType: Statisctics and fit properties \\
40 Err: Indicates that this is an error of another variable with the same name \\
41
42 \item IROC vs OROC: Differentiate variables which are different for IRCO's and OROC's by: \_ IROC\_ or \_OROC \_
43
44\end{itemize}
45
46\subsection{Special variables}
47
48To avoid confusions between similar short cuts for variables please respect the following capital and small letters!!!
49
50\begin{itemize}
51
52\item velocity vs voltage
53
54v = velocity (small) \\
55V = voltage (capital)
56
57\item time vs temperature
58
59t = time (small)\\
60T = temperature (capital)
61
62\item momentum vs pressure
63
64p = momentum (small) \\
65P = pressure (capital)
66
67\end{itemize}
68
69
70\subsection{Statistic vs Gau\ss{} fit variables}
71
72Please use the prefix 'Stat' or 'Fit' to diffenrentiate between statistic and Gau\ss{} fit variables: \\ \setlength{\parskip}{1pt}
73
74StatMean --- FitMean \\
75\hspace*{0.5cm} StatRMS --- FitSigma
76
77\subsection{Examples}
78
79The following examples should illustrate the naming convention and help you to implement it.
80
81\subsubsection{QA tree}
82\begin{tabular}{l l}
83%\hline
84Old & New \\
85\hline
86 & \\
87%\hline
88meanTPCnclF & TPCnclF\_ StatMean \\
89%\hline
90slopeATPCnclF & TPCnclF\_ SideA\_ FitSlope\\
91%\hline
92SlopeATPCnclFErr & TPCnclF\_ SideA\_ FitSlope\_ Err\\
93%\hline
94SlopedZAErrPos & dZ\_ SideA\_ ChargePlus\_ FitSlope\_ Err\\
95%\hline
96\end{tabular}
97
98\subsubsection{OCDB tree}
99\begin{tabular}{ l l}
100%\hline
101Old & New \\
102\hline
103 & \\
104%\hline
105VIROC & V\_ IROC\\
106%\hline
107medianVIROC & V\_ IROC\_ StatMedian \\
108%\hline
109rocGainIROC & rocGain\_ IROC \\
110%\hline
111rocGAinERRIROC & rocGain\_ IROC\_ Err\\
112%\hline
113\end{tabular}
114
115%
116% Old ------------------ New
117%
118% meanTPCnclF ------------------ TPCnclF_StatMean
119% slopeATPCnclF ------------------ TPCnclF_SideA_FitSlope
120% SlopeATPCnclFErr ------------------ TPCnclF_SideA_FitSlope_Err
121% SlopedZAErrPos ------------------ dZ_SideA_ChargePlus_FitSlope_Err
122%
123%4.2) OCDB tree
124%
125% Old ------------------ New
126%
127% VIROC ------------------ V_IROC
128% medianVIROC ------------------ V_IROC_StatMedian
129% rocGainIROC ------------------ rocGain_IROC
130% rocGAinERRIROC ------------------ rocGain_IROC_Err
131
132\section{QA WEB directory}
133
134The generic path, where everything goes, has to follow this convention: \\
135\parindent0pt
136
137\framebox{PATH=\${prefix}/\${datatype}/\${year}/\${period}/\${recopass}/\${suffix}} \\
138
139\begin{itemize}
140
141\item with prefix according to the website of the respective institute and detector
142\item e.g. at GSI:
143
144\subitem Official: prefix $=$ http://www-alice.gsi.de/TPC/PWG1train \\
145\subitem Development: prefix $=$ http://web-docs.gsi.de/{\raise.17ex\hbox{$\scriptstyle\mathtt{\sim}$}}username/TPC/PWG1train \\
146
147\item datatype: datatype $=$ data or datatype $=$ sim (nothing like data\_year anymore!) \\
148\item suffix: StandardQA or ExpertQA or CalibrationQA or ExpertCalibrationQA \\
149
150\end{itemize}
151
152\underline{Also to be used by all detectors which will merge trending trees with the TPC}
153\begin{itemize}
154\item rootfiles with the trees should have a static name, e.g. trending.root, TRDtree.root, ...
155
156\end{itemize}
157
f7619063 158\end{document}