Minimal test of the CalibrationDataInterfaceTool functionality. More...

#include <CalibrationDataInterfaceTester.h>

Inheritance diagram for Analysis::CalibrationDataInterfaceTester:

Collaboration diagram for Analysis::CalibrationDataInterfaceTester:

Public Member Functions
	CalibrationDataInterfaceTester (const std::string &name, ISvcLocator *pSvcLocator)
	Standard Athena-Algorithm Constructor.
virtual	~CalibrationDataInterfaceTester ()=default
	Default Destructor.
StatusCode	initialize () override
	standard Athena-Algorithm method
StatusCode	execute () override
	standard Athena-Algorithm method
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property	m_jetCollection
	jet collection name
Gaudi::Property	m_tagger
	tagger name
Gaudi::Property	m_operatingPoint
	tagger operating point
std::string	m_calibrationUncertainty
	calibration uncertainty result
CalibrationDataInterfaceTool::Uncertainty	m_uncertaintyType
ToolHandle< ICalibrationDataInterfaceTool >	m_calibrationInterface {this, "ICalibrationDataInterfaceTool", "", "CalibrationDataInterface Tool"}
	pointer to the CalibrationDataInterfaceTool
SG::ReadHandleKey< JetCollection >	m_JetCollectionKey {this, "JetCollectionKey", "", "read jet collection"}
	I/O handlers.
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Minimal test of the CalibrationDataInterfaceTool functionality.

Author: Frank Filthaut F.Fil.nosp@m.thau.nosp@m.t@sci.nosp@m.ence.nosp@m..ru.n.nosp@m.l

Definition at line 31 of file CalibrationDataInterfaceTester.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CalibrationDataInterfaceTester()

Analysis::CalibrationDataInterfaceTester::CalibrationDataInterfaceTester	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Standard Athena-Algorithm Constructor.

Definition at line 24 of file CalibrationDataInterfaceTester.cxx.

  :   AthAlgorithm(name, pSvcLocator)
{
  //  template for property declaration
  declareProperty("JetCollection",          m_jetCollection,          "name of the jet collection to be used");
  declareProperty("Tagger",                 m_tagger,                 "name of the tagging algorithm to be used");
  declareProperty("OperatingPoint",         m_operatingPoint,         "name of the tagging algorithm operating point to be used");
  declareProperty("CalibrationUncertainty", m_calibrationUncertainty, "calibration uncertainty result");
  declareProperty("CalibrationInterface",   m_calibrationInterface,   "interface tool instance name");
}

◆ ~CalibrationDataInterfaceTester()

virtual Analysis::CalibrationDataInterfaceTester::~CalibrationDataInterfaceTester ( )

virtualdefault

Default Destructor.

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode Analysis::CalibrationDataInterfaceTester::execute ( )

override

standard Athena-Algorithm method

Definition at line 68 of file CalibrationDataInterfaceTester.cxx.

