CaloTopoTowerAlgorithm.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
 
#include "CaloEvent/CaloTowerSeg.h"
#include "CaloEvent/CaloTowerContainer.h"
#include "CaloEvent/CaloCellContainer.h"
#include "CaloEvent/CaloClusterContainer.h"
#include "CaloEvent/CaloTopoTowerContainer.h"
#include "CaloTopoTowerAlgorithm.h"
 
#include <string>
#include <vector>
#include <iomanip>
 
CaloTopoTowerAlgorithm::CaloTopoTowerAlgorithm(const std::string& name, 
                       ISvcLocator* pSvcLocator) 
  : AthReentrantAlgorithm(name,pSvcLocator)
  , m_genericLink(true) 
  , m_ptools( this )
  , m_cellContainerKey("AllCalo")
  , m_clusterKey("CaloTopoClusters")
  , m_cellToClusterMapKey("CaloCell2TopoCluster")
  , m_towerContainerKey("CmbTower")
  , m_newTowerContainerKey("TopoTower")
  , m_caloSelection(false)
{
  // tool names
  //declareProperty("TowerBuilderTools",m_toolNames);
  declareProperty("TowerBuilderTools",m_ptools);
  // output data
  //declareProperty("TowerContainerName",m_towerContainerName);
  // linkable
  declareProperty("GenericLinked",m_genericLink);

  //Item From CaloTopoTowerAlg
  declareProperty("Cell2ClusterMapName",    m_cellToClusterMapKey);
  declareProperty("CellContainerName"  ,    m_cellContainerKey);
  declareProperty("ClusterContainerName",   m_clusterKey);
  declareProperty("InputTowerContainerName" ,    m_towerContainerKey);
  declareProperty("OutputTowerContainerName",    m_newTowerContainerKey);
 
  // Declare configurable properties of the algorithm
  declareProperty("MinimumCellEnergy",      m_minimumCellEnergy    = -1000000000.0);
  declareProperty("MinimumClusterEnergy",   m_minimumClusterEnergy = -1000000000.0);
 
  // Noise Tool stuff
  declareProperty("DefaultNoiseSigma",      m_noiseSigma           = 10.0);
  declareProperty("CellEnergySignificance", m_cellESignificanceThreshold = -1);
 
  // Calo from which to use cells
  declareProperty("IncludedCalos",          m_includedCalos);
  declareProperty("useCellWeight",          m_useCellWeights=true);
  
  //END Item From CaloTopoTowerAlg 
 
}
 
CaloTopoTowerAlgorithm::~CaloTopoTowerAlgorithm()
= default;

// Initialize //
 
