#include <VertexCaloIsolation.h>

Inheritance diagram for DerivationFramework::VertexCaloIsolation:

Collaboration diagram for DerivationFramework::VertexCaloIsolation:

Public Member Functions
	VertexCaloIsolation (const std::string &t, const std::string &n, const IInterface *p)

StatusCode	initialize ()

StatusCode	finalize ()

StatusCode	addBranches () const
	Pass the thinning service More...

bool	extrapolateTrack (TLorentzVector &extr_tp, const xAOD::IParticle &tp) const

bool	extrapolateMuon (TLorentzVector &extr_tp, const xAOD::CaloCluster *cluster) const

xAOD::TrackParticle &	makeSlyTrack (xAOD::TrackParticle &, const TLorentzVector &candidate, const xAOD::Vertex *vertex, xAOD::BPhysHelper::pv_type vertexType) const

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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods. More...

Protected Member Functions
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
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
ToolHandle< xAOD::ICaloTopoClusterIsolationTool >	m_caloIsoTool

std::string	m_trackContainerName

std::string	m_vertexContainerName

std::string	m_caloClusterContainerName

std::string	m_cellContainerName

std::string	m_muonContainerName

ToolHandle< Trk::IParticleCaloExtensionTool >	m_caloExtTool

std::vector< unsigned int >	m_cones

std::vector< std::string >	m_passFlags

float	m_sigmaCaloNoiseCut
	Number of sigma for calo cell noise cut. More...

int	m_vertexType

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

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

◆ VertexCaloIsolation()

DerivationFramework::VertexCaloIsolation::VertexCaloIsolation	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Definition at line 59 of file VertexCaloIsolation.cxx.

                            : 
     AthAlgTool(t,n,p),
     m_caloIsoTool("xAOD::CaloIsolationTool/CaloIsolationTool"),
     m_trackContainerName("InDetTrackParticles"),
     m_vertexContainerName("NONE"),
     m_caloClusterContainerName("CaloCalTopoClusters"),
     m_muonContainerName("Muons"),
     m_caloExtTool("Trk::ParticleCaloExtensionTool/ParticleCaloExtensionTool"),
     m_cones(),
     m_sigmaCaloNoiseCut(3.4),
     m_vertexType(7)
   {
         ATH_MSG_DEBUG("in constructor");
     declareInterface<DerivationFramework::IAugmentationTool>(this);
     
     // Declare tools                      
     declareProperty("CaloIsoTool" , m_caloIsoTool);
     declareProperty("TrackContainer" , m_trackContainerName);
     declareProperty("InputVertexContainer" , m_vertexContainerName);
     declareProperty("CaloClusterContainer" , m_caloClusterContainerName);
     declareProperty("ParticleCaloExtensionTool",       m_caloExtTool);
     declareProperty("MuonContainer",       m_muonContainerName);
     declareProperty("PassFlags"                 , m_passFlags);
     declareProperty("IsolationTypes"                 , m_cones);
     declareProperty("DoVertexTypes"                 , m_vertexType);
  
  
  
   }

Member Function Documentation

◆ addBranches()

StatusCode DerivationFramework::VertexCaloIsolation::addBranches ( ) const

virtual

Pass the thinning service

Implements DerivationFramework::IAugmentationTool.

