TPC/doc/Definitions/naming_convention.tex

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