StatusCode CaloTopoTowerAlgorithm::initialize()
{
  ATH_CHECK(m_cellContainerKey.initialize());
  ATH_CHECK(m_clusterKey.initialize());
  ATH_CHECK(m_cellToClusterMapKey.initialize());
  ATH_CHECK(m_towerContainerKey.initialize());
  ATH_CHECK(m_newTowerContainerKey.initialize());
 
  m_caloIndices.clear();
  for ( unsigned int iCalos=0; iCalos< m_includedCalos.size(); iCalos++ )
    {
      if  ( m_includedCalos[iCalos] == "LAREM" )
    {
      m_caloIndices.push_back(CaloCell_ID::LAREM);
    }
      else if ( m_includedCalos[iCalos] == "LARHEC")
    {
      m_caloIndices.push_back(CaloCell_ID::LARHEC);
    }
      else if ( m_includedCalos[iCalos] == "LARFCAL" )
    {
      m_caloIndices.push_back(CaloCell_ID::LARFCAL);
    }
      else if ( m_includedCalos[iCalos] == "TILE" )
    {
      m_caloIndices.push_back(CaloCell_ID::TILE);
    }
    }
 
  m_caloSelection=false;
  unsigned int nSubCalo=static_cast<int>(CaloCell_ID::NSUBCALO) ;
  if (!m_caloIndices.empty() && m_caloIndices.size()<nSubCalo) m_caloSelection=true;
 
  ATH_MSG_INFO( " Calo selection applied ? " << m_caloSelection  );
  if (m_caloSelection) {
    msg() << MSG::INFO << "   subcalo selected ";
    for (unsigned int iCalos=0;iCalos< m_includedCalos.size(); iCalos++ )
      msg() << MSG::INFO << " " << m_includedCalos[iCalos];
    msg() << MSG::INFO << " " << endmsg;
  }
 

  // Allocate Tools //
 
  // check tool names
  if ( m_ptools.empty() )
    {
      ATH_MSG_ERROR( "no tools given for this algorithm." );
      return StatusCode::FAILURE;
    }
 
  // find tools
  
  unsigned int toolCtr = 0;
  ATH_MSG_INFO( " "  );
  ATH_MSG_INFO( "List of tools in execution sequence:" );
  ATH_MSG_INFO( "------------------------------------" );
 
  StatusCode checkOut = m_ptools.retrieve();
  if ( checkOut.isFailure() ) 
    {
      ATH_MSG_WARNING( "Cannot retrieve tool array " << m_ptools  );
      return StatusCode::FAILURE;
    }
 
  for (ToolHandle<ICaloTopoTowerBuilderToolBase>& tool : m_ptools)
    {
      toolCtr++;
      /*      ATH_MSG_INFO( "retrieving tool"  );
 
      if ( checkOut.isFailure() ) {
      ATH_MSG_WARNING( "Cannot retrieve tool at ToolArray[" << toolCtr-1 << "]"  );
      ATH_MSG_WARNING( "This tool won't be used"  );
      }
      else {
      ATH_MSG_INFO( "retrieved tool"  );
    // print the list of tools
    */
 
 
      ATH_MSG_INFO( std::setw(2) << toolCtr << ".) "
      << tool->type()
      << "::name() = \042"
      << tool->name()
      << "\042" );
 
      ATH_MSG_INFO( "------------------------------------" );
      ATH_MSG_INFO( " "  );
 
    /*if ( tool->initializeTool().isFailure() ) {
 
      ATH_MSG_WARNING( " Tool failed to initialize"  );
      }*/
      
    } //close iteration over tools
  return StatusCode::SUCCESS;
}

// Execute //
 
