Analysis::CalibrationDataUpdater Class Reference

This algorithm is meant to be used in a stand-alone fashion, to update a ROOT file containing results to be entered in COOL with fresh (but possibly partial) information. More...

#include <CalibrationDataUpdater.h>

Inheritance diagram for Analysis::CalibrationDataUpdater:

Collaboration diagram for Analysis::CalibrationDataUpdater:

Public Member Functions
	CalibrationDataUpdater (const std::string &name, ISvcLocator *pSvcLocator)
	Standard Athena-Algorithm Constructor.
virtual	~CalibrationDataUpdater ()=default
	Default Destructor.
StatusCode	initialize () 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
void	setDefaultResults (const std::string &Name, TFile *fOut) const
	auxiliary functions
void	copyResults (const std::string &from, const std::string &to, TFile *fIn, TFile *fOut) const
bool	isValidName (const std::string &Name) const
void	writeOutput (TObject *in, const std::string &Name, TFile *fOut) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_inputRootFile = ""
	input ROOT file containing new results
std::string	m_DbRootFile = ""
	ROOT file to be entered in COOL.
std::vector< std::string >	m_paramNames
	names of input and output parametrisations
Gaudi::Property	m_overrideDefaults = false
	flag if these results are to be used as defaults (they will anyway if no other results exist for the particular combination of jet collection / tagging algorithm / operating point)
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

This algorithm is meant to be used in a stand-alone fashion, to update a ROOT file containing results to be entered in COOL with fresh (but possibly partial) information.

Alternatively, it can be used to change the default algorithm that is used (if multiple alternatives are available).

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 37 of file CalibrationDataUpdater.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

CalibrationDataUpdater()

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

Standard Athena-Algorithm Constructor.

Definition at line 19 of file CalibrationDataUpdater.cxx.

  :
  AthAlgorithm(name,pSvcLocator)
{
  //  property declarations
  declareProperty("inputRootFile", m_inputRootFile, "ROOT file containing new parametrisations");
  declareProperty("DbRootFile", m_DbRootFile, "ROOT file to be entered in COOL");
  declareProperty("paramNames", m_paramNames, "list of input and output parametrisation names");
  declareProperty("overrideDefaults", m_overrideDefaults, "true if new results are to be used as default");
 
}

~CalibrationDataUpdater()

virtual Analysis::CalibrationDataUpdater::~CalibrationDataUpdater ( )

virtualdefault

Default Destructor.

Member Function Documentation

copyResults()

void Analysis::CalibrationDataUpdater::copyResults ( const std::string & from, const std::string & to, TFile * fIn, TFile * fOut ) const

private

Definition at line 136 of file CalibrationDataUpdater.cxx.

{
  if (! isValidName(to)) {
    ATH_MSG_WARNING( name() << ": invalid parametrisation name: " << to  );
    return;
  }
 
  // copy the parametrisation itself
  TObject* in = fIn->Get(from.c_str());
  if (! in) {
    ATH_MSG_WARNING( name() << ": input parametrisation name not found: "
                     << from  );
    return;
  }
  writeOutput(in, to, fOut);
 
  // copy the corresponding covariance matrix
  std::string fromCov(from); fromCov += "_stat";
  std::string toCov(to); toCov += "_stat";
  in = fIn->Get(fromCov.c_str());
  if (! in) {
    ATH_MSG_WARNING( name() << ": input parametrisation covariance matrix name not found: "
                     << fromCov  );
    return;
  }
  writeOutput(in, toCov, fOut);
  
  // copy the corresponding covariance matrix
  std::string fromSyst(from); fromSyst += "_syst";
  std::string toSyst(to); toSyst += "_syst";
  in = fIn->Get(fromSyst.c_str());
  if (! in) {
    ATH_MSG_WARNING( name() << ": input parametrisation systematics name not found: "
                     << fromSyst  );
    return;
  }
  writeOutput(in, toSyst, fOut);
  
}

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

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::CalibrationDataUpdater::initialize ( )

override

standard Athena-Algorithm method

Definition at line 33 of file CalibrationDataUpdater.cxx.

