Analysis Namespace Reference

The namespace of all packages in PhysicsAnalysis/JetTagging. More...

Namespaces
namespace	CalibrationDataInterface

Classes
class	BTagTrackAugmenterAlg
class	BTagTrackAugmenterByVertexAlg
class	CalibrationDataContainer
	This is the interface for the objects to be stored in the calibration ROOT file. More...
class	CalibrationDataEigenVariations
class	CalibrationDataFunctionContainer
	This is the class holding information for function-based calibration results. More...
class	CalibrationDataGlobalEigenVariations
class	CalibrationDataHistogramContainer
	This is the class holding information for histogram-based calibration results. More...
class	CalibrationDataInterfaceBase
	This class provides some common functionality for other classes wishing to access Flavour Tagging performance estimates. More...
class	CalibrationDataInterfaceROOT
	This tool provides an interface to flavour tagging performance estimates. More...
class	CalibrationDataMappedHistogramContainer
	This is the class holding information for histogram-based calibration results, in cases where 'irregular' binning is used (e.g., if the binning in one variable depends on another variable), or where the dimensionality becomes too high for even 3D histograms (so that a mapping is needed to use THx). More...
class	CalibrationDataVariables
	This class (struct, actually) is nothing but a light-weight container of (kinematic or other) variables. More...
class	CDIReader
class	CleanUpVertex
class	ICandidateSearch
class	IConstituent
	Class IConstituent: This is the abstract base class for additional jet constituents to be put into the JetTag/ParticleJet class. More...
class	ITaggerDecorHandles
class	JetPartonTruthLabel
class	JetSecVertexingAlg
class	JetSecVtxFindingAlg
class	JetTagVertexDecoratorAlg
struct	JpsiCandidate
struct	JpsiEECandidate
class	JpsiFinder
class	JpsiFinder_ee
class	JpsiPlus1Track
class	JpsiPlus2Tracks
class	JpsiUpsilonCommon
class	ParticleShallowClone
class	PrimaryVertexRefitter
class	SV1DecorHandles
class	TruthTagResults

Typedefs
typedef std::string	NameType
	string to identify the constituent
typedef std::pair< double, double >	UncertaintyResult
	The following typedef is for convenience: most uncertainties can be asymmetric.
typedef std::pair< double, double >	CalibResult

Enumerations
enum	Uncertainty
	specification of type information requested by the user More...
enum	EVReductionStrategy
	specification of Eigenvector variations reduction strategy. More...
enum	OutOfBoundsStrategy
	strategies for dealing with specified kinematic variables being outside their range of validity: ignore any items, flag items (this will merely produce a summary at the end of the job), giving up when even a specified extrapolation range is exceeded, or giving up upon any out-of-bound condition. More...
enum	OutOfBoundsType
	counter types (to be used when flagging out-of-bounds cases) More...
enum	CalibrationStatus
enum	PairType
enum	MuonTypes
enum	PairTypeEE

Functions
double	signedDecayLengthSignificance (const xAOD::Vertex &priVertex, const std::vector< const xAOD::Vertex * > &secVertex, const Amg::Vector3D &jetDirection)
	Signed decay length significance of the weighted mean of the secondary vertices with respect to the primary vertex.
double	maxSignedDecayLengthSignificance (const xAOD::Vertex &priVertex, const std::vector< const xAOD::Vertex * > &secVertex, const Amg::Vector3D &jetDirection)
	Largest signed significance of the individual secondary vertices with respect to the primary vertex.
Int_t	addContainer (Analysis::CalibrationDataContainer *cnt, TFile *file, const char *tagger, const char *jetAuthor, const char *OP, const char *flavour, const char *name=0, bool isReference=false)
const CalibResult	dummyResult (dummyValue, dummyValue)
void	showHadronisations (const char *filename, const char *directory)
std::map< std::string, std::string >	getHadronisations (const char *filename, const char *directory)
void	showBuildNumber (const char *filename)
static const InterfaceID	IID_JpsiFinder_ee ("JpsiFinder_ee", 1, 0)
static const InterfaceID	IID_JpsiPlus1Track ("JpsiPlus1Track", 1, 0)
static const InterfaceID	IID_JpsiPlus2Tracks ("JpsiPlus2Tracks", 1, 0)
static const InterfaceID	IID_PrimaryVertexRefitter ("PrimaryVertexRefitter", 1, 0)

Variables
const unsigned int	MaxCalibrationVars = 10
	Maximum dimensionality of the calibration parametrisation.
const double	CalibZERO = 1.e-6
const double	dummyValue = -1.
constexpr double	muMass = ParticleConstants::muonMassInMeV
constexpr double	kMass = ParticleConstants::chargedKaonMassInMeV
constexpr double	piMass = ParticleConstants::chargedPionMassInMeV
constexpr double	pMass = ParticleConstants::protonMassInMeV

Detailed Description

The namespace of all packages in PhysicsAnalysis/JetTagging.

