BinnedTransferFunctionOnPtEvaluator Class Reference

Evaluate a transfer function on Pt described by a 2D histogram retrieved from a ROOT file. More...

Detailed Description

Evaluate a transfer function on Pt described by a 2D histogram retrieved from a ROOT file.

This module takes as inputs two LorentzVectors: a 'gen-level' particle (which may be computed using for instance a Block or a 'real' transfer function) and a 'reco-level' particle (experimentally reconstructed). Assuming the LorentzVectors differ only by their Pt, this module returns the value of a transfer function (TF) evaluated on their respective Pt.

The transfer function (TF) is described by a 2D histogram (a ROOT TH2), where the X-axis defines the "generated" (true) Pt \(P_T_{gen}\), and the Y-axis the difference between the reconstructed and the generated Pt ( \(P_T_{rec}-P_T_{gen}\)).

It is assumed the TF is correctly normalised, i.e. integrals of slices along the Y-axis sum up to 1.

Integration dimension

This module requires 0 phase-space points.

Parameters

Name Type Description
file string Path to the ROOT file in which the transfer function is saved.
th2_name string Name of the TH2 stored in file file

Inputs

Name Type Description
reco_particle LorentzVector Experimentally reconstructed particle.
gen_particle LorentzVector Gen-level particle.

Outputs

Name Type Description
TF double Value of the TF evaluated on the reco and gen Pt.
See also
BinnedTransferFunctionOnPtEvaluator

Definition at line 231 of file BinnedTransferFunctionOnPt.cc.

Inheritance diagram for BinnedTransferFunctionOnPtEvaluator:

Public Member Functions

 BinnedTransferFunctionOnPtEvaluator (PoolPtr pool, const ParameterSet &parameters)
 
virtual Status work () override
 Main function. More...
 
- Public Member Functions inherited from BinnedTransferFunctionOnPtBase
 BinnedTransferFunctionOnPtBase (PoolPtr pool, const ParameterSet &parameters)
 
- Public Member Functions inherited from Module
 Module (PoolPtr pool, const std::string &name)
 Constructor. More...
 
virtual void configure ()
 Called once at the beginning of the job.
 
virtual void beginIntegration ()
 Called once at the beginning of the integration.
 
virtual void beginPoint ()
 Called once when a new PS point is started. More...
 
virtual void beginLoop ()
 Called once at the beginning of a loop. More...
 
virtual void endLoop ()
 Called once at the end of a loop. More...
 
virtual void endPoint ()
 Called once when a PS point is finished. More...
 
virtual void endIntegration ()
 Called once at the end of the integration.
 
virtual void finish ()
 Called once at the end of the job.
 
virtual std::string name () const final
 

Additional Inherited Members

- Public Types inherited from Module
enum  Status : std::int8_t { OK, NEXT, ABORT }
 
- Static Public Member Functions inherited from Module
static std::string statusToString (const Status &status)
 
static bool is_virtual_module (const std::string &name)
 Test if a given name correspond to a virtual module. More...
 
- Protected Member Functions inherited from Module
template<typename T , typename... Args>
std::shared_ptr< T > produce (const std::string &name, Args... args)
 Add a new output to the module. More...
 
template<typename T >
Value< T > get (const std::string &module, const std::string &name)
 
template<typename T >
Value< T > get (const InputTag &tag)
 
- Protected Attributes inherited from BinnedTransferFunctionOnPtBase
std::unique_ptr< TH2 > m_th2
 
double m_deltaMin
 
double m_deltaMax
 
double m_deltaRange
 
double m_PtgenMin
 
double m_PtgenMax
 
double m_fallBackPtgenMax
 
Value< LorentzVector > m_reco_input
 
- Protected Attributes inherited from Module
PoolPtr m_pool
 

Member Function Documentation

◆ work()

virtual Status BinnedTransferFunctionOnPtEvaluator::work ( )
inlineoverridevirtual

Main function.

This method is called for each integration step. The module's logic and work happen here.

You'll usually want to override this function if you want your module to perform some task.

Reimplemented from Module.

Definition at line 238 of file BinnedTransferFunctionOnPt.cc.


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