{
  // Code entered here will be executed once per event
 
  // retrieve the desired jet collection
  EventContext& ctx = Gaudi::Hive::currentContext();
  SG::ReadHandle<JetCollection> jets(m_JetCollectionKey, ctx);
  ATH_CHECK(jets.isValid());
 
  int njtag = (*jets).size();
  ATH_MSG_INFO("JetCollection " << m_jetCollection
           << " found with " << njtag << " jets.");
 
  for (auto jetItr : jets) {
    // --- get btagging weight for the tagger under consideration
    double weight = (*jetItr)->getFlavourTagWeight(m_tagger);
 
    // --- get the true label of the jet from MC Truth:
    const Analysis::TruthInfo* mcinfo = (*jetItr)->tagInfo<Analysis::TruthInfo>("TruthInfo");
    if (! mcinfo) {
      ATH_MSG_DEBUG("could not find TruthInfo for matching jet");
      continue;
    }
    string label = mcinfo->jetTruthLabel();
 
    std::pair<double, double> sfResult =
      m_calibrationInterface->getScaleFactor(**jetItr, label, m_operatingPoint, m_uncertaintyType);
    std::pair<double, double> effResult =
      m_calibrationInterface->getEfficiency(**jetItr, label, m_operatingPoint, m_uncertaintyType);
 
    ATH_MSG_DEBUG("Jet with " << m_tagger << " weight: " << weight);
    ATH_MSG_DEBUG(" label: " << label);
    ATH_MSG_DEBUG(" SF (unc.): " << sfResult.first
         << "(" << sfResult.second << ")");
    ATH_MSG_DEBUG(" eff (unc.): " << effResult.first << "(" << effResult.second << ")");
 
  }
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ initialize()

StatusCode Analysis::CalibrationDataInterfaceTester::initialize ( )

override

standard Athena-Algorithm method

Definition at line 37 of file CalibrationDataInterfaceTester.cxx.

{
 
 
  ATH_CHECK(m_JetCollectionKey.initialize());
 
  StatusCode sc = m_calibrationInterface.retrieve();
  if (sc.isFailure()) {
      ATH_MSG_ERROR("initialize() in " << name() << ": unable to retrieve "
            << "calibration interface tool!");
    return sc;
  }
 
  std::transform(m_calibrationUncertainty.begin(), m_calibrationUncertainty.end(),
         m_calibrationUncertainty.begin(), tolower);
  if (m_calibrationUncertainty.find("total") != string::npos) {
    m_uncertaintyType = CalibrationDataInterfaceTool::Total;
  } else if (m_calibrationUncertainty.find("syst") != string::npos) {
    m_uncertaintyType = CalibrationDataInterfaceTool::Systematic;
  } else if (m_calibrationUncertainty.find("stat") != string::npos) {
    m_uncertaintyType = CalibrationDataInterfaceTool::Statistical;
  } else {
    m_uncertaintyType = CalibrationDataInterfaceTool::None;
  }
  
  ATH_MSG_INFO("initialize() successful in " << name());
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_calibrationInterface

ToolHandle<ICalibrationDataInterfaceTool> Analysis::CalibrationDataInterfaceTester::m_calibrationInterface {this, "ICalibrationDataInterfaceTool", "", "CalibrationDataInterface Tool"}

private

pointer to the CalibrationDataInterfaceTool

Definition at line 61 of file CalibrationDataInterfaceTester.h.

61{this, "ICalibrationDataInterfaceTool", "", "CalibrationDataInterface Tool"};

◆ m_calibrationUncertainty

std::string Analysis::CalibrationDataInterfaceTester::m_calibrationUncertainty

private

calibration uncertainty result

Definition at line 57 of file CalibrationDataInterfaceTester.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_jetCollection

Gaudi::Property Analysis::CalibrationDataInterfaceTester::m_jetCollection

private

jet collection name

Definition at line 48 of file CalibrationDataInterfaceTester.h.

◆ m_JetCollectionKey

SG::ReadHandleKey<JetCollection> Analysis::CalibrationDataInterfaceTester::m_JetCollectionKey {this, "JetCollectionKey", "", "read jet collection"}

private

I/O handlers.

Definition at line 64 of file CalibrationDataInterfaceTester.h.

64{this, "JetCollectionKey", "", "read jet collection"};

◆ m_operatingPoint

Gaudi::Property Analysis::CalibrationDataInterfaceTester::m_operatingPoint

private

tagger operating point

Definition at line 54 of file CalibrationDataInterfaceTester.h.

◆ m_tagger

Gaudi::Property Analysis::CalibrationDataInterfaceTester::m_tagger

private

tagger name

Definition at line 51 of file CalibrationDataInterfaceTester.h.

◆ m_uncertaintyType

CalibrationDataInterfaceTool::Uncertainty Analysis::CalibrationDataInterfaceTester::m_uncertaintyType

private

Definition at line 58 of file CalibrationDataInterfaceTester.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CalibrationDataInterfaceTester()

◆ ~CalibrationDataInterfaceTester()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_calibrationInterface

◆ m_calibrationUncertainty

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_jetCollection

◆ m_JetCollectionKey

◆ m_operatingPoint

◆ m_tagger

◆ m_uncertaintyType

◆ m_varHandleArraysDeclared

◆ m_vhka