ISF::GenericTruthStrategy Class Reference

A multi-purpose implementation of an ISF TruthStrategy. More...

#include <GenericTruthStrategy.h>

Inheritance diagram for ISF::GenericTruthStrategy:

Collaboration diagram for ISF::GenericTruthStrategy:

Public Member Functions
	GenericTruthStrategy (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters.
	~GenericTruthStrategy ()
	Destructor.
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual bool	pass (ITruthIncident &incident) const override
	true if the ITruthStrategy implementation applies to the given ITruthIncident
virtual bool	appliesToRegion (unsigned short geoID) const override

Private Attributes
bool	m_useParentPt
	parent kinetic energy / transverse momentum cuts (pT is stored as pT^2 which allows for faster comparisons)
double	m_parentPt2
	parent particle
double	m_parentEkin
	parent particle
bool	m_useChildPt
	child particle kinetic energy / transverse momentum cuts (pT is stored as pT^2 which allows for faster comparisons)
double	m_childPt2
	pT momentum cut
double	m_childEkin
	Ekin cut.
bool	m_allowChildrenOrParentPass
	pass cuts if parent did not
VertexTypesVector	m_vertexTypesVector
	vertex type (physics code) checks
VertexTypesSet	m_vertexTypes
	optimized for search
bool	m_doVertexRangeCheck
int	m_vertexTypeRangeLow
int	m_vertexTypeRangeHigh
unsigned	m_vertexTypeRangeLength
PDGCodesVector	m_parentPdgCodesVector
	PDG code checks.
PDGCodesSet	m_parentPdgCodes
	optimized for search
IntegerArrayProperty	m_regionListProperty

Detailed Description

A multi-purpose implementation of an ISF TruthStrategy.

Author

Elmar.Ritsch -at- cern.ch

Definition at line 35 of file GenericTruthStrategy.h.

Constructor & Destructor Documentation

GenericTruthStrategy()

ISF::GenericTruthStrategy::GenericTruthStrategy	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Constructor with parameters.

Constructor.

Definition at line 17 of file GenericTruthStrategy.cxx.

                                                                                                         :
  base_class(t,n,p),
  m_useParentPt(true),
  m_parentPt2(-1.),
  m_parentEkin(-1.),
  m_useChildPt(true),
  m_childPt2(-1.),
  m_childEkin(-1.),
  m_allowChildrenOrParentPass(false),
  m_vertexTypesVector(0),
  m_vertexTypes(),
  m_doVertexRangeCheck(false),
  m_vertexTypeRangeLow(0),
  m_vertexTypeRangeHigh(0),
  m_vertexTypeRangeLength(0),
  m_parentPdgCodesVector(0),
  m_parentPdgCodes()
{
    // provide either a pT or Ekin cut for the parent and child particles respectively.
    // if none are given for either type, it will not use pT or Ekin cuts
    // (the Pt2 variables get squared in the initialize() method)
    declareProperty("ParentMinPt"               , m_parentPt2            );
    declareProperty("ParentMinEkin"             , m_parentEkin           );
    declareProperty("ChildMinPt"                , m_childPt2             );
    declareProperty("ChildMinEkin"              , m_childEkin        );
    // if set to true, kinetic cuts are passed even if only child particles pass them
    // (used for special cases such as de-excitation)
    declareProperty("AllowChildrenOrParentPassKineticCuts" , m_allowChildrenOrParentPass );
    declareProperty("VertexTypes"                , m_vertexTypesVector   );
    declareProperty("VertexTypeRangeLow"         , m_vertexTypeRangeLow  );
    declareProperty("VertexTypeRangeHigh"        , m_vertexTypeRangeHigh );
    declareProperty("ParentPDGCodes"            , m_parentPdgCodesVector  );
    declareProperty("Regions"                   , m_regionListProperty );
}

~GenericTruthStrategy()

ISF::GenericTruthStrategy::~GenericTruthStrategy

(

)

Destructor.

Definition at line 53 of file GenericTruthStrategy.cxx.

{
}

Member Function Documentation

appliesToRegion()

bool ISF::GenericTruthStrategy::appliesToRegion ( unsigned short geoID ) const

overridevirtual

Definition at line 210 of file GenericTruthStrategy.cxx.

{
  return std::find( m_regionListProperty.begin(),
                    m_regionListProperty.end(),
                    geoID ) != m_regionListProperty.end();
}

finalize()

StatusCode ISF::GenericTruthStrategy::finalize ( )

overridevirtual

Definition at line 138 of file GenericTruthStrategy.cxx.

{
    ATH_MSG_VERBOSE("Finalizing ...");
    return StatusCode::SUCCESS;
}

initialize()

StatusCode ISF::GenericTruthStrategy::initialize ( )

overridevirtual

Definition at line 58 of file GenericTruthStrategy.cxx.

{
    ATH_MSG_VERBOSE("Initializing ...");
 
    // (*) setup parent particle cuts
    // -----
    //     (compute and store the squared cut parameters (faster comparisons))
    // check whether the user input makes sense (error case)
    if ( (m_parentPt2>=0.) && (m_parentEkin>=0.) ) {
      ATH_MSG_ERROR("Both, pT and Ekin cuts are given for parent particles. Unclear which one to use! ABORT!");
      return StatusCode::FAILURE;
    }
    // neither pT nor Energy cuts were given (never being used so far)
    //   -> enable pT cut and set it to 0.
    else if ( (m_parentPt2<0.) && (m_parentEkin<0.) ) {
      // we don't use a flag to disable energy/momentum checks, because
      // all relevant truth strategies up to now do use such cuts
      m_useParentPt = true;
      m_parentPt2   = 0.;
      m_parentEkin  = 0.;  // would not be needed actually
    }
    // either pT or Ekin cut is given (standard case)
    else {
      // enable pT cut if value given (greater than 0.):
      m_useParentPt  = !(m_parentPt2<0.);
      m_parentPt2   *= m_parentPt2;
    }
 
    // (*) setup child particle cuts
    // -----
    //     (compute and store the squared cut parameters (faster comparisons))
    // check whether the user input makes sense (error case)
    if ( (m_childPt2>=0.) && (m_childEkin>=0.) ) {
      ATH_MSG_ERROR("Both, pT and Ekin cuts are given for child particles. Unclear which one to use! ABORT!");
      return StatusCode::FAILURE;
    }
    // neither pT nor Energy cuts were given (never being used so far)
    //   -> enable pT cut and set it to 0.
    else if ( (m_childPt2<0.) && (m_childEkin<0.) ) {
      // we don't use a flag to disable energy/momentum checks, because
      // all relevant truth strategies up to now do use such cuts
      m_useChildPt = true;
      m_childPt2   = 0.;
      m_childEkin  = 0.;  // would not be needed actually
    }
    // either pT or Ekin cut is given (standard case)
    else {
      // enable pT cut if value given (greater than 0.):
      m_useChildPt = !(m_childPt2<0.);
      m_childPt2  *= m_childPt2;
    }
 
    // VertexTypeRanges:
    //
    // check whether user input makes sense:
    if ( m_vertexTypeRangeHigh < m_vertexTypeRangeLow) {
      ATH_MSG_ERROR("The given parameter VertexTypeRangeLow is bigger than VertexTypeRangeHigh. ABORT");
      return StatusCode::FAILURE;
    }
    // the length of the given vertex type range
    m_vertexTypeRangeLength = unsigned(m_vertexTypeRangeHigh - m_vertexTypeRangeLow) + 1;
    // if neither lower now upper range limit given, disable range check
    m_doVertexRangeCheck    = m_vertexTypeRangeLow && m_vertexTypeRangeHigh;
 
 
    // fill PDG code std::set used for optimized search
    m_parentPdgCodes.insert( m_parentPdgCodesVector.begin(), m_parentPdgCodesVector.end());
 
    // fill vertex type std::set used for optimized search
    m_vertexTypes.insert( m_vertexTypesVector.begin(), m_vertexTypesVector.end());
 
    for(auto region : m_regionListProperty.value()) {
      if(region < AtlasDetDescr::fFirstAtlasRegion || region >= AtlasDetDescr::fNumAtlasRegions) {
        ATH_MSG_ERROR("Unknown Region (" << region << ") specified. Please check your configuration.");
        return StatusCode::FAILURE;
      }
    }
    return StatusCode::SUCCESS;
}

pass()

bool ISF::GenericTruthStrategy::pass ( ITruthIncident & incident ) const

overridevirtual

true if the ITruthStrategy implementation applies to the given ITruthIncident

Definition at line 144 of file GenericTruthStrategy.cxx.

                                                            {
 
  // (1.) momentum/energy check
  // ----
  //
  {
    // check whether parent particle passes cut or not
    bool primFail = (m_useParentPt) ? (ti.parentPt2()<m_parentPt2)
      : (ti.parentEkin()<m_parentEkin) ;
 
 
    // if parent particle failed and strategy does not
    // allow for child-only pass -> failed
    if ( ( primFail && (!m_allowChildrenOrParentPass) ) ) {
      return false;
    }
 
    // check child particles
    bool secPass =  m_useChildPt ? ti.childrenPt2Pass(m_childPt2)
                                 : ti.childrenEkinPass(m_childEkin);
 
    // if child particles do not pass cuts
    if (!secPass) {
      if (!m_allowChildrenOrParentPass) {
        // child particles were required to pass cuts but did not
        return false;
      } else if (primFail) {
        // neither parent nor child particles passed cuts
        return false;
      }
    }
 
  }
 
 
  // (2.) parent particle PDG code check
  // ----
  // check whether parent PDG code matches with any of the given ones
  if (  m_parentPdgCodes.size() &&
       (m_parentPdgCodes.find(ti.parentPdgCode()) == m_parentPdgCodes.end()) ) {
 
    // parent particle PDG code not found
    return false;
  }
 
 
  // (3.) vertex type check
  // ----
  if ( m_doVertexRangeCheck || m_vertexTypes.size()) {
    int vxtype = ti.physicsProcessCode();
 
    // (3.1) vxtype in given range?: this is a small performance trick (only one comparison operator to check if within range)
    //  -> exactly equivalent to:  m_doVertexRangeCheck  && (m_vertexTypeLow<=vxtype) && (vxtype<=m_vertexTypeRangeHigh)
    bool vtxTypeRangePassed = m_doVertexRangeCheck && ( unsigned(vxtype-m_vertexTypeRangeLow) < m_vertexTypeRangeLength );
    // (3.2) if not in range or range check disabled, check whether vxtype
    //       std::set contains the given vertex type
    if ( (!vtxTypeRangePassed) && (m_vertexTypes.find(vxtype)==m_vertexTypes.end()) ) {
        // vxtype not registered -> not passed
        return false;
    }
  }
 
  // all cuts passed
  return true;
}

Member Data Documentation

m_allowChildrenOrParentPass

bool ISF::GenericTruthStrategy::m_allowChildrenOrParentPass

private

pass cuts if parent did not

Definition at line 64 of file GenericTruthStrategy.h.

m_childEkin

double ISF::GenericTruthStrategy::m_childEkin

private

Ekin cut.

Definition at line 63 of file GenericTruthStrategy.h.

m_childPt2

double ISF::GenericTruthStrategy::m_childPt2

private

pT momentum cut

Definition at line 62 of file GenericTruthStrategy.h.

m_doVertexRangeCheck

bool ISF::GenericTruthStrategy::m_doVertexRangeCheck

private

Definition at line 69 of file GenericTruthStrategy.h.

m_parentEkin

double ISF::GenericTruthStrategy::m_parentEkin

private

parent particle

Definition at line 57 of file GenericTruthStrategy.h.

m_parentPdgCodes

PDGCodesSet ISF::GenericTruthStrategy::m_parentPdgCodes

private

optimized for search

Definition at line 76 of file GenericTruthStrategy.h.

m_parentPdgCodesVector

PDGCodesVector ISF::GenericTruthStrategy::m_parentPdgCodesVector

private

PDG code checks.

Python property

Definition at line 75 of file GenericTruthStrategy.h.

m_parentPt2

double ISF::GenericTruthStrategy::m_parentPt2

private

parent particle

Definition at line 56 of file GenericTruthStrategy.h.

m_regionListProperty

IntegerArrayProperty ISF::GenericTruthStrategy::m_regionListProperty

private

Definition at line 78 of file GenericTruthStrategy.h.

m_useChildPt

bool ISF::GenericTruthStrategy::m_useChildPt

private

child particle kinetic energy / transverse momentum cuts (pT is stored as pT^2 which allows for faster comparisons)

use pT or Ekin cuts?

Definition at line 61 of file GenericTruthStrategy.h.

m_useParentPt

bool ISF::GenericTruthStrategy::m_useParentPt

private

parent kinetic energy / transverse momentum cuts (pT is stored as pT^2 which allows for faster comparisons)

use pT or Ekin cuts?

Definition at line 55 of file GenericTruthStrategy.h.

m_vertexTypeRangeHigh

int ISF::GenericTruthStrategy::m_vertexTypeRangeHigh

private

Definition at line 71 of file GenericTruthStrategy.h.

m_vertexTypeRangeLength

unsigned ISF::GenericTruthStrategy::m_vertexTypeRangeLength

private

Definition at line 72 of file GenericTruthStrategy.h.

m_vertexTypeRangeLow

int ISF::GenericTruthStrategy::m_vertexTypeRangeLow

private

Definition at line 70 of file GenericTruthStrategy.h.

m_vertexTypes

VertexTypesSet ISF::GenericTruthStrategy::m_vertexTypes

private

optimized for search

Definition at line 68 of file GenericTruthStrategy.h.

m_vertexTypesVector

VertexTypesVector ISF::GenericTruthStrategy::m_vertexTypesVector

private

vertex type (physics code) checks

Python property

Definition at line 67 of file GenericTruthStrategy.h.

---

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

• GenericTruthStrategy.h
• GenericTruthStrategy.cxx