Typedef Documentation

CalibResult

typedef std::pair<double,double> Analysis::CalibResult

Definition at line 34 of file CalibrationDataInterfaceBase.h.

NameType

typedef std::string Analysis::NameType

string to identify the constituent

Definition at line 30 of file IConstituent.h.

UncertaintyResult

typedef std::pair<double, double> Analysis::UncertaintyResult

The following typedef is for convenience: most uncertainties can be asymmetric.

The pair holds the positive (first) and negative (second) uncertainties. Note that in the context of systematic uncertainties, "positive" and "negative" may reflect what happens if the uncertainty parameter is varied. This means that the "positive" uncertainty result may be negative etc.

Definition at line 33 of file CalibrationDataContainer.h.

Enumeration Type Documentation

CalibrationStatus

enum Analysis::CalibrationStatus

Definition at line 56 of file CalibrationDataVariables.h.

                         {
    kSuccess = 0,           // all OK
    kRange = 1,             // given coordinates outside the range of validity of the calibration
    kExtrapolatedRange = 2, // given coordinates even outside the extrapolation range 
    kError = 3              // "technical" error (typically: nonexistent object)
  };

EVReductionStrategy

enum Analysis::EVReductionStrategy

specification of Eigenvector variations reduction strategy.

For implementation reasons the possibilities are given in "reverse" order.

Definition at line 73 of file CalibrationDataInterfaceROOT.h.

{ Tight = 0, Medium = 1, Loose = 2};

MuonTypes

enum Analysis::MuonTypes

Definition at line 35 of file JpsiFinder.h.

{ CC=0, CT=1, TT=2};

OutOfBoundsStrategy

enum Analysis::OutOfBoundsStrategy

strategies for dealing with specified kinematic variables being outside their range of validity: ignore any items, flag items (this will merely produce a summary at the end of the job), giving up when even a specified extrapolation range is exceeded, or giving up upon any out-of-bound condition.

The strategy can be set in the configuration file. Note that the "GiveUpExtrapolated" strategy (give up upon finding that the kinematic variables are outside even the extrapolation range) implementation is only partial, as this will be flagged only if extrapolation uncertainties are requested.

Definition at line 82 of file CalibrationDataInterfaceROOT.h.

{ Ignore, Flag, GiveUpExtrapolated, GiveUp };

OutOfBoundsType

enum Analysis::OutOfBoundsType

counter types (to be used when flagging out-of-bounds cases)

Definition at line 85 of file CalibrationDataInterfaceROOT.h.

{ Main, Extrapolated, Eta, TagWeight };

PairType

enum Analysis::PairType

Definition at line 34 of file JpsiFinder.h.

{ MUMU=0, MUTRK=1, TRKTRK=2};

PairTypeEE

enum Analysis::PairTypeEE

Definition at line 47 of file JpsiFinder_ee.h.

{ ELEL=0, ELTRK=1, TRK2=2};

Uncertainty

enum Analysis::Uncertainty

specification of type information requested by the user

Definition at line 70 of file CalibrationDataInterfaceROOT.h.

{ None, Total, Statistical, Systematic, Extrapolation, SFEigen, SFNamed, TauExtrapolation, SFGlobalEigen };

Function Documentation

addContainer()

Int_t Analysis::addContainer	(	Analysis::CalibrationDataContainer *	cnt,
		TFile *	file,
		const char *	tagger,
		const char *	jetAuthor,
		const char *	OP,
		const char *	flavour,
		const char *	name = 0,
		bool	isReference = false )

dummyResult()

const CalibResult Analysis::dummyResult	(	dummyValue	,
		dummyValue	)

getHadronisations()

std::map< std::string, std::string > Analysis::getHadronisations	(	const char *	filename,
		const char *	directory )

IID_JpsiFinder_ee()

const InterfaceID Analysis::IID_JpsiFinder_ee ( "JpsiFinder_ee" , 1 , 0  )

static

IID_JpsiPlus1Track()

const InterfaceID Analysis::IID_JpsiPlus1Track ( "JpsiPlus1Track" , 1 , 0  )

static

IID_JpsiPlus2Tracks()

const InterfaceID Analysis::IID_JpsiPlus2Tracks ( "JpsiPlus2Tracks" , 1 , 0  )

static

IID_PrimaryVertexRefitter()

const InterfaceID Analysis::IID_PrimaryVertexRefitter ( "PrimaryVertexRefitter" , 1 , 0  )

static

maxSignedDecayLengthSignificance()

double Analysis::maxSignedDecayLengthSignificance	(	const xAOD::Vertex &	priVertex,
		const std::vector< const xAOD::Vertex * > &	secVertex,
		const Amg::Vector3D &	jetDirection )

Largest signed significance of the individual secondary vertices with respect to the primary vertex.

Vertices whose covariance cannot be inverted are skipped.

