Merge lp:~ma5dev/madanalysis5/pyhf_update into lp:~ma5dev/madanalysis5/v1.9_beta

[Jack Y. Araz]

remove autocomplete for currently unused variables

[lp:~ma5dev/madanalysis5/pyhf_update]

189. By Jack Y. Araz on 2021-11-12

add d0 dz approx to obs list

190. By Jack Y. Araz on 2021-11-13

expand docs and fix autocomplete for energy scaling

=== modified file 'doc/expert_mode/main_expert.tex'
--- doc/expert_mode/main_expert.tex	2020-07-02 06:49:41 +0000
+++ doc/expert_mode/main_expert.tex	2021-11-13 13:44:51 +0000
@@ -7,6 +7,13 @@
 \usepackage{url,slashed,multirow,cite,verbdef}
 \usepackage{hyperref}
 
+\hypersetup{bookmarks=true,unicode=true,pdftoolbar=false,pdfmenubar=true,
+	pdffitwindow=false,pdfstartview={FitH},pdftitle={MA5 Expert Mode Reference Card},
+	pdfauthor={J.~Araz, E.~Conte, B.~Fuks}, pdfsubject={MA5 Normal Reference Card},
+	pdfcreator={J.~Araz, E.~Conte, B.~Fuks},pdfproducer={PDFLaTeX}, pdfkeywords={MA5expert-mode},
+	pdfnewwindow=true,colorlinks=true,
+	linkcolor=blue,citecolor=magenta,filecolor=magenta,urlcolor=cyan}
+
 %% Sets page size and margins
 \usepackage[a4paper,top=3cm,bottom=2cm,left=3cm,right=3cm,marginparwidth=1.75cm]{geometry}
 
@@ -369,7 +376,10 @@
 \color{ao}\verb+const MAfloat32 pz() const+  & $z$-component of the momentum.\\
 \color{ao}\verb+const MAfloat32 r() const+   & Position in the $\eta-\phi$ plane.\\
 \color{ao}\verb+const MAfloat32 theta() const+  & Polar angle.\\
-\color{ao}\verb+const MAfloat32 y() const+ & Rapidity.\\
+\color{ao}\verb+const MAdouble64 d0() const+ & Transverse impact parameter.\\
+\color{ao}\verb+const MAdouble64 dz() const+ & Longitudinal impact parameter.\\
+\color{ao}\verb+const MAdouble64 d0_approx() const+ & Transverse impact parameter with straight line approximation.\\
+\color{ao}\verb+const MAdouble64 dz_approx() const+ & Longitudinal impact parameter with straight line approximation.\\
 \hline
 \end{tabular}
 \end{center}
@@ -456,18 +466,18 @@
 \multicolumn{2}{l}{\color{ao}\expccb}\\  & Reconstructed electrons.\\
 \multicolumn{2}{l}{\color{ao}\expccc}\\  & Reconstructed muons.\\
 \multicolumn{2}{l}{\color{ao}\expccd}\\  & Reconstructed hadronic taus.\\
-\multicolumn{2}{l}{\color{ao}\expcce}\\  & Reconstructed fat jets.\\
+\multicolumn{2}{l}{\color{ao}\expcce}\\  & Reconstructed fat jets.(Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expccf}\\  & Reconstructed jets.\\
-\multicolumn{2}{l}{\color{ao}\expccg}\\  & Parton-level jets.\\
+\multicolumn{2}{l}{\color{ao}\expccg}\\  & Parton-level jets. (Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expcch}\\  & Tracks left in a detector.\\
 \multicolumn{2}{l}{\color{ao}\expcch}\\  & Vertices left in a detector.\\
-\multicolumn{2}{l}{\color{ao}\expcci}\\  & Calorimetric deposits left in a detector.\\
+\multicolumn{2}{l}{\color{ao}\expcci}\\  & Calorimetric deposits left in a detector. (Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expccj}\\  & Tracks left in a detector, reconstructed from
-  the particle flow information.\\
+  the particle flow information. (Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expcck}\\  & Photons, reconstructed from the particle flow
-  information.\\
+  information.(Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expccl}\\  & Neutral hadrons, reconstructed from the
-  particle flow information.\\
+  particle flow information.(Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expccm}\\  & Missing transverse energy.\\
 \multicolumn{2}{l}{\color{ao}\expccn}\\  & Missing hadronic energy.\\
 \multicolumn{2}{l}{\color{ao}\expcco}\\  & Visible transverse energy.\\
@@ -515,9 +525,9 @@
 \begin{center}\begin{tabular}{p{2.7cm} p{9.0cm}}
 \hline
 \multicolumn{2}{l}{\color{ao}\expddb}\\  & Ratio of the electromagnetic to
-  hadronic calorimetric energy associated with the object.\\
+  hadronic calorimetric energy associated with the object.(Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expdda}\\  & Ratio of the hadronic to
-  electromagnetic calorimetric energy associated with the object.\\
+  electromagnetic calorimetric energy associated with the object.(Only with Delphes)\\
 \multicolumn{2}{l}{\color{ao}\expddn}\\  & Identifier of the decay mode of a
   \verb+RecTauFormat+ object. The available choices are 1 ($\tau\to e \nu \nu$),
   2 ($\tau \to \mu \nu \nu$),  3 ($\tau \to K \nu$), 4 ($\tau \to K^* \nu$),