{
  // Code entered here will be executed once at program start.
  
  ATH_MSG_INFO( name() << " initialize()"  );
 
  // basic sanity and consistency checks
 
  TFile* fIn = 0;
  bool newInput = (m_inputRootFile.empty());
  if (newInput) {
    fIn = new TFile(m_inputRootFile.c_str());
    if (fIn->IsZombie()) {
      ATH_MSG_FATAL( name() << ": requested input ROOT file invalid: "
                     << m_inputRootFile  );
      return StatusCode::FAILURE;
    }
  } else if (! m_overrideDefaults) {
    ATH_MSG_FATAL( name() << ": no input ROOT file given and no defaults to be modified:"
                   << " no action to be taken"  );
    return StatusCode::FAILURE;
  }
  if (m_DbRootFile.empty()) {
    ATH_MSG_FATAL( name() << ": no DB ROOT file given"  );
    return StatusCode::FAILURE;
  }
  TFile* fOut = new TFile(m_DbRootFile.c_str(), "UPDATE");
  if (fOut->IsZombie()) {
    ATH_MSG_FATAL( name() << ": DB ROOT file invalid: "
                   << m_DbRootFile  );
    return StatusCode::FAILURE;
  }
 
  for (const std::string& itname : m_paramNames){
    string to = *itname;
    // 1. determine whether to insert new results
    if (newInput) {
      // if no "->" is found, assume that the input and output object names are identical
      const string::size_type delim = itname->find("->");
      string from = (delim == string::npos) ? *itname : itname->substr(0, delim);
      if (delim != string::npos) to = itname->substr(delim+2);
      copyResults(from, to, fIn, fOut);
    } else if (! isValidName(to)) {
      ATH_MSG_WARNING( name() << ": invalid parametrisation name: " << to  );
      continue;
    }
    // 2. make these new results the default (if requested or if no default exists yet)
    setDefaultResults(to, fOut);
  }
  ATH_MSG_DEBUG( name() << ": all done"  );
 
  if (fIn) fIn->Close();
  fOut->Close();
 
  ATH_MSG_DEBUG( "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.

isValidName()

bool Analysis::CalibrationDataUpdater::isValidName ( const std::string & Name ) const

private

Definition at line 177 of file CalibrationDataUpdater.cxx.

{
  // this is a very basic check: the name should contain four slashes
  // and should end either in "_SF" or "_Eff"
  int slashes = 0;
  string::size_type delim = Name.find("/");
  while (delim != string::npos) {
    ++slashes;
    Name = Name.substr(delim+1);
    delim = Name.find("/");
  }
  if (slashes != 4) return false;
 
  delim = Name.rfind("_");
  if (delim == string::npos) return false;
  Name = Name.substr(delim+1);
  return (Name == "SF" || Name == "Eff");
}

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();
  }

setDefaultResults()

void Analysis::CalibrationDataUpdater::setDefaultResults ( const std::string & Name, TFile * fOut ) const

private

auxiliary functions

Definition at line 91 of file CalibrationDataUpdater.cxx.

{
  fOut->cd("/");
  TObject* obj = fOut->Get(Name.c_str());
  if (! obj) {
    ATH_MSG_WARNING( name() << ": nonexistent parametrisation name: " << Name );
    return;
  }
 
  string::size_type delim = Name.rfind("/");
  string dir = Name.substr(0, delim);
  TDirectory* newdir = fOut->GetDirectory(dir.c_str());
  if (! newdir->cd()) {
    // This should never happen, given that the object above apparently exists...
    ATH_MSG_WARNING( name() << ": Name now: " << Name << "; pwd: "
                     << gDirectory->GetPath() << "; cd() to subdir "
                     << dir << " failed!"  );
  };
 
  // if no change of defaults is requested to begin with, check whether a default
  // exists already
  delim = Name.rfind("_");
  string defaultName("default"); defaultName += Name.substr(delim);
  if (! m_overrideDefaults) {
    string fullName(dir); fullName += "/"; fullName += defaultName;
    if (fOut->Get(fullName.c_str())) return;
  }
 
  ATH_MSG_INFO( name() << ": copying parametrisation name: "
                << Name << " (+ stat., syst.) as default"  );
 
  // do the actual copying for the parametrisation itself
  obj->Write(defaultName.c_str());
 
  // and for the parameter covariance matrix
  string nameCov(Name); nameCov += "_stat";
  string defaultNameCov(defaultName); defaultNameCov += "_stat";
  fOut->Get(nameCov.c_str())->Write(defaultNameCov.c_str());
 
  // and for the systematic uncertainty
  string nameSyst(Name); nameSyst += "_syst";
  string defaultNameSyst(defaultName); defaultNameSyst += "_syst";
  fOut->Get(nameSyst.c_str())->Write(defaultNameSyst.c_str());
}

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);
      }
    }
  }

writeOutput()

void Analysis::CalibrationDataUpdater::writeOutput ( TObject * in, const std::string & Name, TFile * fOut ) const

private

Definition at line 196 of file CalibrationDataUpdater.cxx.

{
  // first check whether the output directory exists, and if not, create it
  fOut->cd("/");
  TDirectory* tdir = dynamic_cast<TDirectory*>(fOut);
  string::size_type delim = Name.find("/");
  while (delim != string::npos) {
    string dir = Name.substr(0, delim);
    TDirectory* newdir = tdir->GetDirectory(dir.c_str());
    if (! newdir) newdir = tdir->mkdir(dir.c_str());
    if (! newdir->cd()) {
      ATH_MSG_WARNING( name() << ": Name now: " << Name << "; pwd: "
                       << gDirectory->GetPath() << "; cd() to subdir "
                       << dir << " failed!"  );
    };
    tdir = newdir;
    Name = Name.substr(delim+1, string::npos);
    delim = Name.find("/");
  }
 
  // then write the named object
  ATH_MSG_INFO( name() << ": writing object " << Name << " to directory "
                << gDirectory->GetPath()  );
  in->Write(Name.c_str());
}

Member Data Documentation

m_DbRootFile

std::string Analysis::CalibrationDataUpdater::m_DbRootFile = ""

private

ROOT file to be entered in COOL.

Definition at line 64 of file CalibrationDataUpdater.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_inputRootFile

std::string Analysis::CalibrationDataUpdater::m_inputRootFile = ""

private

input ROOT file containing new results

Definition at line 61 of file CalibrationDataUpdater.h.

m_overrideDefaults

Gaudi::Property Analysis::CalibrationDataUpdater::m_overrideDefaults = false

private

flag if these results are to be used as defaults (they will anyway if no other results exist for the particular combination of jet collection / tagging algorithm / operating point)

Definition at line 72 of file CalibrationDataUpdater.h.

m_paramNames

std::vector<std::string> Analysis::CalibrationDataUpdater::m_paramNames

private

names of input and output parametrisations

Definition at line 67 of file CalibrationDataUpdater.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:

• CalibrationDataUpdater.h
• CalibrationDataUpdater.cxx