Variation

Description

Generic structure to hold the relevant information to identify the variation indices. This structure may be passed over to physics (simple or composite) objects to vary (or not) the kinematics or the weight respectively.

#include <Variation.h>

Inheritance diagram for Variation:

Public Member Functions
	~Variation ()=default
	Variation (const TString &group, const TString &name, size_t index=0, int bit=0)
	Variation (const Variation &v)
	Variation (Variation &&v)
template<class T >
const T &	getCorrection (const std::string_view &group, const std::vector< T > &corrections) const
template<class PhysicsObject >
const Weight &	getWeight (const PhysicsObject &object) const
template<class PhysicsObject >
FourVector	getCorrP4 (const PhysicsObject &object) const
template<class PhysicsObject >
const DAS::Weight &	getWeight (const PhysicsObject &object) const

Public Attributes
const TString	group
const TString	name
const std::size_t	index
const int	bit

Constructor & Destructor Documentation

~Variation()

~Variation ( )

default

Destructor.

Variation() [1/3]

Variation ( const TString &  group, const TString &  name, size_t  index = 0, int  bit = 0  )

inline

Normal constructor.

                                                                                         :
        group(group), name(name), index(index), bit(bit)
    { }

Variation() [2/3]

Variation ( const Variation &  v )

inline

Copy constructor.

                                   :
        group(v.group), name(v.name), index(v.index), bit(v.bit)
    { }

Variation() [3/3]

Variation ( Variation &&  v )

inline

Move constructor.

                              :
        group(std::move(v.group)), name(std::move(v.name)),
        index(std::move(v.index)), bit(std::move(v.bit))
    { }

Member Function Documentation

getCorrection()

const T & getCorrection ( const std::string_view &  group, const std::vector< T > &  corrections  ) const

inline

Retrieves a correction from a vector. Returns the value at index 0 in the vector, unless this systematic variation modifies the correction, in which case the modified value is returned.

Parameters

group	An identifier for the group of variations, used when retrieving active variations from the metainfo.
corrections	A vector of values from which to fetch corrections.

{
    if (index >= corrections.size() || group != this->group)
        return corrections.front();
    return corrections.at(index);
}

getCorrP4()

FourVector getCorrP4 ( const PhysicsObject &  object ) const

inline

Retrieves the corrected four-momentum of an object in the current variation. This function uses the static variable ScaleVar in the object's class to determine which group it should use.

Warning

The class used to determine the group is determined at compile time from the type of the variable passed as argument.

Todo:

remove template once RecPhoton inherits from PhysicsObject

{
    return group == PhysicsObject::ScaleVar ? object.CorrP4(index) : object.CorrP4(0);
}

getWeight() [1/2]

const Weight& getWeight

(

const PhysicsObject &

object

)

const

Retrieves the weight of an object in the current variation. This function uses the static variable WeightVar in the object's class to determine which group it should use.

Warning

The class used to determine the group is determined at compile time from the type of the variable passed as argument.

getWeight() [2/2]

const DAS::Weight& getWeight ( const PhysicsObject &  object ) const

inline

Todo:

remove template once RecPhoton inherits from PhysicsObject

{
    return getCorrection(PhysicsObject::WeightVar, object.weights);
}

Member Data Documentation

bit

const int bit

correlation bit

group

const TString group

e.g. event, recjet

index

const std::size_t index

index in the vector where the variation factor is stored

name

const TString name

variation name (including "Up" or "Down")

---

The documentation for this struct was generated from the following file:

• /builds/cms-analysis/general/DasAnalysisSystem/Core/Installer/Core/Objects/interface/Variation.h