HIEventShapeSummaryTool Class Reference

#include <HIEventShapeSummaryTool.h>

Inheritance diagram for HIEventShapeSummaryTool:

Collaboration diagram for HIEventShapeSummaryTool:

Classes
struct	summary_info_t

Public Member Functions
	HIEventShapeSummaryTool (const std::string &n)
StatusCode	summarize (const xAOD::HIEventShapeContainer *in, xAOD::HIEventShapeContainer *out) const override
StatusCode	initialize () override
	Dummy implementation of the initialisation function.
std::string	dumpList () const override
virtual void	print () const
	Print the state of the tool.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

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 std::function< bool(const xAOD::HIEventShape *)>	function_t
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
int	getSubCaloLayer (const std::vector< int > &samps) const
float	getSubCaloEtaMin (const std::vector< int > &samps) const
float	getSubCaloEtaMax (const std::vector< int > &samps) const
float	roundToTenth (float v) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::vector< std::string >	m_samp_names
std::vector< std::string >	m_subcalo_names
bool	m_do_sides {}
std::map< std::string, summary_info_t >	m_summary_list
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

Static Private Attributes
static const std::vector< std::string >	s_SubCaloNames {"EMBarrel", "EMEC", "HEC", "TileBarrel", "TileGap", "TileExt", "FCal", "EMCal", "Tile","HCal", "PreSampler","ALL"}
static const std::vector< std::initializer_list< int > >	s_SubCaloLists

Detailed Description

Definition at line 16 of file HIEventShapeSummaryTool.h.

Member Typedef Documentation

function_t

typedef std::function<bool (const xAOD::HIEventShape*)> HIEventShapeSummaryTool::function_t

private

Definition at line 28 of file HIEventShapeSummaryTool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

HIEventShapeSummaryTool()

HIEventShapeSummaryTool::HIEventShapeSummaryTool

(

const std::string &

n

)

Definition at line 28 of file HIEventShapeSummaryTool.cxx.

                                                                   : asg::AsgTool(n)
{
  declareProperty("Samplings",m_samp_names );
  declareProperty("SubCalos",m_subcalo_names);
  declareProperty("DoPositiveNegativeSides",m_do_sides=false);
 
}

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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; }

dumpList()

std::string HIEventShapeSummaryTool::dumpList ( ) const

overridevirtual

Reimplemented from IHIEventShapeSummaryTool.

Definition at line 155 of file HIEventShapeSummaryTool.cxx.

{
  std::stringstream ss;
  ss << "========= Dumping HIEventShapeSummaryTool ========" << std::endl;
  ss << std::setw(15) << "Name"
     << std::setw(15) << "eta min"
     << std::setw(15) << "eta max"
     << std::setw(15) << "layer"
     << std::endl;
  for(const auto& itr : m_summary_list)
  {
    ss << std::setw(15) << itr.second.name
       << std::setw(15) << itr.second.eta_min
       << std::setw(15) << itr.second.eta_max
       << std::setw(15) << itr.second.layer
       << std::endl;
  }
  return ss.str();
}

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

getSubCaloEtaMax()

float HIEventShapeSummaryTool::getSubCaloEtaMax ( const std::vector< int > & samps ) const

private

Definition at line 137 of file HIEventShapeSummaryTool.cxx.

{
  float max=0.;
  for(const auto i : samps)
  {
    float max_c=HICaloRange::getRange().getRangeMax(i);
    if(max_c > max) max=max_c;
  }
  return max;
}

getSubCaloEtaMin()

float HIEventShapeSummaryTool::getSubCaloEtaMin ( const std::vector< int > & samps ) const

private

Definition at line 126 of file HIEventShapeSummaryTool.cxx.

{
  float min=10;
  for(const auto i : samps)
  {
    float min_c=HICaloRange::getRange().getRangeMin(i);
    if(min_c < min) min=min_c;
  }
  return min;
}

getSubCaloLayer()

int HIEventShapeSummaryTool::getSubCaloLayer ( const std::vector< int > & samps ) const

private

Definition at line 148 of file HIEventShapeSummaryTool.cxx.

{
  int outlayer=0;
  for(const auto i : samps) outlayer |= 0x1 << i;
  return outlayer;
}

initialize()

StatusCode HIEventShapeSummaryTool::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 53 of file HIEventShapeSummaryTool.cxx.

