TruthParticleFilterBaseTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
// TruthParticleFilterBaseTool.cxx 
// Implementation file for class TruthParticleFilterBaseTool
// Author: S.Binet<binet@cern.ch>
 
 
// McParticleKernel includes
#include "McParticleKernel/IMcVtxFilterTool.h"
#include "McParticleKernel/ITruthIsolationTool.h"
 
// McParticleTools includes
#include "TruthParticleFilterBaseTool.h"
 
 
TruthParticleFilterBaseTool::TruthParticleFilterBaseTool( const std::string& type, 
                                                          const std::string& name, 
                                                          const IInterface* parent ) : 
  AthAlgTool( type, name, parent )
{
  //
  // Property declaration
  // 
 
  declareProperty( "McVtxFilterTool",
           m_mcVtxFilterTool = McVtxFilterTool_t( "McVtxFilterTool",
                              this ),
           "Pointer to the McVtxFilterTool to be able to select additional "
           "vertices on some decay pattern(s) criterion(s)" );
 
  declareProperty( "TruthIsolationTool",
           m_isolationTool = IsolTool_t( "TruthIsolationTool" ),
           "Pointer to the TruthIsolationTool to be able to compute "
           "transverse energy isolations for various isolation cones cuts. " 
           "See McParticleEvent/TruthParticleParameters.h for cone cuts." );
 
 
  declareProperty( "DoEtIsolations",
           m_doEtIsolation = false,
           "Switch to compute or not the Et-isolations for TruthParticle "
           "(and their underlying @c HepMC::GenParticle).\n" 
           "Default is to not compute these Et-isolations (and save CPU)." );
 
  declareInterface<ITruthParticleFilterTool>(this);
}
 
TruthParticleFilterBaseTool::~TruthParticleFilterBaseTool()
{ 
  ATH_MSG_DEBUG("Calling destructor");
}
 
StatusCode TruthParticleFilterBaseTool::initialize()
{
  ATH_MSG_INFO("Initializing " << name() << "...");
 
  if ( !m_mcVtxFilterTool.retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Creation of algTool IMcVtxFilterTool FAILED !");
    return StatusCode::FAILURE;
  }
 
  if( m_doEtIsolation.value()) {
    ATH_CHECK(m_isolationTool.retrieve());
  }
  else {
    m_isolationTool.disable();
  }
 
  //initialize DataHandleKeys
  ATH_CHECK(m_mcEventsReadHandleKey.initialize());
  ATH_CHECK(m_mcEventsOutputWriteHandleKey.initialize());
  
  ATH_MSG_INFO
    (" DoEtIsolations: [" << std::boolalpha << m_doEtIsolation.value()
     << "]" << endmsg
     << " McEvents:       [" << m_mcEventsReadHandleKey.key() << "]" << endmsg
     << " McEventsOutput: [" << m_mcEventsOutputWriteHandleKey.key() << "]");
  
  // Give the concrete (derived) tool a chance to initialize itself
  if ( initializeTool().isFailure() ) {
    ATH_MSG_ERROR("Could not initialize concrete tool !");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("Options of the McVtxFilterTool:");
  m_mcVtxFilterTool->displayOptions();
 
  return StatusCode::SUCCESS;
}
 
StatusCode TruthParticleFilterBaseTool::finalize()
{
  ATH_MSG_INFO("Finalizing " << name() << "...");
 
  m_mcVtxFilterTool->stats();
 
  // Give the concrete (derived) tool a chance to finalize itself
  if ( finalizeTool().isFailure() ) {
    ATH_MSG_ERROR("Could not finalize concrete tool !");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}
 
StatusCode TruthParticleFilterBaseTool::execute()
{  
  ATH_MSG_DEBUG("Executing " << name() << "...");
 
  //Setup Handle to read input container
  SG::ReadHandle<McEventCollection> mcEventsReadHandle(m_mcEventsReadHandleKey);
 
  if (!mcEventsReadHandle.isValid()){
    ATH_MSG_ERROR("Invalid ReadHandle to McEventColleciton with key: " << m_mcEventsReadHandleKey.key());
    return StatusCode::FAILURE;
  }
 
  //Setup WriteHandle, and then record new McEventCollection.
  SG::WriteHandle<McEventCollection> mcEventsOutputWriteHandle(m_mcEventsOutputWriteHandleKey);
  ATH_CHECK(mcEventsOutputWriteHandle.record(std::make_unique<McEventCollection>()));  
  
  if (!mcEventsOutputWriteHandle.isValid()){
    ATH_MSG_ERROR("Invalid WriteHamdle for McEventCollection with key ["
                  <<m_mcEventsOutputWriteHandleKey.key()  << "] !!");
    return StatusCode::FAILURE;
  }
  
  // Compute isolation for gamma/lepton.
  if ( m_doEtIsolation.value() ) {
    ATH_MSG_VERBOSE("Computing Et isolations...");
    if ( m_isolationTool->buildEtIsolations(m_mcEventsReadHandleKey.key()).isFailure() ) {
      ATH_MSG_ERROR("Could not compute Et isolations !!");
      return StatusCode::FAILURE;
    }
  } //> end do Et-isolation
 
    if ( this->buildMcAod( mcEventsReadHandle.ptr(), mcEventsOutputWriteHandle.ptr() ).isFailure() ) {
    ATH_MSG_ERROR("Could not buildMcAod(in,out) !!");
    return StatusCode::FAILURE;
  }
 
  // We have slimmed the mcEventsOutputWriteHandle.
  // To not bias the map of isolation energies for this GenEvent, we alias
  // it to its original one
  if ( m_doEtIsolation.value() &&
       !m_isolationTool->registerAlias( m_mcEventsOutputWriteHandleKey.key(), 
                                        m_mcEventsReadHandleKey.key() 
                                        ).isSuccess() ) {
    ATH_MSG_WARNING("Could not create an alias in the map of "\
            "isolation energies !");
  }
 
  return StatusCode::SUCCESS;
}