StatusCode CaloTopoTowerAlgorithm::execute (const EventContext& ctx) const
{

  // Re-allocate Services //
 
  //timing
  IChronoStatSvc* theTicker = chronoSvc();

  // Tool Processing //
  SG::ReadHandle<CaloTowerContainer> towerContainer(m_towerContainerKey, ctx);
  if ( !towerContainer.isValid() ) {
    ATH_MSG_WARNING( " cannot retrieve tower container with key " << towerContainer.name()  );
    return StatusCode::SUCCESS;
  }

  SG::ReadHandle<CaloCellContainer> theCells(m_cellContainerKey, ctx);
  if ( !theCells.isValid()) {
    ATH_MSG_WARNING( " cannot retrieve cell container with key " << theCells.name()  );
    return StatusCode::SUCCESS;
  }
  ATH_MSG_DEBUG( "CaloTopoTowerAlgorithm::execute " << theCells.name() << " size= " << theCells->size()  );
      
  SG::ReadHandle<CaloClusterContainer> clusters(m_clusterKey, ctx);
 
  if ( !clusters.isValid() )
    {
      ATH_MSG_WARNING( "cannot retrieve CaloClusterContainer with key <"
            << clusters.name() << ">" );
      return StatusCode::SUCCESS;
    }

  SG::ReadHandle<CaloCell2ClusterMap>  cellToClusterMap(m_cellToClusterMapKey, ctx);
   if ( !cellToClusterMap.isValid() ){
    ATH_MSG_WARNING( "cannot retrieve CaloCell2ClusterMap with key <"
      << cellToClusterMap.name() << ">"  );
    return StatusCode::SUCCESS;
  } 
  
  ATH_MSG_DEBUG( "Successfully retrieved CaloCell2ClusterMap <"<< cellToClusterMap.name() << ">" );
 
  SG::WriteHandle<CaloTopoTowerContainer> theTowers( m_newTowerContainerKey, ctx);
  ATH_CHECK( theTowers.record (std::make_unique<CaloTopoTowerContainer>(towerContainer->towerseg())) );

  //Starting to save variable to CaloTopoTowerContainer
  //
  
  theTowers->SetTowers(towerContainer.cptr());
  theTowers->SetClusters(clusters.ptr());
  theTowers->SetCells(theCells.cptr());
  theTowers->SetCellToClusterMap(cellToClusterMap.cptr());
 
  theTowers->SetMinimumCellEnergy(m_minimumCellEnergy);
  theTowers->SetMinimumClusterEnergy(m_minimumClusterEnergy);
  theTowers->SetUseCellWeights(m_useCellWeights);
 
  // Noise tool stuff
  theTowers->SetNoiseSigma(m_noiseSigma);
  theTowers->SetCellESignificanceThreshold(m_cellESignificanceThreshold);
 
  // List of calorimeters from which to use cells
  theTowers->SetCaloIndices(m_caloIndices);
  theTowers->SetCaloSelection(m_caloSelection);
 
  //
  //Finished saving variable to CaloTopoTowerContainer
  
  ToolHandleArray<ICaloTopoTowerBuilderToolBase>::const_iterator firstITool  = m_ptools.begin();
  ToolHandleArray<ICaloTopoTowerBuilderToolBase>::const_iterator lastITool   = m_ptools.end();
  StatusCode processStatus = StatusCode::SUCCESS;
  //
  // loop stops only when Failure indicated by one of the tools
  //
 
  ATH_MSG_DEBUG( "In execute() "  );
  
  while ( ! processStatus.isFailure() && firstITool != lastITool )
    {
      //      CaloTopoTowerBuilderToolBase* pTool = *firstTool;
      //sc = (*firstITool).retrieve();
      //if ( sc.isFailure() ) { log << MSG::INFO << "error retrieving tool " << endmsg; }
 
      //if ( (*firstITool).empty() ) { log << MSG::INFO << "tool is empty " << endmsg; }
 
      //ATH_MSG_INFO( "tool retrieved, going to start "  );
      if ( theTicker != nullptr )
    {
      //      ATH_MSG_INFO( "Chrono start "  );
      theTicker->chronoStart((*firstITool)->name());
    }
      /*      ATH_MSG_INFO( "executing tool: " << (*firstITool)->name()  );
              ATH_MSG_INFO( "this is &(firstITool): " << &(firstITool)  );
              ATH_MSG_INFO( "this is (*firstITool): " << (*firstITool)  );
              ATH_MSG_INFO( "this is &(*firstITool): " << &(*firstITool)  );
              ATH_MSG_INFO( "this is &(*(*firstITool)): " << &(*(*firstITool))  );
              ATH_MSG_INFO( "this is theTowers: " << theTowers  );
      */
      
      processStatus = (*firstITool)->execute(ctx, theTowers.ptr());
      
      // ATH_MSG_INFO( "processStatus is: " << processStatus  );
      
 
      if ( theTicker != nullptr )
    {
      //  ATH_MSG_INFO( "Chrono stop "  );
      theTicker->chronoStop((*firstITool)->name());
    }
      if ( ! processStatus.isFailure() )
    {
      ATH_MSG_DEBUG( (*firstITool)->name()
          << ": CaloTopoTowerContainer::size() = "
          << theTowers->size() );
      ++firstITool;
    }
      else
    {
      // some problem - but do not skip event loop!
      ATH_MSG_ERROR( "problems while or after processing tool \042"
          << (*firstITool)->name()
          << "\042 - cross-check CaloTopoTowerContainer::size() = "
          << theTowers->size() );
      ++firstITool;
    }
    }
 
  return StatusCode::SUCCESS;
}

// Finalize //
 
StatusCode CaloTopoTowerAlgorithm::finalize()
{
  return StatusCode::SUCCESS;
}