{
  //not optimal, but minimal code re-use, gets called only at initialization
  ATH_MSG_INFO("Configuring for summary");
  for(const auto& s : m_samp_names)
  {
    auto mItr=m_summary_list.find(s);
    if(mItr!=m_summary_list.end()) continue;
    int samp=CaloSampling::getNumberOfSamplings();
    for(unsigned int j=0; j<CaloSampling::getNumberOfSamplings(); j++)
    {
      if(s.compare(CaloSampling::getSamplingName(j))==0)
      {
    samp=j;
    break;
      }
    }
    if(samp == static_cast<int>(CaloSampling::getNumberOfSamplings()))
    {
      ATH_MSG_WARNING("Sampling with name " << s << " not defined in standard list, skipping.");
      break;
    }
    float emin=HICaloRange::getRange().getRangeMin(samp);
    float emax=HICaloRange::getRange().getRangeMax(samp);
    m_summary_list.emplace(s,summary_info_t(s,emin,emax,samp,HI::ByLayer(samp)));
    if(m_do_sides)
    {
      m_summary_list.emplace(s+"_pos",summary_info_t(s+"_pos",emin,emax,samp,HI::ByLayer(samp)));
      m_summary_list.emplace(s+"_neg",summary_info_t(s+"_neg",-emax,-emin,samp,HI::ByLayer(samp)));
    }
  }
 
  for(const auto& s : m_subcalo_names)
  {
    auto mItr=m_summary_list.find(s);
    if(mItr!=m_summary_list.end()) continue;
 
    unsigned int isub=s_SubCaloNames.size();
    for(unsigned int i=0; i < s_SubCaloNames.size(); i++)
    {
      if(s_SubCaloNames.at(i)==s) 
      {
    isub=i;
    break;
      }
    }
 
    if(isub==s_SubCaloNames.size()) 
    {
      ATH_MSG_WARNING("Subcalo with name " << s << " not defined in standard list, skipping." );
      break;
    }
 
 
    const std::vector<int> layer_list=s_SubCaloLists.at(isub);
    int samp=getSubCaloLayer(layer_list);
    float emin=getSubCaloEtaMin(layer_list);
    float emax=getSubCaloEtaMax(layer_list);
 
    m_summary_list.emplace(s,summary_info_t(s,emin,emax,samp,HI::ByLayers(s_SubCaloLists.at(isub))));
    if(m_do_sides)
    {
      m_summary_list.emplace(s+"_pos",summary_info_t(s+"_pos",emin,emax,samp,HI::ByLayersP(s_SubCaloLists.at(isub))));
      m_summary_list.emplace(s+"_neg",summary_info_t(s+"_neg",-emax,-emin,samp,HI::ByLayersN(s_SubCaloLists.at(isub))));
    }
 
  }
 
  ATH_MSG_DEBUG(dumpList());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

roundToTenth()

float HIEventShapeSummaryTool::roundToTenth ( float v ) const

private

Definition at line 175 of file HIEventShapeSummaryTool.cxx.

{
  return std::floor(v*10.)/10.;
}

summarize()

StatusCode HIEventShapeSummaryTool::summarize ( const xAOD::HIEventShapeContainer * in, xAOD::HIEventShapeContainer * out ) const

overridevirtual

Implements IHIEventShapeSummaryTool.

Definition at line 36 of file HIEventShapeSummaryTool.cxx.

{
  out->reserve(m_summary_list.size());
  for(const auto& itr : m_summary_list)
  {
    xAOD::HIEventShape* es=new xAOD::HIEventShape();
    out->push_back(es);
    HI::fillSummary(in,es,itr.second.func);
    es->setEtaMin(roundToTenth(itr.second.eta_min));
    es->setEtaMax(roundToTenth(itr.second.eta_max));
    es->setLayer(itr.second.layer);
    static const SG::Accessor<std::string> SummaryAcc("Summary");
    SummaryAcc(*es)=itr.second.name;
  }
  return StatusCode::SUCCESS;
}

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_do_sides

bool HIEventShapeSummaryTool::m_do_sides {}

private

Definition at line 43 of file HIEventShapeSummaryTool.h.

{};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_samp_names

std::vector<std::string> HIEventShapeSummaryTool::m_samp_names

private

Definition at line 41 of file HIEventShapeSummaryTool.h.

m_subcalo_names

std::vector<std::string> HIEventShapeSummaryTool::m_subcalo_names

private

Definition at line 42 of file HIEventShapeSummaryTool.h.

m_summary_list

std::map<std::string,summary_info_t> HIEventShapeSummaryTool::m_summary_list

private

Definition at line 46 of file HIEventShapeSummaryTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

s_SubCaloLists

const std::vector< std::initializer_list< int > > HIEventShapeSummaryTool::s_SubCaloLists

staticprivate

Initial value:

{HI::SubCalo::Lists::EMBarrel,
    HI::SubCalo::Lists::EMEC,
    HI::SubCalo::Lists::HEC,
    HI::SubCalo::Lists::TileBarrel,
    HI::SubCalo::Lists::TileGap,
    HI::SubCalo::Lists::TileExt,
    HI::SubCalo::Lists::FCal,
    HI::SubCalo::Lists::EMCal,
    HI::SubCalo::Lists::Tile,
    HI::SubCalo::Lists::HCal,
    HI::SubCalo::Lists::PreSampler,
    HI::SubCalo::Lists::ALL}

Definition at line 15 of file HIEventShapeSummaryTool.h.

                              : virtual public asg::AsgTool, virtual public IHIEventShapeSummaryTool
{
    ASG_TOOL_CLASS(HIEventShapeSummaryTool,IHIEventShapeSummaryTool)
  public:
    HIEventShapeSummaryTool(const std::string& n);
 
 
    StatusCode summarize(const xAOD::HIEventShapeContainer* in, xAOD::HIEventShapeContainer* out) const override;
    StatusCode initialize() override;
    std::string dumpList() const override;
 

s_SubCaloNames

const std::vector< std::string > HIEventShapeSummaryTool::s_SubCaloNames {"EMBarrel", "EMEC", "HEC", "TileBarrel", "TileGap", "TileExt", "FCal", "EMCal", "Tile","HCal", "PreSampler","ALL"}

staticprivate

Definition at line 14 of file HIEventShapeSummaryTool.h.

---

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

• HIEventShapeSummaryTool.h
• HIEventShapeSummaryTool.cxx