\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance}{\subsection{vertex\-\_\-lcfi\-:\-:Vertex\-Decay\-Significance Class Reference}
\label{classvertex__lcfi_1_1VertexDecaySignificance}\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
}


Calculation of Decay Significance.  




{\ttfamily \#include $<$decaysignificance.\-h$>$}



Inheritance diagram for vertex\-\_\-lcfi\-:\-:Vertex\-Decay\-Significance\-:


Collaboration diagram for vertex\-\_\-lcfi\-:\-:Vertex\-Decay\-Significance\-:
\subsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
string \hyperlink{classvertex__lcfi_1_1VertexDecaySignificance_a537d9d571bc16251ffa1d7d3bdfc33e0}{name} () const 
\begin{DoxyCompactList}\small\item\em Name. \end{DoxyCompactList}\item 
std\-::vector$<$ string $>$ \hyperlink{classvertex__lcfi_1_1VertexDecaySignificance_ade82718dbd8e59014f15f0fe7fde5c30}{parameter\-Names} () const 
\begin{DoxyCompactList}\small\item\em Parameter Names. \end{DoxyCompactList}\item 
std\-::vector$<$ string $>$ \hyperlink{classvertex__lcfi_1_1VertexDecaySignificance_a8d8d7258bb1b6b672ee41361f4ebfa93}{parameter\-Values} () const 
\begin{DoxyCompactList}\small\item\em Parameter Values. \end{DoxyCompactList}\item 
void \hyperlink{classvertex__lcfi_1_1VertexDecaySignificance_a4699eeec7ae8f0ffea0ff04632d7f30a}{set\-String\-Parameter} (const string \&Parameter, const string \&Value)
\begin{DoxyCompactList}\small\item\em Set String Parameter. \end{DoxyCompactList}\item 
void \hyperlink{classvertex__lcfi_1_1VertexDecaySignificance_a2db7fd11a76b41a913e63306aff39f15}{set\-Double\-Parameter} (const string \&Parameter, const double Value)
\begin{DoxyCompactList}\small\item\em Set Double Parameter. \end{DoxyCompactList}\item 
void \hyperlink{classvertex__lcfi_1_1VertexDecaySignificance_a9d7942913e7547e5d610eb55f058d20a}{set\-Pointer\-Parameter} (const string \&Parameter, void $\ast$Value)
\begin{DoxyCompactList}\small\item\em Set Pointer Parameter. \end{DoxyCompactList}\item 
std\-::map\\*
$<$ Decay\-Significance\-Type, \\*
double $>$ \hyperlink{classvertex__lcfi_1_1VertexDecaySignificance_a9cccbbb9df01ba7aa0aa32fadd6b8cf0}{calculate\-For} (\hyperlink{classvertex__lcfi_1_1DecayChain}{Decay\-Chain} $\ast$My\-Decay\-Chain) const 
\begin{DoxyCompactList}\small\item\em Run the algorithm on a \hyperlink{classvertex__lcfi_1_1Jet}{Jet}. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsubsection{Detailed Description}
Calculation of Decay Significance. 

Jet flavour tagging parameter algorithm that calculates the most significant decay length between vertices present in the inputted \hyperlink{classvertex__lcfi_1_1DecayChain}{Decay\-Chain}. The algorithm calculates the distance between all consecutive vertices (i.\-e. with respect to the previous \hyperlink{classvertex__lcfi_1_1Vertex}{Vertex}) in the \hyperlink{classvertex__lcfi_1_1Jet}{Jet} and the error of the distance. The significance is defined as the distance divided by the error. The algorithm then outputs the significance and the length of the most significant decay length. The class does not have any input parameters. \begin{DoxyAuthor}{Author}
Erik Devetak (\href{mailto:e.devetak1@physics.ox.ac.uk}{\tt e.\-devetak1@physics.\-ox.\-ac.\-uk}) 
\end{DoxyAuthor}


\subsubsection{Member Function Documentation}
\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance_a9cccbbb9df01ba7aa0aa32fadd6b8cf0}{\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}!calculate\-For@{calculate\-For}}
\index{calculate\-For@{calculate\-For}!vertex_lcfi::VertexDecaySignificance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
\paragraph[{calculate\-For}]{\setlength{\rightskip}{0pt plus 5cm}std\-::map$<$Decay\-Significance\-Type, double$>$ vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance\-::calculate\-For (
\begin{DoxyParamCaption}
\item[{{\bf Decay\-Chain} $\ast$}]{My\-Decay\-Chain}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{classvertex__lcfi_1_1VertexDecaySignificance_a9cccbbb9df01ba7aa0aa32fadd6b8cf0}


Run the algorithm on a \hyperlink{classvertex__lcfi_1_1Jet}{Jet}. 

Calculate the most significant decay length of the decay chain 
\begin{DoxyParams}{Parameters}
{\em \hyperlink{classvertex__lcfi_1_1Jet}{Jet}} & Pointer to the \hyperlink{classvertex__lcfi_1_1DecayChain}{Decay\-Chain} to be analysed \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
map containing the following keys\-: \char`\"{}\-Significance\char`\"{}, \char`\"{}\-Distance\char`\"{} 
\end{DoxyReturn}


Implements \hyperlink{classvertex__lcfi_1_1Algo_a95a0f611f2ab925663b6f819b7d0f8c8}{vertex\-\_\-lcfi\-::\-Algo$<$ Decay\-Chain $\ast$, std\-::map$<$ Decay\-Significance\-Type, double $>$ $>$}.

\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance_a537d9d571bc16251ffa1d7d3bdfc33e0}{\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}!name@{name}}
\index{name@{name}!vertex_lcfi::VertexDecaySignificance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
\paragraph[{name}]{\setlength{\rightskip}{0pt plus 5cm}string vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance\-::name (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{classvertex__lcfi_1_1VertexDecaySignificance_a537d9d571bc16251ffa1d7d3bdfc33e0}


Name. 

String name of the algorithm \begin{DoxyReturn}{Returns}
String name 
\end{DoxyReturn}


Implements \hyperlink{classvertex__lcfi_1_1Algo_a8dc63ee2a511bf2809979a862167d0d6}{vertex\-\_\-lcfi\-::\-Algo$<$ Decay\-Chain $\ast$, std\-::map$<$ Decay\-Significance\-Type, double $>$ $>$}.

\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance_ade82718dbd8e59014f15f0fe7fde5c30}{\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}!parameter\-Names@{parameter\-Names}}
\index{parameter\-Names@{parameter\-Names}!vertex_lcfi::VertexDecaySignificance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
\paragraph[{parameter\-Names}]{\setlength{\rightskip}{0pt plus 5cm}std\-::vector$<$string$>$ vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance\-::parameter\-Names (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{classvertex__lcfi_1_1VertexDecaySignificance_ade82718dbd8e59014f15f0fe7fde5c30}


Parameter Names. 

A vector of the names of the algorithms parameters \begin{DoxyReturn}{Returns}
vector of string names 
\end{DoxyReturn}


Implements \hyperlink{classvertex__lcfi_1_1Algo_ac5a83cb4625455de40bec9ab8f718c48}{vertex\-\_\-lcfi\-::\-Algo$<$ Decay\-Chain $\ast$, std\-::map$<$ Decay\-Significance\-Type, double $>$ $>$}.

\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance_a8d8d7258bb1b6b672ee41361f4ebfa93}{\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}!parameter\-Values@{parameter\-Values}}
\index{parameter\-Values@{parameter\-Values}!vertex_lcfi::VertexDecaySignificance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
\paragraph[{parameter\-Values}]{\setlength{\rightskip}{0pt plus 5cm}std\-::vector$<$string$>$ vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance\-::parameter\-Values (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{classvertex__lcfi_1_1VertexDecaySignificance_a8d8d7258bb1b6b672ee41361f4ebfa93}


Parameter Values. 

A vector of the values of the algorithms parameters, in the same order as parameter names \begin{DoxyReturn}{Returns}
vector of string values 
\end{DoxyReturn}


Implements \hyperlink{classvertex__lcfi_1_1Algo_a6248170b83886bf51a922b78ce629a71}{vertex\-\_\-lcfi\-::\-Algo$<$ Decay\-Chain $\ast$, std\-::map$<$ Decay\-Significance\-Type, double $>$ $>$}.

\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance_a2db7fd11a76b41a913e63306aff39f15}{\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}!set\-Double\-Parameter@{set\-Double\-Parameter}}
\index{set\-Double\-Parameter@{set\-Double\-Parameter}!vertex_lcfi::VertexDecaySignificance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
\paragraph[{set\-Double\-Parameter}]{\setlength{\rightskip}{0pt plus 5cm}void vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance\-::set\-Double\-Parameter (
\begin{DoxyParamCaption}
\item[{const string \&}]{Parameter, }
\item[{const double}]{Value}
\end{DoxyParamCaption}
)}}\label{classvertex__lcfi_1_1VertexDecaySignificance_a2db7fd11a76b41a913e63306aff39f15}


Set Double Parameter. 

Set a double parameter 
\begin{DoxyParams}{Parameters}
{\em Parameter} & String of parameter name \\
\hline
{\em Value} & double of parameter value \\
\hline
\end{DoxyParams}
\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance_a9d7942913e7547e5d610eb55f058d20a}{\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}!set\-Pointer\-Parameter@{set\-Pointer\-Parameter}}
\index{set\-Pointer\-Parameter@{set\-Pointer\-Parameter}!vertex_lcfi::VertexDecaySignificance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
\paragraph[{set\-Pointer\-Parameter}]{\setlength{\rightskip}{0pt plus 5cm}void vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance\-::set\-Pointer\-Parameter (
\begin{DoxyParamCaption}
\item[{const string \&}]{Parameter, }
\item[{void $\ast$}]{Value}
\end{DoxyParamCaption}
)}}\label{classvertex__lcfi_1_1VertexDecaySignificance_a9d7942913e7547e5d610eb55f058d20a}


Set Pointer Parameter. 

Set a pointer parameter 
\begin{DoxyParams}{Parameters}
{\em Parameter} & String of parameter name \\
\hline
{\em Value} & pointer to void \\
\hline
\end{DoxyParams}
\hypertarget{classvertex__lcfi_1_1VertexDecaySignificance_a4699eeec7ae8f0ffea0ff04632d7f30a}{\index{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}!set\-String\-Parameter@{set\-String\-Parameter}}
\index{set\-String\-Parameter@{set\-String\-Parameter}!vertex_lcfi::VertexDecaySignificance@{vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance}}
\paragraph[{set\-String\-Parameter}]{\setlength{\rightskip}{0pt plus 5cm}void vertex\-\_\-lcfi\-::\-Vertex\-Decay\-Significance\-::set\-String\-Parameter (
\begin{DoxyParamCaption}
\item[{const string \&}]{Parameter, }
\item[{const string \&}]{Value}
\end{DoxyParamCaption}
)}}\label{classvertex__lcfi_1_1VertexDecaySignificance_a4699eeec7ae8f0ffea0ff04632d7f30a}


Set String Parameter. 

Set a string parameter 
\begin{DoxyParams}{Parameters}
{\em Parameter} & String of parameter name \\
\hline
{\em Value} & String of parameter value \\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
decaysignificance.\-h\end{DoxyCompactItemize}
