Merge branch 'xAODCaloEvent_setSignalState_nonConst' into 'master'

Make Calo Cluster setSignalState non const: ATLASRECTS-4598

See merge request atlas/athena!14465

Event/xAOD/xAODCaloEvent/Root/CaloClusterChangeSignalState.cxx

@@ -5,7 +5,7 @@
 
 #include "xAODCaloEvent/CaloClusterChangeSignalState.h"
 
-CaloClusterChangeSignalState::CaloClusterChangeSignalState (const xAOD::CaloCluster* pClus, xAOD::CaloCluster::State s): 
+CaloClusterChangeSignalState::CaloClusterChangeSignalState (xAOD::CaloCluster* pClus, xAOD::CaloCluster::State s): 
   m_clus (pClus),
   m_oldstate (pClus->signalState())
 {
@@ -14,7 +14,7 @@ CaloClusterChangeSignalState::CaloClusterChangeSignalState (const xAOD::CaloClus
 }
 
 #if __cplusplus < 201100
-void CaloClusterChangeSignalState::init (const xAOD::CaloCluster* pClus, xAOD::CaloCluster::State s) {
+void CaloClusterChangeSignalState::init (xAOD::CaloCluster* pClus, xAOD::CaloCluster::State s) {
   m_clus=pClus;
   m_oldstate=pClus->signalState();
   pClus->setSignalState(s);

Event/xAOD/xAODCaloEvent/Root/CaloCluster_v1.cxx

@@ -177,7 +177,7 @@ namespace xAOD {
     } else {
       p = std::sqrt( theE * theE - theM * theM );
       if( theE < 0 ) {
-	p = -p;
+        p = -p;
       }
     }
 
@@ -213,8 +213,6 @@ namespace xAOD {
     }
   }
 
-
-
   /**
    * @brief Return eta for a specific signal state.
    * @param s The desired signal state.
@@ -257,12 +255,49 @@ namespace xAOD {
       return -999;
     }
   }
-
+   /**
+   * @brief Return m for a specific signal state.
+   * @param s The desired signal state.
+   */
+ double CaloCluster_v1::m(const State s) const {
+    switch (s) {
+    case CALIBRATED:
+      return calM();
+      break;
+    case UNCALIBRATED:
+      return rawM();
+      break;
+    case ALTCALIBRATED:
+      return altM();
+      break;
+    default:
+      return -999;
+      }
+   }
+ 
 
   double CaloCluster_v1::pt() const {
     return pt(m_signalState);
   }
 
+  double CaloCluster_v1::eta() const
+  {
+    return eta (m_signalState);
+  }
+  
+  double CaloCluster_v1::phi() const
+  {
+    return phi (m_signalState);
+  }
+
+  double CaloCluster_v1::m() const {
+    return m(m_signalState);
+   }
+  
+   double CaloCluster_v1::e() const {
+    return e(m_signalState);
+   }
+
 
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( CaloCluster_v1, CaloCluster_v1::flt_t,  eta0, setEta0 )			 
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( CaloCluster_v1, CaloCluster_v1::flt_t,  phi0, setPhi0 )			 
@@ -369,50 +404,6 @@ namespace xAOD {
     acc(*this)=sc;
   }
   
-  double CaloCluster_v1::eta() const
-  {
-    return eta (m_signalState);
-  }
-  
-  double CaloCluster_v1::phi() const
-  {
-    return phi (m_signalState);
-  }
-
-  double CaloCluster_v1::m() const {
-    //return (this->*m_getM)();
-    switch (m_signalState) {
-    case CALIBRATED:
-      return calM();
-      break;
-    case UNCALIBRATED:
-      return rawM();
-      break;
-    case ALTCALIBRATED:
-      return altM();
-      break;
-    default:
-      return -999;
-      }
-   }
-  
-   double CaloCluster_v1::e() const {
-     //return (this->*m_getE)(); //function ptr set according to signal state
-     switch (m_signalState) {
-     case CALIBRATED:
-       return calE();
-       break;
-     case UNCALIBRATED:
-       return rawE();
-       break;
-     case ALTCALIBRATED:
-       return altE();
-       break;
-     default:
-       return -999;
-     }
-   }
-
 
   void CaloCluster_v1::setE(CaloCluster_v1::flt_t theE) {
     switch (m_signalState) {
@@ -482,39 +473,12 @@ namespace xAOD {
      }
     return;
   }
-
-   
-  bool CaloCluster_v1::setSignalState( CaloCluster_v1::State s) const {
+ 
+  bool CaloCluster_v1::setSignalState( CaloCluster_v1::State s)  {
     m_signalState=s;
-    //std::cout << "Setting signal state of cluster " << this << " to " << s << std::endl;
     return true;
-    /*
-    switch(s) {
-    case CALIBRATED:
-      m_getE=&xAOD::CaloCluster_v1::calE;
-      m_getEta=&xAOD::CaloCluster_v1::calEta;
-      m_getPhi=&xAOD::CaloCluster_v1::calPhi;
-      m_getM=&xAOD::CaloCluster_v1::calM;
-      return true;
-    case UNCALIBRATED:
-      m_getE=&xAOD::CaloCluster_v1::rawE;
-      m_getEta=&xAOD::CaloCluster_v1::rawEta;
-      m_getPhi=&xAOD::CaloCluster_v1::rawPhi;
-      m_getM=&xAOD::CaloCluster_v1::rawM;
-      return true;
-    case ALTCALIBRATED:
-      m_getE=&xAOD::CaloCluster_v1::altE;
-      m_getEta=&xAOD::CaloCluster_v1::altEta;
-      m_getPhi=&xAOD::CaloCluster_v1::altPhi;
-      m_getM=&xAOD::CaloCluster_v1::altM;
-      return true;
-    default:
-      return false;
-    }//end switch
-    */
   }
   
-
   CaloCluster_v1::GenVecFourMom_t CaloCluster_v1::genvecP4(const CaloCluster_v1::State s) const {
     switch (s) {
     case CALIBRATED:

Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloClusterChangeSignalState.h

@@ -26,7 +26,7 @@ public:
   CaloClusterChangeSignalState& operator=(const CaloClusterChangeSignalState&) = delete;
 #else
   CaloClusterChangeSignalState() : m_clus(0) {};
-  void init(const xAOD::CaloCluster* pClus,
+  void init(xAOD::CaloCluster* pClus,
 	    xAOD::CaloCluster::State s);
 #endif
 
@@ -36,7 +36,7 @@ public:
    * @param pClus The cluster to change.
    * @param s The new signal state for the cluster.
    */
-  CaloClusterChangeSignalState (const xAOD::CaloCluster* pClus,
+  CaloClusterChangeSignalState (xAOD::CaloCluster* pClus,
                                 xAOD::CaloCluster::State s);
 
 
@@ -51,7 +51,7 @@ public:
 
 private:
   /// The cluster that we're managing
-  const xAOD::CaloCluster* m_clus;
+  xAOD::CaloCluster* m_clus;
   /// The previous signal state for the cluster.
   xAOD::CaloCluster::State m_oldstate;
 };
@@ -74,7 +74,7 @@ class CaloClusterChangeSignalStateList {
    * @param clus The cluster
    * @param s The new signal state for the cluster.
    */
-  void add(const xAOD::CaloCluster* clu, xAOD::CaloCluster::State s) {
+  void add(xAOD::CaloCluster* clu, xAOD::CaloCluster::State s) {
     m_stateHelpers.emplace_front(clu,s);
   }
 
@@ -112,7 +112,7 @@ class CaloClusterChangeSignalStateList {
    * @param clus The cluster
    * @param s The new signal state for the cluster.
    */
-  void add(const xAOD::CaloCluster* clu, xAOD::CaloCluster::State s) {
+  void add(xAOD::CaloCluster* clu, xAOD::CaloCluster::State s) {
     m_stateHelpers.push_back(CaloClusterChangeSignalState());
     m_stateHelpers.back().init(clu,s);
     

Event/xAOD/xAODCaloEvent/xAODCaloEvent/versions/CaloCluster_v1.h

@@ -342,18 +342,7 @@ namespace xAOD {
      double et() const;
 
      ///}
-  // Cint has trouble with the types of these members.
-  // Just hide them from reflex for now.
-     /*
-#ifndef __REFLEX__
-   private:
-     typedef flt_t (CaloCluster_v1::*GET_VALUE)() const;
-     mutable GET_VALUE m_getE;
-     mutable GET_VALUE m_getEta;
-     GET_VALUE m_getPhi;
-     GET_VALUE m_getM;
-#endif
-     */
+  
    public:
 
      /// @name Energy/Eta/Phi per sampling
@@ -554,8 +543,8 @@ namespace xAOD {
 #if !(defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS))
    private:
 #endif //not defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS)
-     /// Switch signal state (mutable)
-     bool setSignalState(const State s) const;
+     /// Switch signal state 
+     bool setSignalState(const State s) ;
    public:
      /// Get the current signal state
      State signalState() const {return m_signalState;}
@@ -569,9 +558,13 @@ namespace xAOD {
      /// eta with a given signal state
      double eta(const State s) const;
 
-     /// eta with a given signal state
+     /// phi with a given signal state
      double phi(const State s) const;
 
+     /// m with a given signal state
+     double m(const State s) const;
+
+
      ///  @}
 
 
@@ -600,8 +593,8 @@ namespace xAOD {
      /// bit-pattern describing the calo samplings contributing to this cluster
      unsigned m_samplingPattern;
 
-     /// Current signal state *** NEED TO UPDATE FOR ATHENAMT ***
-     mutable State m_signalState;
+     /// Current signal state 
+     State m_signalState;
      ///Non-const ptr to cell links (for cluster building, transient-only)
      CaloClusterCellLink* m_cellLinks;
 

Reconstruction/Jet/JetMomentTools/Root/JetConstitFourMomTool.cxx

@@ -9,8 +9,6 @@
 #include "xAODJet/JetConstituentVector.h"
 #include "xAODJet/JetTypes.h"
 
-#include "xAODCaloEvent/CaloClusterChangeSignalState.h"
-
 //**********************************************************************
 
 JetConstitFourMomTool::JetConstitFourMomTool(std::string myname)
@@ -124,8 +122,9 @@ int JetConstitFourMomTool::modify(xAOD::JetContainer& jets) const {
 	if(m_altJetScales.empty()) {
 	  if(altCollections[iScale]) { // get the index-parallel alternative constituent
 	    const xAOD::CaloCluster* cluster = static_cast<const xAOD::CaloCluster*>((*altCollections[iScale])[(*citer)->rawConstituent()->index()]);
-	    CaloClusterChangeSignalState(cluster, (xAOD::CaloCluster::State) m_altConstitScales[iScale]);
-	    constitFourVecs[iScale] += xAOD::JetFourMom_t( cluster->pt(), cluster->eta(), cluster->phi(), cluster->m() );
+      xAOD::CaloCluster::State currentState= static_cast<xAOD::CaloCluster::State> (m_altConstitScales[iScale]);
+      constitFourVecs[iScale] += xAOD::JetFourMom_t( cluster->pt(currentState), cluster->eta(currentState), 
+                                                     cluster->phi(currentState), cluster->m(currentState) );
 	  } else { // add the constituent 4-mom
 	    constitFourVecs[iScale] += **citer;
 	  }

Reconstruction/MET/METReconstruction/Root/METAssociationTool.cxx

@@ -180,21 +180,6 @@ namespace met {
 
     if ( m_timedetail > 0 ) m_clock.Start(false);
 
-    // Set the topocluster signal states for the duration of this method
-    // Cluster signal states will revert upon the return.
-    CaloClusterChangeSignalStateList stateHelperList;    
-    if(m_signalstate>=0) { // can ignore this for PFlow
-      const CaloClusterContainer* clusters(0);
-      if( evtStore()->retrieve(clusters,"CaloCalTopoClusters").isFailure() ) {
-	ATH_MSG_WARNING("Failed to set topocluster signal states!");
-	return StatusCode::FAILURE;
-      } else {
-	for(const auto& clus : *clusters) {
-	  stateHelperList.add(clus,CaloCluster::State(m_signalstate));
-	}
-      }
-    }
-
     unsigned int itool=0;
     // Run the MET reconstruction tools in sequence
     for(ToolHandleArray<IMETAssocToolBase>::const_iterator iAssociator=m_metassociators.begin();

Reconstruction/MET/METReconstruction/Root/METSoftAssociator.cxx

@@ -14,7 +14,7 @@
 
 // METReconstruction includes
 #include "METReconstruction/METSoftAssociator.h"
-#include "xAODCaloEvent/CaloClusterChangeSignalState.h"
+#include "xAODCaloEvent/CaloVertexedClusterBase.h"
 #include "xAODCaloEvent/CaloClusterContainer.h"
 
 namespace met {
@@ -157,14 +157,14 @@ namespace met {
 	  } else {
 	    // clusters at LC scale
 	    if (cl->type()==xAOD::Type::CaloCluster) {
-	      CaloClusterChangeSignalState statehelperLC(static_cast<const CaloCluster*>(cl),xAOD::CaloCluster::CALIBRATED);
-	      *metCoreCl += cl;
+        CaloVertexedClusterBase stateClLC(*(static_cast<const CaloCluster*>(cl)),xAOD::CaloCluster::CALIBRATED);
+	      *metCoreCl += (&stateClLC);
 	    } else *metCoreCl += cl;
 	    if(m_decorateSoftTermConst) dec_softConst(*metCoreCl).push_back(ElementLink<IParticleContainer>(*static_cast<const IParticleContainer*>(cl->container()),cl->index()));
 	    // clusters at EM scale
 	    if (cl->type()==xAOD::Type::CaloCluster) {
-	      CaloClusterChangeSignalState statehelperEM(static_cast<const CaloCluster*>(cl),xAOD::CaloCluster::UNCALIBRATED);
-	      *metCoreEMCl += cl;
+        CaloVertexedClusterBase stateClEM( *(static_cast<const CaloCluster*>(cl)),xAOD::CaloCluster::UNCALIBRATED);
+        *metCoreEMCl += (&stateClEM);
 	    } else *metCoreEMCl += cl;
 	  }
 	}

Reconstruction/MET/METReconstruction/Root/METSoftTermsTool.cxx

@@ -28,7 +28,8 @@
 #include "xAODCaloEvent/CaloClusterContainer.h"
 
 // Calo helpers
-#include "xAODCaloEvent/CaloClusterChangeSignalState.h"
+#include "xAODCaloEvent/CaloVertexedClusterBase.h"
+
 
 // PFlow EDM and helpers
 #include "xAODPFlow/PFOContainer.h"
@@ -253,15 +254,14 @@ namespace met {
     // First retrieve the necessary container
     // Currently rely on only one: either CaloClusterContainer or TrackParticleContainer
     const PFOContainer* pfoCont = 0;
-    vector<const IParticle*> signalList;
-    CaloClusterChangeSignalStateList stateHelperList;
-
+     vector<const IParticle*> signalList;
     if( m_st_objtype == 0 ) {
       // Retrieve the calo container
       SG::ReadHandle<xAOD::CaloClusterContainer> caloClusCont(m_caloClusterKey);
       if (!caloClusCont.isValid()) {
-	  ATH_MSG_WARNING("Unable to retrieve input calo cluster container");
+        ATH_MSG_WARNING("Unable to retrieve input calo cluster container");
       }
+
       signalList.reserve(caloClusCont->size());
       //stateHelperList.reserve(caloClusCont->size());
 
@@ -270,24 +270,19 @@ namespace met {
 
       MissingETComponentMap::iterator iter = MissingETComposition::find(metMap,metTerm);
       if(iter==metMap->end()) {
-	ATH_MSG_WARNING("Could not find current METComponent in MET Map!");
-	return StatusCode::SUCCESS;
+        ATH_MSG_WARNING("Could not find current METComponent in MET Map!");
+        return StatusCode::SUCCESS;
       }
       MissingETComponent* newComp = *iter;
       newComp->setStatusWord(MissingETBase::Status::contributedSoftTerm());
 
       // Loop over all clusters
       for( CaloClusterContainer::const_iterator iClus=caloClusCont->begin(); iClus!=caloClusCont->end(); ++iClus ) {
-	// create a helper to change the signal state and retain it until the end of the execute
-	// signal state will be reset when it goes out of scope
-	//CaloClusterChangeSignalState stateHelper(*iClus, CaloCluster::State(m_signalstate));
-	stateHelperList.add(*iClus, CaloCluster::State(m_signalstate));
-	
         // Check if cluster satisfies the requirements
-        if( this->accept(*iClus) ) {
-	  // Add the selected clusters to the list
-	  signalList.push_back(*iClus);
-	}
+        if( this->accept(*iClus)) {
+          // Add the selected clusters to the list
+          signalList.push_back(*iClus);
+        }
       } // end loop over clusters
 
       ATH_MSG_DEBUG("Selected " << signalList.size() << " topoclusters for soft MET");
@@ -404,8 +399,8 @@ namespace met {
       }
     } else {
       for( vector<const IParticle*>::const_iterator iPart=signalList.begin();
-	   iPart!=signalList.end(); ++iPart) {
-	this->addToMET(*iPart,dummyList,metTerm,metMap,unitWeight);
+           iPart!=signalList.end(); ++iPart) {
+        this->addToMET(*iPart,dummyList,metTerm,metMap,unitWeight);
       }
     }
 

Trigger/TrigAlgorithms/TrigHLTJetRec/TrigHLTJetRec/ClusterToPseudoJetConverter.h

@@ -13,7 +13,7 @@ whether the cluster local calibration should be set to "EM" */
 #include "xAODCaloEvent/CaloClusterContainer.h"
 
 using InputContainer = xAOD::CaloClusterContainer;
-using ValueType = InputContainer::const_value_type;
+using ValueType = InputContainer::value_type;
 using ClusterToPseudoJet = AnyToPseudoJet<InputContainer::const_value_type>;
 
 class ClusterToPseudoJetConverter {