Update naming convention
authormivanov <mivanov@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 15 May 2013 13:41:43 +0000 (13:41 +0000)
committermivanov <mivanov@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 15 May 2013 13:41:43 +0000 (13:41 +0000)
Nmaing convention for the directory structure added
(Nicole, patrick)

TPC/doc/Definitions/naming_convention.pdf
TPC/doc/Definitions/naming_convention.tex

index 947e60d..47647a2 100644 (file)
Binary files a/TPC/doc/Definitions/naming_convention.pdf and b/TPC/doc/Definitions/naming_convention.pdf differ
index bf7e96b..2775d1d 100644 (file)
-\documentclass[11pt,a4paper]{article}
-\usepackage[latin1]{inputenc}
-\usepackage[english]{babel}
-\usepackage{amsmath}
-\usepackage{amsfonts}
-\usepackage{amssymb}
-\usepackage{hyperref}
-\usepackage[a4paper, left=1.5cm, right=1cm, top=2cm]{geometry}
-%\author{Marian Ivano, Nicole Martin and Jens Wiechula}
-%\title{Naming conventions for trending variables}
-\begin{document}
-\title{Naming conventions for trending variables}
-\author{Marian Ivano, Nicole Martin and Jens Wiechula}
-\maketitle
-
-This file explains the definition of the naming convention for trending variables. You can also find a presentation explaining the naming conventions here:  
-\url{https://indico.cern.ch/getFile.py/access?contribId=4&resId=0&materialId=slides&confId=171449}
-\section{General}
-
-\begin{itemize}
-
-\item Seperate `properties' by a `\_' : \\ \setlength{\parskip}{1pt} 
-
-Variable name as main identifyer \hspace*{3cm} Statisctics and fit propertie  \\ 
-\hspace*{0.3cm} $ \downarrow $ \hspace*{10cm} $ \downarrow $ 
-
- \small{Type\_ SideA/C\_ ChargePlus/Minus\_ StatisicType(StatMean/StatRMS/StatChi2/FitSlope/FitMean/FitSigma)\_ Err} \\ 
- \hspace*{1.5cm} $ \uparrow $\hspace*{2cm} $ \uparrow $ \hspace*{13.1cm} $ \uparrow $ \\
- \hspace*{1cm} Further type specifications \hspace*{10cm} Error of an-\hspace*{15.5cm} other variable
-\item Further description: \\
-     Type: Variable name as main identifyer \\
-     SideA/C and ChargePlus/Minus: Further type specifications $ \rightarrow $ Side and particle type \\
-     StatisicType: Statisctics and fit properties \\
-     Err: Indicates that this is an error of another variable with the same name \\
-      
- \item IROC vs OROC: Differentiate variables which are different for IRCO's and OROC's by: \_ IROC\_ or \_OROC \_
-
-\end{itemize}
-
-\section{Special variables}
-
-To avoid confusions between similar short cuts for variables please respect the following capital and small letters!!!
-
-\begin{itemize}
-\item velocity vs voltage 
-
-v = velocity (small) \\
-V = voltage  (capital)
-
-\item time vs temperature
-
-t = time        (small)\\
-T = temperature (capital)
-
-\item momentum vs pressure
-
-p = momentum (small) \\
-P = pressure (capital)
-
-\end{itemize}
-
-
-\section{Statistic vs Gau\ss{} fit variables}
-
-Please use the prefix 'Stat' or 'Fit' to diffenrentiate between statistic and Gau\ss{} fit variables: \\ \setlength{\parskip}{1pt}
-   
-StatMean --- FitMean \\
-\hspace*{0.5cm} StatRMS  --- FitSigma
-
-\section{Examples}
-
-The following examples should illustrate the naming convention and help you to implement it.
-
-\subsection{QA tree}
-\begin{tabular}{l l}
-%\hline 
-Old & New \\ 
-\hline 
- &  \\
-%\hline 
-meanTPCnclF & TPCnclF\_ StatMean \\ 
-%\hline 
-slopeATPCnclF &  TPCnclF\_ SideA\_ FitSlope\\ 
-%\hline 
-SlopeATPCnclFErr &  TPCnclF\_ SideA\_ FitSlope\_ Err\\ 
-%\hline 
-SlopedZAErrPos &  dZ\_ SideA\_ ChargePlus\_ FitSlope\_ Err\\ 
-%\hline 
-\end{tabular} 
-
-\subsection{OCDB tree}
-\begin{tabular}{ l l}
-%\hline 
-Old & New \\ 
-\hline 
- &  \\ 
-%\hline 
-VIROC &  V\_ IROC\\ 
-%\hline 
-medianVIROC & V\_ IROC\_ StatMedian \\ 
-%\hline 
-rocGainIROC & rocGain\_ IROC \\ 
-%\hline 
-rocGAinERRIROC &  rocGain\_ IROC\_ Err\\ 
-%\hline 
-\end{tabular} 
-
-%
-%     Old              ------------------ New
-%     
-%     meanTPCnclF      ------------------ TPCnclF_StatMean
-%     slopeATPCnclF    ------------------ TPCnclF_SideA_FitSlope   
-%     SlopeATPCnclFErr ------------------ TPCnclF_SideA_FitSlope_Err
-%     SlopedZAErrPos   ------------------ dZ_SideA_ChargePlus_FitSlope_Err
-%
-%4.2) OCDB tree
-%
-%     Old              ------------------ New
-%     
-%     VIROC            ------------------ V_IROC
-%     medianVIROC      ------------------ V_IROC_StatMedian
-%     rocGainIROC      ------------------ rocGain_IROC
-%     rocGAinERRIROC   ------------------ rocGain_IROC_Err
-
+\documentclass[11pt,a4paper]{article}\r
+\usepackage[latin1]{inputenc}\r
+\usepackage[english]{babel}\r
+\usepackage{amsmath}\r
+\usepackage{amsfonts}\r
+\usepackage{amssymb}\r
+\usepackage{hyperref}\r
+\usepackage[a4paper, left=1.5cm, right=1cm, top=2cm]{geometry}\r
+%\author{Marian Ivano, Nicole Martin, Patrick Reichelt and Jens Wiechula}\r
+%\title{Naming conventions for trending variables and QA WEB directory}\r
+\begin{document}\r
+\title{Naming conventions for trending variables and QA WEB directory}\r
+\author{Marian Ivano, Nicole Martin, Patrick Riechelt and Jens Wiechula}\r
+\maketitle\r
+\r
+This 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:  \r
+\url{https://indico.cern.ch/getFile.py/access?contribId=4&resId=0&materialId=slides&confId=171449} . \r
+As well as a presentation explaining the naming conventions for the QA WEB directory here:\r
+\url{https://indico.cern.ch/getFile.py/access?contribId=3&resId=0&materialId=slides&confId=235865}.\r
+\r
+\section{Trending variables}\r
+\r
+\subsection{General}\r
+\r
+\begin{itemize}\r
+\r
+\item Seperate `properties' by a `\_' : \\ \setlength{\parskip}{1pt} \r
+\r
+Variable name as main identifyer \hspace*{3cm} Statisctics and fit propertie  \\ \r
+\hspace*{0.3cm} $ \downarrow $ \hspace*{10cm} $ \downarrow $ \r
+\r
+ \small{Type\_ SideA/C\_ ChargePlus/Minus\_ StatisicType(StatMean/StatRMS/StatChi2/FitSlope/FitMean/FitSigma)\_ Err} \\ \r
+ \hspace*{1.5cm} $ \uparrow $\hspace*{2cm} $ \uparrow $ \hspace*{13.1cm} $ \uparrow $ \\\r
+ \hspace*{1cm} Further type specifications \hspace*{10cm} Error of an-\hspace*{15.5cm} other variable\r
\r
+\item Further description: \\\r
+     Type: Variable name as main identifyer \\\r
+     SideA/C and ChargePlus/Minus: Further type specifications $ \rightarrow $ Side and particle type \\\r
+     StatisicType: Statisctics and fit properties \\\r
+     Err: Indicates that this is an error of another variable with the same name \\\r
+      \r
+ \item IROC vs OROC: Differentiate variables which are different for IRCO's and OROC's by: \_ IROC\_ or \_OROC \_\r
+\r
+\end{itemize}\r
+\r
+\subsection{Special variables}\r
+\r
+To avoid confusions between similar short cuts for variables please respect the following capital and small letters!!!\r
+\r
+\begin{itemize}\r
\r
+\item velocity vs voltage \r
+\r
+v = velocity (small) \\\r
+V = voltage  (capital)\r
+\r
+\item time vs temperature\r
+\r
+t = time        (small)\\\r
+T = temperature (capital)\r
+\r
+\item momentum vs pressure\r
+\r
+p = momentum (small) \\\r
+P = pressure (capital)\r
+\r
+\end{itemize}\r
+\r
+\r
+\subsection{Statistic vs Gau\ss{} fit variables}\r
+\r
+Please use the prefix 'Stat' or 'Fit' to diffenrentiate between statistic and Gau\ss{} fit variables: \\ \setlength{\parskip}{1pt}\r
+   \r
+StatMean --- FitMean \\\r
+\hspace*{0.5cm} StatRMS  --- FitSigma\r
+\r
+\subsection{Examples}\r
+\r
+The following examples should illustrate the naming convention and help you to implement it.\r
+\r
+\subsubsection{QA tree}\r
+\begin{tabular}{l l}\r
+%\hline \r
+Old & New \\ \r
+\hline \r
+ &  \\\r
+%\hline \r
+meanTPCnclF & TPCnclF\_ StatMean \\ \r
+%\hline \r
+slopeATPCnclF &  TPCnclF\_ SideA\_ FitSlope\\ \r
+%\hline \r
+SlopeATPCnclFErr &  TPCnclF\_ SideA\_ FitSlope\_ Err\\ \r
+%\hline \r
+SlopedZAErrPos &  dZ\_ SideA\_ ChargePlus\_ FitSlope\_ Err\\ \r
+%\hline \r
+\end{tabular} \r
+\r
+\subsubsection{OCDB tree}\r
+\begin{tabular}{ l l}\r
+%\hline \r
+Old & New \\ \r
+\hline \r
+ &  \\ \r
+%\hline \r
+VIROC &  V\_ IROC\\ \r
+%\hline \r
+medianVIROC & V\_ IROC\_ StatMedian \\ \r
+%\hline \r
+rocGainIROC & rocGain\_ IROC \\ \r
+%\hline \r
+rocGAinERRIROC &  rocGain\_ IROC\_ Err\\ \r
+%\hline \r
+\end{tabular} \r
+\r
+%\r
+%     Old              ------------------ New\r
+%     \r
+%     meanTPCnclF      ------------------ TPCnclF_StatMean\r
+%     slopeATPCnclF    ------------------ TPCnclF_SideA_FitSlope   \r
+%     SlopeATPCnclFErr ------------------ TPCnclF_SideA_FitSlope_Err\r
+%     SlopedZAErrPos   ------------------ dZ_SideA_ChargePlus_FitSlope_Err\r
+%\r
+%4.2) OCDB tree\r
+%\r
+%     Old              ------------------ New\r
+%     \r
+%     VIROC            ------------------ V_IROC\r
+%     medianVIROC      ------------------ V_IROC_StatMedian\r
+%     rocGainIROC      ------------------ rocGain_IROC\r
+%     rocGAinERRIROC   ------------------ rocGain_IROC_Err\r
+\r
+\section{QA WEB directory}\r
+\r
+The generic path, where everything goes, has to follow this convention: \\\r
+\parindent0pt\r
+\r
+\framebox{PATH=\${prefix}/\${datatype}/\${year}/\${period}/\${recopass}/\${suffix}} \\\r
+\r
+\begin{itemize}\r
+\r
+\item with prefix according to the website of the respective institute and detector \r
+\item e.g. at GSI:\r
+\r
+\subitem Official:           prefix $=$ http://www-alice.gsi.de/TPC/PWG1train \\\r
+\subitem Development: prefix $=$ http://web-docs.gsi.de/{\raise.17ex\hbox{$\scriptstyle\mathtt{\sim}$}}username/TPC/PWG1train \\\r
+\r
+\item datatype: datatype $=$ data   or   datatype $=$ sim   (nothing like data\_year anymore!) \\\r
+\item suffix:  StandardQA  or  ExpertQA  or  CalibrationQA  or  ExpertCalibrationQA \\\r
+\r
+\end{itemize}\r
+\r
+\underline{Also to be used by all detectors which will merge trending trees with the TPC}\r
+\begin{itemize}\r
+\item rootfiles with the trees should have a static name, e.g. trending.root, TRDtree.root, ...\r
+\r
+\end{itemize}\r
+\r
 \end{document}
\ No newline at end of file