HIJetClusterSubtractorTool Class Reference

Concrete implementation of HIJetSubtractorToolBase. Class used by HIClusterSubtraction and HIJetConstituentSubtractionTool to provide kinematics of a cluster after subtraction given an event shape. This version of the tool does not use the cell information and thus should be faster than HIJetCellSubtractorTool. More...

#include <HIJetClusterSubtractorTool.h>

Inheritance diagram for HIJetClusterSubtractorTool:

Collaboration diagram for HIJetClusterSubtractorTool:

Public Member Functions
	HIJetClusterSubtractorTool (const std::string &myname)
	Implements method defined in base First argument is reference to four vector that is updated to reflect the subtracted kinematics of the IParticle passed in the second arg Method expects cl_in to be a cluster. More...
virtual void	subtract (xAOD::IParticle::FourMom_t &, const xAOD::IParticle *, const xAOD::HIEventShapeContainer *, const HIEventShapeIndex *, const ToolHandle< IHIUEModulatorTool > &, const xAOD::HIEventShape *eshape) const override
	Abstract method where particle itself is not modified IParticle::FourMom_t containing kinematics after subtraction is passed by reference. More...
virtual void	subtractWithMoments (xAOD::CaloCluster *, const xAOD::HIEventShapeContainer *, const HIEventShapeIndex *index, const ToolHandle< IHIUEModulatorTool > &, const xAOD::HIEventShape *eshape) const override
virtual void	updateUsingCluster (xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const xAOD::CaloCluster *cl) const override
	Method to update the shape based on a given cluster two sets of indices are passed by reference and updated by the method sets are queried to see if the cluster has already been used, e.g. More...
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...
virtual StatusCode	initializeTool ()
float	minEnergyForMoments () const
float	minEnergySigForMoments () const
bool	usesCells () const
const xAOD::HIEventShapeContainer *	getShape () const
const HIEventShapeIndex *	getIndex () const
const IHIUEModulatorTool *	getModulator () const
void	setShape (const xAOD::HIEventShapeContainer *s)
void	setIndex (const HIEventShapeIndex *ind)
void	setModulator (const IHIUEModulatorTool *mod)
virtual StatusCode	configureEvent (const xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const IHIUEModulatorTool *modulator)
virtual void	print () const
	Print the state of the tool. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	setMinEnergyForMoment (float min_E)
void	setUpdateClusters (bool up)
bool	UpdateClusters () const
void	setSubtractedEtaPhi (float E, float &eta, float &phi, float eta0, float phi0, float sig) const
void	setUseCells (bool v)
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	ASG_TOOL_CLASS (HIJetClusterSubtractorTool, IHISubtractorTool)
float	getWeight (float eta, float phi, int sample) const
float	getWeightEta (float eta, float phi, int sample) const
float	getWeightPhi (float eta, float phi, int sample) const
void	updateSlice (xAOD::HIEventShape *slice, float ET, float phi0, float area_cluster) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
bool	m_init
Gaudi::Property< std::string >	m_inputFile { this, "InputFile", "cluster.geo.HIJING_2018.root", "File containing cluster geometric moments." }
Gaudi::Property< std::string >	m_configDir { this, "ConfigDir", "HIJetCorrection/", "Directory containing configuration file." }
TH3F *	m_h3W
TH3F *	m_h3Eta
TH3F *	m_h3Phi
Gaudi::Property< bool >	m_useSamplings { this, "UseSamplings", true, "Boolean for samplings use" }
Gaudi::Property< float >	m_EminMoment { this, "MinimumEnergyForMoments", 50., "> E, cluster given tower coordinates" }
Gaudi::Property< float >	m_EsigMoment { this, "MinimumSignificanceForMoments", 0.1, "if E after subtr / E total < this cut, cluster given tower coordinates" }
Gaudi::Property< bool >	m_updateClusters { this, "UpdateClusters", false, "If true set cluster kinematics to reflect subtraction" }
Gaudi::Property< bool >	m_useCells { this, "UseCells", true, "Boolean switch for cells usage" }
const xAOD::HIEventShapeContainer *	m_shape
const HIEventShapeIndex *	m_index
const IHIUEModulatorTool *	m_modulator
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Concrete implementation of HIJetSubtractorToolBase. Class used by HIClusterSubtraction and HIJetConstituentSubtractionTool to provide kinematics of a cluster after subtraction given an event shape. This version of the tool does not use the cell information and thus should be faster than HIJetCellSubtractorTool.