Definition at line 130 of file VertexCaloIsolation.cxx.

                                                     {
  
  
       // There is also the "MuonClusterCollection" which may already contain all the muon's clusters
  
     const xAOD::TrackParticleContainer*    idTrackParticleContainer = NULL;
     const xAOD::VertexContainer*  vertexContainer = NULL;
  
     Rec::CaloCellCollector  cellCollector;  //To keep private dependence for this package it is used here
  
  
     const xAOD::MuonContainer* muons = NULL;
  
  
     //Load InDetTrackParticles
     if(evtStore()->contains<xAOD::TrackParticleContainer>(m_trackContainerName)) {
         CHECK( evtStore()->retrieve(idTrackParticleContainer, m_trackContainerName) );
     }
     else{ATH_MSG_ERROR("Failed loading IdTrackparticleContainer container");
         return StatusCode::FAILURE;
     }
  
     //  load vertices
     if(evtStore()->contains<xAOD::VertexContainer>(m_vertexContainerName)) {
         CHECK( evtStore()->retrieve(vertexContainer, m_vertexContainerName) );
     }
     else{ATH_MSG_ERROR("Failed loading vertex container");
         return StatusCode::FAILURE;
     }
  
  
     const xAOD::CaloClusterContainer*  caloClusterContainer = NULL;
     //  load CaloCalTopoClusters
     if(evtStore()->contains<xAOD::CaloClusterContainer>(m_caloClusterContainerName)) {
         CHECK( evtStore()->retrieve(caloClusterContainer, m_caloClusterContainerName) );
     }
     else{ATH_MSG_ERROR("Failed loading vertex container");
         return StatusCode::FAILURE;
     }
  
  
     //Retrieve muon container
     if(evtStore()->contains<xAOD::MuonContainer>(m_muonContainerName)) {
         CHECK( evtStore()->retrieve(muons, m_muonContainerName) );
     }
     else{ATH_MSG_ERROR("Failed loading muon contianer");
         return StatusCode::FAILURE;
     }
  
  
 //-------------------------------------------------
  
     std::vector<xAOD::Iso::IsolationType> cones; cones.resize(m_cones.size());
  
 //    for(unsigned int cone : m_cones)
 //      cones.push_back(xAOD::Iso::IsolationType(cone));
  
     for (unsigned int i =0; i< m_cones.size(); i++)
         cones[i] = xAOD::Iso::IsolationType(m_cones[i]);
  
  
  
     //Loop over vertices
     for(auto vertex : *vertexContainer){
  
       bool passed = false;
       for(std::vector<std::string>::const_iterator flagItr = m_passFlags.begin(); flagItr!=m_passFlags.end(); ++flagItr) {
         SG::AuxElement::Accessor<Char_t> flagAcc(*flagItr);
         if(flagAcc.isAvailable(*vertex) && flagAcc(*vertex) != 0) {
           passed = true;
           break;
         }
       } // end of loop over flags
       if(passed){
         ATH_MSG_DEBUG("Entered loop over vertices");
         if(vertex->trackParticleLinks().size() != 3)ATH_MSG_WARNING("Vertex without 3 tracks, it has "<< vertex->trackParticleLinks().size() <<" instead");
  
         TLorentzVector candidate;
  
         std::set<const xAOD::TrackParticle*> exclusionset;
  
         for(auto part : vertex->trackParticleLinks()){ //Loop over tracks linked to vertex
             candidate += (*part)->p4();
             exclusionset.insert( *part ); //If it crashes use the direct TP from the vertex
         }
  
         //List of corrections: only the pileup correction is applied within the tool
         xAOD::CaloCorrection corrlist;
         corrlist.calobitset.set(static_cast<unsigned int>(xAOD::Iso::pileupCorrection));
  
  
  
         std::vector<const xAOD::Muon*> vtxMuons;
         std::vector<TLorentzVector> extrVtxMuons ;
         std::vector<const xAOD::CaloCluster*> vtxMuonCluster;
  
         std::vector<const xAOD::TrackParticle*> usedVtxTracks;
         //The information whether we are missing some core-corrections in the final isolation value
         map<xAOD::Iso::IsolationType, bool> is_reliable;
  
  
             TLorentzVector muonref;  //Place holder for the extrapolated position
         //Load the caloclusters of the various muons (which you need to load from here)
         const xAOD::MuonContainer* muons = 0;
         CHECK( evtStore()->retrieve( muons, "Muons" ) );
         for ( auto muon : *muons ) {
             //I ask for all information to be fine before filling in an entry (so all containers will have the same -matching- objects)
             if(muon->inDetTrackParticleLink().isValid() &&  exclusionset.find(*muon->inDetTrackParticleLink() ) != exclusionset.end() ){
                const xAOD::CaloCluster* clus = muon->cluster();
                    if(clus && extrapolateMuon(muonref, clus)){
                        // have a muon, an extrapolation and a cluster (hurray)
                        vtxMuonCluster.push_back(clus);
                        vtxMuons.push_back(muon);
                        usedVtxTracks.push_back( *muon->inDetTrackParticleLink() );
                        extrVtxMuons.push_back(muonref);
                    }else{
                      ATH_MSG_DEBUG("Cannot find clusters. Would need a consistent set of Trk::Tracks to run extrapolation.");
  
                        // //If working with the cluster failed, try extrapolating the track
                        // if(extrapolateTrack(muonref, *muon)){ //This does not use the muonic cluster, but uses both its tracks to determine a precise position
                        //      vtxMuonCluster.push_back(clus); //Note clus can also be NULL (for if it's not in the cone there is no point to fret)
                        //      vtxMuons.push_back(muon);
                        //      usedVtxTracks.push_back( *muon->inDetTrackParticleLink() );
                        //      extrVtxMuons.push_back(muonref);
                        //}
                    }
             }
         }
  
  
         //What if there was a track and not a muon??
         //Should be treated like the muon-without-cluster case
  
         if(vtxMuonCluster.size()  !=3){  //remember that some of the ctxMuonCluster elements may be NULL
             ATH_MSG_DEBUG( "Attempt at extrapolating the IDtrack" );
  
             //Attempt extrapolating the IDtrack for the missing cases
             for(const xAOD::TrackParticle* missingTrk : exclusionset){
                 if(std::find(usedVtxTracks.begin(), usedVtxTracks.end(), missingTrk) == usedVtxTracks.end()){
                 if(extrapolateTrack(muonref, *missingTrk)){
                     vtxMuonCluster.push_back(NULL); //Null, for we didn't start from a muon
                     usedVtxTracks.push_back( missingTrk );
                     extrVtxMuons.push_back(muonref);
                 }
             }
             }
  
             //If there are still missing ones values cannot be guaranteed to be reliable
                 if(vtxMuonCluster.size()  !=3){
                         ATH_MSG_DEBUG( "For this vertex there were less than 3 muons found (or extrapolated)" );
                 for(xAOD::Iso::IsolationType isoCone : cones) is_reliable[isoCone] = false;
                     }
         }
         else{
             for(xAOD::Iso::IsolationType isoCone : cones)
                 is_reliable[isoCone] = true;
         }
  
  
         // Adapt this loop!
  
          for(unsigned int vertex_type = 0 ; vertex_type<= xAOD::BPhysHelper::PV_MIN_Z0 ; vertex_type++ ){
  
             if((m_vertexType & (1 << vertex_type ) ) == 0)continue; //Stop if the type of vertex is not required
  
             //This can be in an inside loop
  
             xAOD::BPhysHelper::pv_type this_type = static_cast<xAOD::BPhysHelper::pv_type>( vertex_type );
  
             xAOD::TrackParticle candidate_slyTrack;
             makeSlyTrack(candidate_slyTrack, candidate, vertex, this_type);
  
  
             xAOD::CaloIsolation result;
  
             ATH_MSG_DEBUG("Check if the caloclus container has to be given or not... see line from 755 on of CaloIsolationTool");
  
             bool successful = m_caloIsoTool->caloTopoClusterIsolation(result, candidate_slyTrack, cones, corrlist, caloClusterContainer);
             if( !successful ) {
               ATH_MSG_DEBUG("Calculation of caloTopoClusterIsolation failed");
                  return StatusCode::FAILURE;
             }
  
             // Make the extension to the calorimeter, as it is done inside the other tools...
             TLorentzVector extr_candidate;
             if( !extrapolateTrack(extr_candidate, candidate_slyTrack) ){
                 ATH_MSG_WARNING("Failure extrapolating the slyTrack "<<"pt="<<candidate_slyTrack.pt()<<" eta="<<candidate_slyTrack.eta()<<" phi="<<candidate_slyTrack.phi());
                 ATH_MSG_WARNING("Taking the original coordinates");
             }
  
  
                  std::map<xAOD::Iso::IsolationType,float> coreCorrections;
  
                 //See if this is inside the cone, to determine the correct correction ^^
                 for(xAOD::Iso::IsolationType isoType : cones){
  
                     double conesize = xAOD::Iso::coneSize(isoType);
                     //check what is inside the cone
                     std::vector<xAOD::CaloCluster> clustersInCone;
  
                     for(unsigned int j=0; j < vtxMuonCluster.size(); j++){
                         auto mucluster = vtxMuonCluster[j];
                         // I should use the propagated values here, though the variation is very small, coming from the vertex position
                         float dr=extrVtxMuons[j].DeltaR(extr_candidate);
  
  
  
                         ATH_MSG_DEBUG("Cone size: "<<conesize<<" dr="<<dr);
                         ATH_MSG_DEBUG(extrVtxMuons[j].Eta() <<" - "<<extr_candidate.Eta()<<" and "<<extrVtxMuons[j].Phi() <<" - "<<extr_candidate.Phi());
  
                         if( dr < conesize ){       //This makes a copy, such that I can remove some cells if needed
  
  
                             //here do the check for the cluster, if it should go in, then prevent and set the bad for this cone
                             if(mucluster != NULL) clustersInCone.push_back( xAOD::CaloCluster(*mucluster) );
                             else is_reliable[isoType] = false;
  
  
  
                         }
                     }
  
     //              ATH_MSG_DEBUG("Muon clusters in cone "<<xAOD::Iso::toString(isoType)<<"  "<< clustersInCone.size());
     //              if( msgLvl(MSG::DEBUG) ){
     //                  for(auto muon : vtxMuons)
     //                      if(muon->isAvailable<float>("ET_Core")) ATH_MSG_DEBUG("ET_core stored inside: "<< muon->auxdataConst<float>("ET_Core") );
     //              }
                     //remove eventually doubles in cells
                     if(clustersInCone.size() == 2){
                         for(auto cell : clustersInCone[0]){
                             clustersInCone[1].removeCell(cell);
                         }
                     }
                     if(clustersInCone.size() == 3){
                         for(auto cell : clustersInCone[0]){
                             clustersInCone[1].removeCell(cell);
                             clustersInCone[2].removeCell(cell);
                         }
                         for(auto cell : clustersInCone[1]){
                             clustersInCone[2].removeCell(cell);
                         }
                     }
  
                     //Calculate the core-correction
                     std::vector<float> etcore(4, 0.);
                     float coreCorr=0.;
                     for(auto cl : clustersInCone){
                         if(cl.size() != 0){ //Maybe two muons have a full cluster overlap??
                             ATH_MSG_DEBUG("Cells in this cluster: "<< cl.size());
                                                          
                             cellCollector.collectEtCore( cl, etcore, nullptr, m_sigmaCaloNoiseCut );
                             coreCorr += etcore[Rec::CaloCellCollector::ET_Core];
                             ATH_MSG_DEBUG("Their core-energy: "<< etcore[Rec::CaloCellCollector::ET_Core]);
  
                         }
                     }
  
                     //Store the core-correction
                     coreCorrections[isoType] = coreCorr;
  
                 }
  
                 //For a pion I have no such cone energy, do I? But then I should also see what the original vertex was
                 //If something is not a muon there is no way the calocluster was stored, I think
                 //Would need further study
  
  
             //Collect all the required information
             string ED("_EDcorr");
             string core("_COREcorr");
             string reliable("_isReliable");
  
  
             string vtx_type[3] = {"SumPt", "A0", "Z0"};
  
             string vtx = vtx_type[ vertex_type ];
  
             ATH_MSG_DEBUG("Detailed: ");
             for(unsigned int i=0; i< cones.size(); i++){
                 xAOD::Iso::IsolationType isoType = cones[i];
                 result.etcones[i] -= coreCorrections[isoType];  //Finish correcting the energy
  
  
     //          if(fabs(result.etcones[i]) < 0.1){
     //
     //          ATH_MSG_INFO("Isolation: "<<xAOD::Iso::toString(isoType) ); // The name of the isolation
     //          ATH_MSG_ERROR(result.etcones[i]<<" + "<<(result.noncoreCorrections[xAOD::Iso::pileupCorrection])[i]<<" + "<<coreCorrections[isoType] );
     //          }
  
                 //Here do the decoration (store all, and as well if three muons are found)
  
  
                 string variableName = xAOD::Iso::toString(isoType) + vtx; //I corrected for the closest vertex in A0
                 SG::AuxElement::Decorator<float> isolation(variableName);
                 isolation(*vertex) = result.etcones[i];
  
                 isolation = SG::AuxElement::Decorator<float>(variableName + ED);
                 isolation(*vertex) = (result.noncoreCorrections[xAOD::Iso::pileupCorrection])[i];
  
                 isolation = SG::AuxElement::Decorator<float>(variableName + core);
                 isolation(*vertex) = coreCorrections[isoType];
  
                 //This variable contains the info whether 3 caloclusters have been found in the muons
                 //Future would be to see if their extrapolations are of interest anyhow (if not missing them is no issue)
                 //Fore some reason these seem to become chars (instead of bools) in the output
                 SG::AuxElement::Decorator<bool> reliability(variableName + reliable);
                 reliability(*vertex) = is_reliable[isoType];
  
             }
          } //Loop over primaryVertex choice
  
         //Decorate the candidate with the new information
  
  
 //       return StatusCode::SUCCESS;
 //
 //      ///////////////////////////////////
  
       }
  
 //END OF NEW PART
     }//End of loop over vertices
     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.

95 { 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.

85 { 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.

90 { 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

◆ extrapolateMuon()

bool DerivationFramework::VertexCaloIsolation::extrapolateMuon	(	TLorentzVector &	extr_tp,
		const xAOD::CaloCluster *	cluster
	)		const

Definition at line 499 of file VertexCaloIsolation.cxx.

   {
       //auto cluster = mu->cluster(); //done outside
       if(cluster){
         float etaT = 0, phiT = 0;
         int nSample = 0;
         for(unsigned int i=0; i<CaloSampling::Unknown; i++) // dangerous?
         {
           auto s = static_cast<CaloSampling::CaloSample>(i);
           if(!cluster->hasSampling(s)) continue;
           //ATH_MSG_DEBUG("Sampling: " << i << "eta-phi (" << cluster->etaSample(s) << ", " << cluster->phiSample(s) << ")");
           etaT += cluster->etaSample(s);
           phiT += cluster->phiSample(s);
           nSample++;
         }
         if(nSample>0){
  
             extr_tp.SetPtEtaPhiE(1., etaT/nSample, phiT/nSample, 10.); //Using the three-vector constructor
             return true ;
  
         }else{
           ATH_MSG_WARNING("Muon calo cluster is empty????");
           return false;
         }
       }else{
         ATH_MSG_WARNING("Muon calo cluster not found. Calo extension can not be obtained!!!");
         return false;
       }
    }

◆ extrapolateTrack()

bool DerivationFramework::VertexCaloIsolation::extrapolateTrack	(	TLorentzVector &	extr_tp,
		const xAOD::IParticle &	tp
	)		const

Definition at line 458 of file VertexCaloIsolation.cxx.

                                                                                                   {
     extr_tp = tp.p4(); //Pre-set the output TLorentzVector to the input's 4-momentum
     ATH_MSG_ERROR("VertexCaloIsolation::extrapolateTrack needs to be rewritten because of changes to the caloExtension");
     throw std::runtime_error("VertexCaloIsolation::extrapolateTrack needs to be rewritten because of changes to the caloExtension");
 /*
         
  
         const Trk::CaloExtension* caloExtension = 0;
         if(!m_caloExtTool->caloExtension(tp,caloExtension)){
           ATH_MSG_WARNING("Can not get caloExtension.");
           return false;
         }
  
         const std::vector<const Trk::CurvilinearParameters*>& intersections = caloExtension->caloLayerIntersections();
         if (intersections.size()>0) {
             Amg::Vector3D avePoint(0,0,0);
             for (unsigned int i = 0; i < intersections.size(); ++i){
               const Amg::Vector3D& point = intersections[i]->position();
               avePoint += point;
             }
             avePoint = (1./intersections.size())*avePoint;
  
  
             extr_tp.SetPtEtaPhiE(1., avePoint.eta(), avePoint.phi(), 10.); //Using the three-vector constructor
             //eta = avePoint.eta();
             //phi = avePoint.phi();
             ATH_MSG_DEBUG("Successfully extrapolated candidate eta/phi : "<<tp.eta()<<"/"<<tp.phi()<<" --> "<< extr_tp.Eta()<<"/"<<extr_tp.Phi());
  
           }
         else{   //This is very unlikely, it happens if a few cases in MC
             ATH_MSG_WARNING("Candidate extrapolation failed. Keeping track's eta/phi values");
             return false;
  
         }
  
       return true;
 */
  
   }

◆ finalize()

StatusCode DerivationFramework::VertexCaloIsolation::finalize ( )

Definition at line 122 of file VertexCaloIsolation.cxx.

   {
     // everything all right
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode DerivationFramework::VertexCaloIsolation::initialize ( )

Definition at line 93 of file VertexCaloIsolation.cxx.

   {
   
     ATH_MSG_DEBUG("in initialize()");
  
     // retrieve CaloIsolationTool
     CHECK( m_caloIsoTool.retrieve() );
     
     // retrieve CaloIsolationTool
     CHECK( m_caloExtTool.retrieve() );
  
     //Check that flags were given to tag the correct vertices
     if(m_passFlags.empty()){
         ATH_MSG_WARNING("As no pass-flags are given, no vertices will be decorated");
     }
  
     // Control the IsolationType sequence
     if(m_cones.empty()){
         m_cones.push_back(xAOD::Iso::etcone40);
         m_cones.push_back(xAOD::Iso::etcone30);
         m_cones.push_back(xAOD::Iso::etcone20);
     }
  
     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.

◆ interfaceID()

static const InterfaceID& DerivationFramework::IAugmentationTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 31 of file IAugmentationTool.h.

31 { return IID_IAugmentationTool; }

◆ makeSlyTrack()

xAOD::TrackParticle & DerivationFramework::VertexCaloIsolation::makeSlyTrack	(	xAOD::TrackParticle &	candidate_slyTrack,
		const TLorentzVector &	candidate,
		const xAOD::Vertex *	vertex,
		xAOD::BPhysHelper::pv_type	vertexType
	)		const

Definition at line 530 of file VertexCaloIsolation.cxx.

                                                                                                                                                                                                  {
  
         candidate_slyTrack.makePrivateStore();
         candidate_slyTrack.setDefiningParameters(0, 0., candidate.Phi(), candidate.Theta(), 0. );  // avoided q/p = 1./candidate.P()
  
         //I should set the correct d0 and z0, while setting momentum to enormous, to obtain a straight line
         //I fear that q/p == 0 might cause some divide by 0, though.
  
         //Somewhere this information will be checked, so I need to provide it
         SG::AuxElement::Decorator<uint8_t> hypothesis("particleHypothesis");
         hypothesis(candidate_slyTrack) = xAOD::undefined;  //Value 99 as none of the common types (muon, pion, kaon, etc.)
         SG::AuxElement::Decorator<std::vector<float> > covmat( "definingParametersCovMatrix" );
         covmat(candidate_slyTrack) = std::vector<float>(25, 0.); // I am saying that there are no errors on my parameters
         //The precision goes down a bit, but it's a matter of 10e-7 with our values of interest
  
         xAOD::BPhysHelper vertex_h(vertex); //Use the BPhysHelper to access vertex quantities
  
         SG::AuxElement::Decorator<float> vx( "vx" );
         vx(candidate_slyTrack) = vertex_h.pv(vertexType)->x();
  
         SG::AuxElement::Decorator<float> vy( "vy" );
         vy(candidate_slyTrack) = vertex_h.pv(vertexType)->y();
  
         SG::AuxElement::Decorator<float> vz( "vz" );
         vz(candidate_slyTrack) = vertex_h.pv(vertexType)->z();
         //The precision goes down a bit, but it's a matter of 10e-7 with our values of interest
  
         return candidate_slyTrack;
  
  
   }

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

◆ 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.

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

◆ 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.

◆ 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_caloClusterContainerName

std::string DerivationFramework::VertexCaloIsolation::m_caloClusterContainerName

private

Definition at line 66 of file VertexCaloIsolation.h.

◆ m_caloExtTool

ToolHandle<Trk::IParticleCaloExtensionTool> DerivationFramework::VertexCaloIsolation::m_caloExtTool

private

Definition at line 69 of file VertexCaloIsolation.h.

◆ m_caloIsoTool

ToolHandle<xAOD::ICaloTopoClusterIsolationTool> DerivationFramework::VertexCaloIsolation::m_caloIsoTool

private

Definition at line 63 of file VertexCaloIsolation.h.

◆ m_cellContainerName

std::string DerivationFramework::VertexCaloIsolation::m_cellContainerName

private

Definition at line 67 of file VertexCaloIsolation.h.

◆ m_cones

std::vector<unsigned int> DerivationFramework::VertexCaloIsolation::m_cones

private

Definition at line 70 of file VertexCaloIsolation.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_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_muonContainerName

std::string DerivationFramework::VertexCaloIsolation::m_muonContainerName

private

Definition at line 68 of file VertexCaloIsolation.h.

◆ m_passFlags

std::vector<std::string> DerivationFramework::VertexCaloIsolation::m_passFlags

private

Definition at line 71 of file VertexCaloIsolation.h.

◆ m_sigmaCaloNoiseCut

float DerivationFramework::VertexCaloIsolation::m_sigmaCaloNoiseCut

private

Number of sigma for calo cell noise cut.

Definition at line 75 of file VertexCaloIsolation.h.

◆ m_trackContainerName

std::string DerivationFramework::VertexCaloIsolation::m_trackContainerName

private

Definition at line 64 of file VertexCaloIsolation.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainerName

std::string DerivationFramework::VertexCaloIsolation::m_vertexContainerName

private

Definition at line 65 of file VertexCaloIsolation.h.

◆ m_vertexType

int DerivationFramework::VertexCaloIsolation::m_vertexType

private

Definition at line 77 of file VertexCaloIsolation.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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ VertexCaloIsolation()

Member Function Documentation

◆ addBranches()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ extrapolateMuon()

◆ extrapolateTrack()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ makeSlyTrack()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_caloClusterContainerName

◆ m_caloExtTool

◆ m_caloIsoTool

◆ m_cellContainerName

◆ m_cones

◆ m_detStore

◆ m_evtStore

◆ m_muonContainerName

◆ m_passFlags

◆ m_sigmaCaloNoiseCut

◆ m_trackContainerName

◆ m_varHandleArraysDeclared

◆ m_vertexContainerName

◆ m_vertexType

◆ m_vhka