=== modified file 'doc/normal_mode/main_normal.tex'
--- doc/normal_mode/main_normal.tex	2021-10-25 15:09:10 +0000
+++ doc/normal_mode/main_normal.tex	2021-11-13 13:44:51 +0000
@@ -367,6 +367,13 @@
 \color{ao} \verb?PZ?     & $z$-component of the momentum.\\
 \color{ao} \verb?R?      & Position in the $(\eta, \phi)$ plane.\\
 \color{ao} \verb?Y?      & Rapidity.\\
+\color{ao} \verb?D0?      & Transverse impact parameter.\\
+\color{ao} \verb?DZ?      & Longitudinal impact parameter.\\
+\color{ao} \verb?D0APPROX?      & Transverse impact parameter with straight line trajectory.\\
+\color{ao} \verb?DZAPPROX?      & Longitudinal impact parameter with straight line trajectory.\\
+\color{ao} \verb?XD?      & $ x $-axis of the closest approach.\\
+\color{ao} \verb?YD?      & $ y $-axis of the closest approach.\\
+\color{ao} \verb?ZD?      & $ z $-axis of the closest approach.\\
 \hline
 \end{tabular}
 \end{center}
@@ -688,7 +695,7 @@
 process identifier, and the second one setting up the maximum number of extra
 jets to consider.
 
-\vspace{2cm}
+\vspace{.8cm}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \begin{shaded}
 	\section{\Large Simplified-fast detector simulation with \MAnorm}
@@ -746,7 +753,9 @@
   \color{ao} \verb?tagger?   & Generates a probability distribution relying on a
     user-defined piecewise function describing the probabily to (mis)tag an
     object. \\
-  \hline
+  \color{ao} \verb?jes?   & Generates a function to scale reconstructed jet energy. \\
+  \color{ao} \verb?energy_scaling?   & Generates a function to scale reconstructed object energy. \\
+    \hline
  \end{tabular}
 \end{center}
 \noindent The syntax to be employed to make use of the \verb+reco_efficiency+
@@ -830,7 +839,21 @@
   \hline
  \end{tabular}
 \end{center}
-\vspace{3cm}
+
+\noindent The \verb+jes+ submodule can be used following the syntax
+{\color{ao} \begin{verbatim}
+		define jes <function> [<domain>]
+\end{verbatim}}
+Define the Jet Energy Scale (JES) corrections to apply to clustered jets. The corresponding JES function is given by {\tt <function>}. The bounds correspond to the domain that JES applies ({\tt PT > ..., ETA < ...,} etc.).
+
+\noindent The \verb+energy_scaling+ submodule can be used following the syntax
+{\color{ao} \begin{verbatim}
+		define energy_scaling <p1> <function> [<domain>]
+\end{verbatim}}
+Define the rescaling corrections to apply to the energy of a reconstructed object {\tt <p1>}.
+The corresponding energy scaling function is given by {\tt <function>}.
+The bounds correspond to the domain that scaling function applies ({\tt PT > ..., ETA < ...}, etc.).
+%\vspace{3cm}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \begin{shaded}
 \section{\Large Recasting LHC analyses with \MA}

=== modified file 'madanalysis/configuration/clustering_configuration.py'
--- madanalysis/configuration/clustering_configuration.py	2021-09-15 14:19:55 +0000
+++ madanalysis/configuration/clustering_configuration.py	2021-11-13 13:44:51 +0000
@@ -46,8 +46,8 @@
                       "exclusive_id"            : ["true","false"],
                       "jetrecomode"             : ["jets","constituents"],
                       "magneticfield"           : ["3.8"],
-                      "tracker_radius"          : ["1.29"],
-                      "half_length"             : ["3.0"],
+                      # "tracker_radius"          : ["1.29"],
+                      # "half_length"             : ["3.0"],
                       "particle_propagator"     : ["on","off"],
                       "track_isocone_radius"    : ["0.5"],
                       "electron_isocone_radius" : ["0.5"],

=== modified file 'madanalysis/interpreter/cmd_define.py'
--- madanalysis/interpreter/cmd_define.py	2020-12-10 22:10:48 +0000
+++ madanalysis/interpreter/cmd_define.py	2021-11-13 13:44:51 +0000
@@ -150,7 +150,7 @@
             nargs += 1
 
         if nargs==2:
-            output=['tagger', 'smearer', 'reco_efficiency']
+            output=['tagger', 'smearer', 'reco_efficiency', "jes", "energy_scaling"]
             return self.finalize_complete(text,output)
 
         elif nargs==3 or (nargs==5 and args[1] == 'tagger'):