Author

Aaron Angerami anger.nosp@m.ami@.nosp@m.cern..nosp@m.ch

Date

Jan, 2015

Definition at line 31 of file HIJetClusterSubtractorTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

HIJetClusterSubtractorTool()

HIJetClusterSubtractorTool::HIJetClusterSubtractorTool

(

const std::string &

myname

)

Implements method defined in base First argument is reference to four vector that is updated to reflect the subtracted kinematics of the IParticle passed in the second arg Method expects cl_in to be a cluster.

Definition at line 17 of file HIJetClusterSubtractorTool.cxx.

                                                                              : HIJetSubtractorToolBase(myname),
                                            m_init(false),
                                            m_h3W(nullptr),
                                            m_h3Eta(nullptr),
                                            m_h3Phi(nullptr),
                                            m_useSamplings(true)
{
    declareProperty("UseSamplings",m_useSamplings=true);
  setUseCells(false);
}

Member Function Documentation

ASG_TOOL_CLASS()

HIJetClusterSubtractorTool::ASG_TOOL_CLASS ( HIJetClusterSubtractorTool  , IHISubtractorTool    )

private

configureEvent()

StatusCode HIJetSubtractorToolBase::configureEvent ( const xAOD::HIEventShapeContainer *  shape, const HIEventShapeIndex *  index, const IHIUEModulatorTool *  modulator  )

virtualinherited

Definition at line 40 of file HIJetSubtractorToolBase.cxx.

{
  setShape(shape);
  setIndex(index);
  setModulator(modulator);
  return StatusCode::SUCCESS;
 
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

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

evtStore() [1/2]

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

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

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

Definition at line 90 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

getIndex()

const HIEventShapeIndex* HIJetSubtractorToolBase::getIndex ( ) const

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 36 of file HIJetSubtractorToolBase.h.

{return m_index;};

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
   }

getModulator()

const IHIUEModulatorTool* HIJetSubtractorToolBase::getModulator ( ) const

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 37 of file HIJetSubtractorToolBase.h.

{return m_modulator;};

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.

getShape()

const xAOD::HIEventShapeContainer* HIJetSubtractorToolBase::getShape ( ) const

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 35 of file HIJetSubtractorToolBase.h.

{return m_shape;};

getWeight()

float HIJetClusterSubtractorTool::getWeight ( float  eta, float  phi, int  sample  ) const

private

Definition at line 224 of file HIJetClusterSubtractorTool.cxx.

{
  return m_h3W->GetBinContent(m_h3W->FindFixBin(eta,phi,sample));
}

getWeightEta()

float HIJetClusterSubtractorTool::getWeightEta ( float  eta, float  phi, int  sample  ) const

private

Definition at line 228 of file HIJetClusterSubtractorTool.cxx.

{
  return m_h3Eta->GetBinContent(m_h3Eta->FindFixBin(eta,phi,sample));
}

getWeightPhi()

float HIJetClusterSubtractorTool::getWeightPhi ( float  eta, float  phi, int  sample  ) const

private

Definition at line 232 of file HIJetClusterSubtractorTool.cxx.

{
  return m_h3Phi->GetBinContent(m_h3Phi->FindFixBin(eta,phi,sample));
}

initialize()

StatusCode HIJetClusterSubtractorTool::initialize ( )

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 217 of file HIJetClusterSubtractorTool.cxx.

{
  return initializeTool();
 
}

initializeTool()

StatusCode HIJetClusterSubtractorTool::initializeTool ( )

virtual

Definition at line 171 of file HIJetClusterSubtractorTool.cxx.