Definition at line 61 of file SecVertexSignificance.cxx.

                                                                           {
 
    std::vector<double> Sig3D(0);
    bool success=true;
    AmgSymMatrix(3) Wgt;
 
    for (const auto & svrt : secVertex)
      {
         Amg::Vector3D SVmPV = svrt->position()-priVertex.position();
         AmgSymMatrix(3) SVmPVCov = svrt->covariancePosition()+priVertex.covariancePosition();
         SVmPVCov.computeInverseWithCheck(Wgt, success);
         if( !success || Wgt(0,0)<=0. || Wgt(1,1)<=0. || Wgt(2,2)<=0. )continue;     //Inversion failure
         double significance = SVmPV.transpose()*Wgt*SVmPV;
         if(significance <= 0.) continue;                          //Something is still wrong!
         significance = std::sqrt(significance);
         if(SVmPV.dot(jetDirection)<0.) significance *= -1.;
         Sig3D.push_back(significance);
      }
 
    if(Sig3D.size()==0) return 0.;
 
    return *std::max_element(Sig3D.begin(),Sig3D.end());
  }

showBuildNumber()

void Analysis::showBuildNumber

(

const char *

filename

)

showHadronisations()

void Analysis::showHadronisations	(	const char *	filename,
		const char *	directory )

signedDecayLengthSignificance()

double Analysis::signedDecayLengthSignificance	(	const xAOD::Vertex &	priVertex,
		const std::vector< const xAOD::Vertex * > &	secVertex,
		const Amg::Vector3D &	jetDirection )

Signed decay length significance of the weighted mean of the secondary vertices with respect to the primary vertex.

The sign is taken from the projection of the decay length on the jet axis. Returns 0 if the significance cannot be calculated.

Definition at line 12 of file SecVertexSignificance.cxx.

                                                                        {
 
    std::vector<Amg::Vector3D> positions;
    std::vector<AmgSymMatrix(3)> weightMatrices;
    // If multiple secondary vertices were reconstructed, then a common (weighted) position will be used
    // in the signed decay length significance calculation
    Amg::Vector3D weightTimesPosition(0.,0.,0.);
    AmgSymMatrix(3) sumWeights;
    sumWeights.setZero();
 
    for (const auto& vtx : secVertex) {
      positions.push_back(vtx->position());
      weightMatrices.push_back(vtx->covariancePosition().inverse());
      weightTimesPosition += weightMatrices.back()*positions.back();
      sumWeights += weightMatrices.back();
    }
 
    // now we have the sum of the weights, let's invert this matrix to get the mean covariance matrix
    bool invertible;
    AmgSymMatrix(3) meanCovariance;
    meanCovariance.setZero();
    sumWeights.computeInverseWithCheck(meanCovariance, invertible);
    if (!invertible) return 0.;
 
    // calculate the weighted mean secondary vertex position
    Amg::Vector3D meanPosition = meanCovariance*weightTimesPosition;
 
    // add the mean covariance matrix of the secondary vertices to that of the primary vertex
    // this is the covariance matrix for the decay length
    AmgSymMatrix(3) covariance = meanCovariance + priVertex.covariancePosition();
 
    const Amg::Vector3D decayVector = meanPosition - priVertex.position();
    const double decaylength = decayVector.norm();
    if (decaylength == 0.) return 0.;  //Safety
 
    const Amg::Vector3D gradient = decayVector / decaylength;
    const double decaylength_err2 = gradient.dot(covariance * gradient);
    if (decaylength_err2 <= 0.) return 0.;  //Something is wrong
 
    double decaylength_significance = decaylength / std::sqrt(decaylength_err2);
 
    // get sign from projection on jet axis
    if (decayVector.dot(jetDirection) < 0.) decaylength_significance *= -1.;
 
    return decaylength_significance;
  }

Variable Documentation

CalibZERO

const double Analysis::CalibZERO = 1.e-6

Definition at line 32 of file CalibrationDataInterfaceBase.h.

dummyValue

const double Analysis::dummyValue = -1.

Definition at line 33 of file CalibrationDataInterfaceBase.h.

kMass

double Analysis::kMass = ParticleConstants::chargedKaonMassInMeV

constexpr

Definition at line 35 of file JpsiPlus1Track.cxx.

MaxCalibrationVars

const unsigned int Analysis::MaxCalibrationVars = 10

Maximum dimensionality of the calibration parametrisation.

This is just so that variables do not need to be carried around in various methods.

Definition at line 40 of file CalibrationDataContainer.h.

muMass

double Analysis::muMass = ParticleConstants::muonMassInMeV

constexpr

Definition at line 34 of file JpsiPlus1Track.cxx.

piMass

double Analysis::piMass = ParticleConstants::chargedPionMassInMeV

constexpr

Definition at line 36 of file JpsiPlus1Track.cxx.

pMass

double Analysis::pMass = ParticleConstants::protonMassInMeV

constexpr

Definition at line 34 of file JpsiPlus2Tracks.cxx.