=== modified file 'madanalysis/observable/observable_list.py'
--- madanalysis/observable/observable_list.py	2021-07-15 14:42:44 +0000
+++ madanalysis/observable/observable_list.py	2021-11-13 13:44:51 +0000
@@ -890,6 +890,28 @@
 dD0  = dvD0 = vdD0 = ObservableBase.Clone(D0, name='dD0', combination=CombinationType.DIFFVECTOR, tlatex='dd_{0}', latex='$dd_{0}$')
 rD0  = ObservableBase.Clone(D0, name='rD0', combination=CombinationType.RATIO, tlatex='rd_{0}', latex='$rd_{0}$')
 
+D0APPROX = ObservableBase(  name          = 'D0APPROX',
+                            args          = [ArgumentType.COMBINATION],
+                            combination   = CombinationType.DEFAULT,
+                            plot_auto     = False,
+                            plot_nbins    = 100,
+                            plot_xmin     = -20.,
+                            plot_xmax     = 20.,
+                            plot_unitX_tlatex    = 'mm',
+                            plot_unitX_latex    = 'mm',
+                            code_parton   = 'd0_approx()',
+                            code_hadron   = 'd0_approx()',
+                            code_reco     = 'd0_approx()',
+                            cut_event     = True,
+                            cut_candidate = True,
+                            tlatex        = '#d_{0}^{approx.}',
+                            latex         = '$d_0^{\\rm approx.}$')
+vD0APPROX  = D0APPROX
+sD0APPROX  = ObservableBase.Clone(D0APPROX, name='sD0APPROX', combination=CombinationType.SUMSCALAR, tlatex='sd_{0}^{approx.}', latex='$sd_{0}^{\\rm approx.}$')
+sdD0APPROX = dsD0APPROX = ObservableBase.Clone(D0APPROX, name='sdD0APPROX', combination=CombinationType.DIFFSCALAR, tlatex='sdd_{0}^{approx.}', latex='$sdd_{0}^{\\rm approx.}$')
+dD0APPROX  = dvD0APPROX = vdD0APPROX = ObservableBase.Clone(D0APPROX, name='dD0APPROX', combination=CombinationType.DIFFVECTOR, tlatex='dd_{0}^{approx.}', latex='$dd_{0}^{\\rm approx.}$')
+rD0APPROX  = ObservableBase.Clone(D0APPROX, name='rD0APPROX', combination=CombinationType.RATIO, tlatex='rd_{0}^{approx.}', latex='$rd_{0}^{\\rm approx.}$')
+
 DZ = ObservableBase(  name          = 'DZ',
                       args          = [ArgumentType.COMBINATION],
                       combination   = CombinationType.DEFAULT,
@@ -913,6 +935,32 @@
 dDZ  = dvDZ = vdDZ = ObservableBase.Clone(DZ, name='dDZ', combination=CombinationType.DIFFVECTOR, tlatex='dd_{z}', latex='$dd_{z}$')
 rDZ  = ObservableBase.Clone(DZ, name='rDZ', combination=CombinationType.RATIO, tlatex='rd_{z}', latex='$rd_{z}$')
 
+
+DZAPPROX = ObservableBase(  name          = 'DZAPPROX',
+                      args          = [ArgumentType.COMBINATION],
+                      combination   = CombinationType.DEFAULT,
+                      plot_auto     = False,
+                      plot_nbins    = 100,
+                      plot_xmin     = -20.,
+                      plot_xmax     = 20.,
+                      plot_unitX_tlatex    = 'mm',
+                      plot_unitX_latex    = 'mm',
+                      code_parton   = 'dz_approx()',
+                      code_hadron   = 'dz_approx()',
+                      code_reco     = 'dz_approx()',
+                      cut_event     = True,
+                      cut_candidate = True,
+                      tlatex        = '#d_{z}^{approx.}',
+                      latex         = '$d_z^{\\rm approx.}$'
+                      )
+vDZAPPROX  = DZAPPROX
+sDZAPPROX  = ObservableBase.Clone(DZAPPROX, name='sDZAPPROX', combination=CombinationType.SUMSCALAR, tlatex='sd_{z}^{approx.}', latex='$sd_{z}^{\\rm approx.}$')
+sdDZAPPROX = dsDZAPPROX = ObservableBase.Clone(DZAPPROX, name='sdDZAPPROX', combination=CombinationType.DIFFSCALAR, tlatex='sdd_{z}^{approx.}', latex='$sdd_{z}^{\\rm approx.}$')
+dDZAPPROX  = dvDZAPPROX = vdDZAPPROX = ObservableBase.Clone(DZAPPROX, name='dDZAPPROX', combination=CombinationType.DIFFVECTOR, tlatex='dd_{z}^{approx.}', latex='$dd_{z}^{\\rm approx.}$')
+rDZAPPROX  = ObservableBase.Clone(DZAPPROX, name='rDZAPPROX', combination=CombinationType.RATIO, tlatex='rd_{z}^{approx.}', latex='$rd_{z}^{\\rm approx.}$')
+
+
+
 XD = ObservableBase( name          = 'XD',
                      args          = [ArgumentType.COMBINATION],
                      combination   = CombinationType.SUMVECTOR,