{
  if(m_useSamplings)
  {
    std::string local_path=static_cast<std::string>(m_configDir)+m_inputFile;
    std::string full_path=PathResolverFindCalibFile(local_path);
    ATH_MSG_INFO("Reading input file "<< m_inputFile << " from " << full_path);
    TFile* f=TFile::Open(full_path.c_str());
    if(f==nullptr)
    {
      ATH_MSG_FATAL("Cannot read config file " << full_path );
      return StatusCode::FAILURE;
    }
 
    m_h3W=(TH3F*)f->GetObjectChecked("h3_w","TH3F");
    if(m_h3W==nullptr)
    {
      ATH_MSG_FATAL("Cannot find TH3F m_h3W in config file " << full_path );
      return StatusCode::FAILURE;
    }
 
    m_h3Eta=(TH3F*)f->GetObjectChecked("h3_eta","TH3F");
    if(m_h3Eta==nullptr)
    {
      ATH_MSG_FATAL("Cannot find TH3F m_h3Eta in config file " << full_path );
      return StatusCode::FAILURE;
    }
 
    m_h3Phi=(TH3F*)f->GetObjectChecked("h3_phi","TH3F");
    if(m_h3Phi==nullptr)
    {
      ATH_MSG_FATAL("Cannot find TH3F m_h3Phi in config file " << full_path );
      return StatusCode::FAILURE;
    }
    m_h3W->SetDirectory(0);
    m_h3Eta->SetDirectory(0);
    m_h3Phi->SetDirectory(0);
 
    f->Close();
  }
  m_init=true;
  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.

minEnergyForMoments()

float HIJetSubtractorToolBase::minEnergyForMoments ( ) const

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 30 of file HIJetSubtractorToolBase.h.

{return m_EminMoment;};

minEnergySigForMoments()

float HIJetSubtractorToolBase::minEnergySigForMoments ( ) const

inlineinherited

Definition at line 31 of file HIJetSubtractorToolBase.h.

{return m_EsigMoment;};

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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 JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, top::TopObjectSelection, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

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

setIndex()

void HIJetSubtractorToolBase::setIndex ( const HIEventShapeIndex *  ind )

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 39 of file HIJetSubtractorToolBase.h.

{m_index=ind;};

setMinEnergyForMoment()

void HIJetSubtractorToolBase::setMinEnergyForMoment ( float  min_E )

inlineprotectedinherited

Definition at line 57 of file HIJetSubtractorToolBase.h.

{ m_EminMoment=min_E; };

setModulator()

void HIJetSubtractorToolBase::setModulator ( const IHIUEModulatorTool *  mod )

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 40 of file HIJetSubtractorToolBase.h.

{m_modulator=mod;};

setShape()

void HIJetSubtractorToolBase::setShape ( const xAOD::HIEventShapeContainer *  s )

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 38 of file HIJetSubtractorToolBase.h.

{m_shape=s;};

setSubtractedEtaPhi()

void HIJetSubtractorToolBase::setSubtractedEtaPhi ( float  E, float &  eta, float &  phi, float  eta0, float  phi0, float  sig  ) const

protectedinherited

Definition at line 24 of file HIJetSubtractorToolBase.cxx.

{
  phi=TVector2::Phi_mpi_pi(phi);
  if(!HIJetRec::inTowerBoundary(eta0,phi0,eta,phi))
  {
    eta=eta0;
    phi=phi0;
  }
  else if( E < minEnergyForMoments() || ( (sig > 0) && sig < minEnergySigForMoments() ) )
  {
    eta=eta0;
    phi=phi0;
  }
 
}

setUpdateClusters()

void HIJetSubtractorToolBase::setUpdateClusters ( bool  up )

inlineprotectedinherited

Definition at line 58 of file HIJetSubtractorToolBase.h.

{ m_updateClusters=up; };

setUseCells()

void HIJetSubtractorToolBase::setUseCells ( bool  v )

inlineprotectedinherited

Definition at line 64 of file HIJetSubtractorToolBase.h.

{m_useCells=v;};

subtract()

void HIJetClusterSubtractorTool::subtract ( xAOD::IParticle::FourMom_t &  , const xAOD::IParticle *  , const xAOD::HIEventShapeContainer *  , const HIEventShapeIndex *  , const ToolHandle< IHIUEModulatorTool > &  , const xAOD::HIEventShape *  shape  ) const

overridevirtual

Abstract method where particle itself is not modified IParticle::FourMom_t containing kinematics after subtraction is passed by reference.

Implements IHISubtractorTool.

Definition at line 28 of file HIJetClusterSubtractorTool.cxx.

{
 
  const xAOD::CaloCluster* cl=static_cast<const xAOD::CaloCluster*>(cl_in);
  float E_unsubtr=cl->e(HIJetRec::unsubtractedClusterState());
  float eta_unsubtr=cl->eta(HIJetRec::unsubtractedClusterState());
  float phi_unsubtr=cl->phi(HIJetRec::unsubtractedClusterState());
 
  float E_subtr=0;
  float E_eta_subtr=0;
  float E_phi_subtr=0;
  const float eta0=cl->eta0();
  const float phi0=cl->phi0();
  float mod=1;
  if(modulator) mod=modulator->getModulation(phi0, eshape);
 
  float energy=E_unsubtr;
  float eta=eta0;
  float phi=phi0;
 
  static const SG::ConstAccessor<float> HIEtaPhiWeightAcc("HIEtaPhiWeight");
  if(HIEtaPhiWeightAcc.isAvailable(*cl))
  {
    float DF_weight=HIEtaPhiWeightAcc(*cl);
    if(DF_weight!=0.) mod/=DF_weight;
  }
 
  if(shape==nullptr)
  {
    ATH_MSG_ERROR("No HIEventShape supplied, cannot do subtraction");
    return;
  }
 
  if(m_useSamplings)
  {
    if(index==nullptr)
    {
      ATH_MSG_ERROR("No HIEventShapeIndex supplied, cannot do subtraction");
      return;
    }
 
    for(unsigned int sample=0; sample<24; sample++)
    {
      CaloSampling::CaloSample s=static_cast<CaloSampling::CaloSample>(sample);
      if(!cl->hasSampling(s)) continue;
 
      float nCells=index->getShape(eta0,sample,shape)->nCells();
      float rho=0;
      if(nCells!=0.) rho=index->getShape(eta0,sample,shape)->rho()/nCells;
      rho*=mod*std::cosh(eta0);
 
      E_subtr+=rho*getWeight(eta0,phi0,sample);
      E_eta_subtr+=rho*getWeightEta(eta0,phi0,sample);
      E_phi_subtr+=rho*getWeightPhi(eta0,phi0,sample);
    }
 
    energy=E_unsubtr-E_subtr;
    if(energy!=0.)
    {
      eta=eta_unsubtr+(eta_unsubtr*E_subtr-E_eta_subtr)/energy;
      phi=phi_unsubtr+(phi_unsubtr*E_subtr-E_phi_subtr)/energy;
    }
    setSubtractedEtaPhi(energy,eta,phi,eta0,phi0,energy/E_subtr);
  }
  else
  {
    unsigned int es_bin=HI::TowerBins::findBinEta(eta0);
 
    float area=shape->at(es_bin)->area();
    float rho=(area==0.) ? 0. : shape->at(es_bin)->et()/area;
 
    rho*=mod*std::cosh(eta0);
    E_subtr=rho*HI::TowerBins::getBinArea();
    energy=E_unsubtr-E_subtr;
    eta=eta_unsubtr;
    phi=phi_unsubtr;
 
    ATH_MSG_VERBOSE("Subtracting"
            << std::setw(8) << eta0
            << std::setw(8) << phi0
            << std::setw(10) << std::setprecision(3) << modulator->getModulation(phi0, eshape)
            << std::setw(10) << std::setprecision(3) << mod
            << std::setw(10) << std::setprecision(3) << modulator->getModulation(phi0, eshape)/mod
            << std::setw(10) << std::setprecision(3) << area
            << std::setw(10) << std::setprecision(3) << rho*area
            << std::setw(10) << std::setprecision(3) << E_unsubtr*1e-3
            << std::setw(10) << std::setprecision(3) << E_subtr*1e-3
            << std::setw(10) << std::setprecision(3) << E_unsubtr*1e-3/std::cosh(eta0)
            << std::setw(10) << std::setprecision(3) << E_subtr*1e-3/std::cosh(eta0));
 
 
 
 
  }
  float ET=energy/std::cosh(eta);
  subtr_mom.SetPxPyPzE(ET*std::cos(phi),ET*std::sin(phi),ET*std::sinh(eta),energy);
}

subtractWithMoments()

void HIJetClusterSubtractorTool::subtractWithMoments ( xAOD::CaloCluster *  cl, const xAOD::HIEventShapeContainer *  shape, const HIEventShapeIndex *  index, const ToolHandle< IHIUEModulatorTool > &  modulator, const xAOD::HIEventShape *  eshape  ) const

overridevirtual

Implements IHISubtractorTool.

Definition at line 164 of file HIJetClusterSubtractorTool.cxx.

{
  xAOD::IParticle::FourMom_t subtr_mom;
  subtract(subtr_mom, cl, shape, index, modulator, eshape);
  HIJetRec::setClusterP4(subtr_mom,cl,HIJetRec::subtractedClusterState());
}

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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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.

UpdateClusters()

bool HIJetSubtractorToolBase::UpdateClusters ( ) const

inlineprotectedinherited

Definition at line 60 of file HIJetSubtractorToolBase.h.

{ return m_updateClusters; };

updateSlice()

void HIJetClusterSubtractorTool::updateSlice ( xAOD::HIEventShape *  slice, float  ET, float  phi0, float  area_cluster  ) const

private

Definition at line 237 of file HIJetClusterSubtractorTool.cxx.

{
  if(area_cluster==0.)
  {
    area_cluster=1.;
 
    if(ET==0.)
    {
      ATH_MSG_INFO("Provided cluster area was 0, check if the input file " << m_inputFile << " from " << PathResolverFindCalibFile(static_cast<std::string>(m_configDir)+m_inputFile) << " was generated with the currently used geometry. See ATLHI-472");
    }
    else
    {
      ATH_MSG_ERROR("Provided cluster area was 0, the HIEventShape will be incorrect! Check if the input file " << m_inputFile << " from " << PathResolverFindCalibFile(static_cast<std::string>(m_configDir)+m_inputFile) << " was generated with the currently used geometry. See ATLHI-472");
    }
  }
  
  float area_slice=slice->area();
  float area_sf=1.;
 
  if(area_slice!=0.) area_sf-=area_cluster/area_slice;
  slice->setNCells( std::floor(area_sf*slice->nCells()) );
  slice->setEt(slice->et()-ET);
  slice->setArea(area_slice-area_cluster);
 
  slice->setRho(slice->rho() - ET/area_cluster);
 
 
  for(unsigned int ih=0; ih<slice->etCos().size(); ih++)
  {
    float ih_f=ih+1;
    float tmp_cos = slice->etCos().at(ih);
    slice->etCos()[ih] = tmp_cos + cos(ih_f*phi0)*ET;
 
    float tmp_sin = slice->etSin().at(ih);
    slice->etSin()[ih] = tmp_sin + sin(ih_f*phi0)*ET;
  }
}

updateUsingCluster()

void HIJetClusterSubtractorTool::updateUsingCluster ( xAOD::HIEventShapeContainer *  shape, const HIEventShapeIndex *  index, const xAOD::CaloCluster *  cl  ) const

overridevirtual

Method to update the shape based on a given cluster two sets of indices are passed by reference and updated by the method sets are queried to see if the cluster has already been used, e.g.

by another jet seed checking/updating sets prevents double counting eta-bin set used to determine eta-averaged flow

Implements IHISubtractorTool.

Definition at line 126 of file HIJetClusterSubtractorTool.cxx.

{
 
  float eta0=cl->eta0();
  float phi0=cl->phi0();
 
  if(m_useSamplings)
  {
    for(unsigned int sample=0; sample<24; sample++)
    {
      CaloSampling::CaloSample s=static_cast<CaloSampling::CaloSample>(sample);
      if(!cl->hasSampling(s)) continue;
      float esamp=cl->eSample(s);
      float ET=esamp/std::cosh(eta0);
      xAOD::HIEventShape* slice=shape->at(index->getIndex(eta0,sample));
      float area_cluster=getWeight(eta0,phi0,sample);
      //update members
      updateSlice(slice,ET,phi0,area_cluster);
    }
  }
  else
  {
    unsigned int es_bin=HI::TowerBins::findBinEta(eta0);
    xAOD::HIEventShape* slice=shape->at(es_bin);
    constexpr float area_cluster=HI::TowerBins::getBinArea();
    float ET=cl->e(HIJetRec::unsubtractedClusterState())/std::cosh(eta0);
    static const SG::ConstAccessor<float> HIEtaPhiWeightAcc("HIEtaPhiWeight");
    if(HIEtaPhiWeightAcc.isAvailable(*cl))
    {
      float HI_weight=HIEtaPhiWeightAcc(*cl);
      ET*=HI_weight;
    }
    //update members
    updateSlice(slice,ET,phi0,area_cluster);
  }
}

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

usesCells()

bool HIJetSubtractorToolBase::usesCells ( ) const

inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 32 of file HIJetSubtractorToolBase.h.

{return m_useCells;};

Member Data Documentation

m_configDir

Gaudi::Property< std::string > HIJetClusterSubtractorTool::m_configDir { this, "ConfigDir", "HIJetCorrection/", "Directory containing configuration file." }

private

Definition at line 62 of file HIJetClusterSubtractorTool.h.

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_EminMoment

Gaudi::Property< float > HIJetSubtractorToolBase::m_EminMoment { this, "MinimumEnergyForMoments", 50., "> E, cluster given tower coordinates" }

privateinherited

Definition at line 46 of file HIJetSubtractorToolBase.h.

m_EsigMoment

Gaudi::Property< float > HIJetSubtractorToolBase::m_EsigMoment { this, "MinimumSignificanceForMoments", 0.1, "if E after subtr / E total < this cut, cluster given tower coordinates" }

privateinherited

Definition at line 47 of file HIJetSubtractorToolBase.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_h3Eta

TH3F* HIJetClusterSubtractorTool::m_h3Eta

private

Definition at line 65 of file HIJetClusterSubtractorTool.h.

m_h3Phi

TH3F* HIJetClusterSubtractorTool::m_h3Phi

private

Definition at line 66 of file HIJetClusterSubtractorTool.h.

m_h3W

TH3F* HIJetClusterSubtractorTool::m_h3W

private

Definition at line 64 of file HIJetClusterSubtractorTool.h.

m_index

const HIEventShapeIndex* HIJetSubtractorToolBase::m_index

privateinherited

Definition at line 52 of file HIJetSubtractorToolBase.h.

m_init

bool HIJetClusterSubtractorTool::m_init

private

Definition at line 53 of file HIJetClusterSubtractorTool.h.

m_inputFile

Gaudi::Property< std::string > HIJetClusterSubtractorTool::m_inputFile { this, "InputFile", "cluster.geo.HIJING_2018.root", "File containing cluster geometric moments." }

private

Definition at line 60 of file HIJetClusterSubtractorTool.h.

m_modulator

const IHIUEModulatorTool* HIJetSubtractorToolBase::m_modulator

privateinherited

Definition at line 53 of file HIJetSubtractorToolBase.h.

m_shape

const xAOD::HIEventShapeContainer* HIJetSubtractorToolBase::m_shape

privateinherited

Definition at line 51 of file HIJetSubtractorToolBase.h.

m_updateClusters

Gaudi::Property< bool > HIJetSubtractorToolBase::m_updateClusters { this, "UpdateClusters", false, "If true set cluster kinematics to reflect subtraction" }

privateinherited

Definition at line 48 of file HIJetSubtractorToolBase.h.

m_useCells

Gaudi::Property< bool > HIJetSubtractorToolBase::m_useCells { this, "UseCells", true, "Boolean switch for cells usage" }

privateinherited

Definition at line 49 of file HIJetSubtractorToolBase.h.

m_useSamplings

Gaudi::Property< bool > HIJetClusterSubtractorTool::m_useSamplings { this, "UseSamplings", true, "Boolean for samplings use" }

private

Definition at line 68 of file HIJetClusterSubtractorTool.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.

---

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

• HIJetClusterSubtractorTool.h
• HIJetClusterSubtractorTool.cxx