ParticleRemoverAlg Class Reference

#include <ParticleRemoverAlg.h>

Inheritance diagram for ParticleRemoverAlg:

Collaboration diagram for ParticleRemoverAlg:

Public Member Functions
	ParticleRemoverAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Standard constructor. More...
virtual	~ParticleRemoverAlg ()
	Standard destructor. More...
virtual StatusCode	initialize ()
	Standard Gaudi initialize method called once before the event loop. More...
virtual StatusCode	execute ()
	Standard Gaudi execute method called once for every event. More...
virtual StatusCode	finalize ()
	Standard Gaudi finalize method called once after the event loop. More...
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. 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	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	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
template<class CONT >
StatusCode	removeParticles (const std::vector< bool > &keepParticleVec)
	Private function to perform the actualy work. More...
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
DataObjIDColl	m_extendedExtraObjects
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
The properties that can be defined via the python job options
StringProperty	m_inCont
	The input container name. More...
StringProperty	m_separator
	The string separator between the output container name and the sytematic variation (default="___") More...
StringProperty	m_outCont
	The output container name. More...
StringArrayProperty	m_suffixes
	The names of all suffixes for the input and output container names. More...
StringArrayProperty	m_viewContNames
	The names of all view containers that contain particles that we want to retain. More...
BooleanProperty	m_resetViewConts
	Boolean to decide if the existing view containers should be re-mapped (default: true) More...
StringProperty	m_outPrefix
	Prefix to be used for all created output view containers. More...

Internal members
enum	contType_t {   UNKNOWN, PHOTON, ELECTRON, MUON,   TAU, JET, PARITCLEFLOW, NEUTRALPARTICLE,   TRACKPARTICLE, TRUTHPARTICLE, COMPOSITEPARTICLE, PARTICLE,   CALOCLUSTER }
	An enumaration for the actual container type. More...
std::vector< std::string >	m_inContNameList
	Vector of all input container names. More...
std::vector< std::string >	m_outContNameList
	Vector of all output container names. More...
std::vector< const xAOD::IParticleContainer * >	m_inContList
	Vector of all input containers. More...
std::vector< xAOD::IParticleContainer * >	m_outContList
	Vector of all output containers. More...
std::vector< std::vector< std::string > >	m_inViewContNameListList
	Vector of all input view container names. More...
std::vector< std::vector< std::string > >	m_outViewContNameListList
	Vector of all output view container names. More...
contType_t	m_contType
	The variable that holds the value that we find for the input container. More...

Detailed Description

Definition at line 14 of file ParticleRemoverAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

contType_t

enum ParticleRemoverAlg::contType_t

private

An enumaration for the actual container type.

Enumerator
UNKNOWN
PHOTON
ELECTRON
MUON
TAU
JET
PARITCLEFLOW
NEUTRALPARTICLE
TRACKPARTICLE
TRUTHPARTICLE
COMPOSITEPARTICLE
PARTICLE
CALOCLUSTER

Definition at line 88 of file ParticleRemoverAlg.h.

                  {
    UNKNOWN,
    PHOTON,
    ELECTRON,
    MUON,
    TAU,
    JET,
    PARITCLEFLOW,
    NEUTRALPARTICLE,
    TRACKPARTICLE,
    TRUTHPARTICLE,
    COMPOSITEPARTICLE,
    PARTICLE,
    CALOCLUSTER
  };

Constructor & Destructor Documentation

ParticleRemoverAlg()

ParticleRemoverAlg::ParticleRemoverAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Standard constructor.

Definition at line 28 of file ParticleRemoverAlg.cxx.

  : AthAlgorithm( name, pSvcLocator ),
  m_inCont(""),
  m_separator("___"),
  m_outCont(""),
  m_suffixes(),
  m_viewContNames(),
  m_resetViewConts(true),
  m_outPrefix(""),
  m_inContNameList(),
  m_outContNameList(),
  m_inContList(),
  m_outContList(),
  m_inViewContNameListList(),
  m_outViewContNameListList(),
  m_contType(UNKNOWN)
{
  //
  // Property declaration
  //
  declareProperty("Input",  m_inCont, "Input container name" );
  declareProperty("Output", m_outCont,
                  "The name of the output container with the deep copy of input objects" );
 
  declareProperty("Separator", m_separator,
                  "The string seperator between the output container name and the sytematic variation (default='___')" );
 
  declareProperty("Suffixes", m_suffixes,
                  "The names of all suffixes for the input and output container names" );
 
  declareProperty("SelectedViewContainers", m_viewContNames,
                  "The names of all view containers that contain particles that we want to retain" );
 
  declareProperty("RemapViewContainers", m_resetViewConts,
                  "Boolean to decide if the existing view containers should be re-mapped (default: true)" );
 
  declareProperty("OutputViewContainerPrefix", m_outPrefix,
                  "Prefix to be used for all created output view containers" );
}

~ParticleRemoverAlg()

ParticleRemoverAlg::~ParticleRemoverAlg ( )

virtual

Standard destructor.

Definition at line 69 of file ParticleRemoverAlg.cxx.

{}

Member Function Documentation

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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; }

execute()

StatusCode ParticleRemoverAlg::execute ( )

virtual

Standard Gaudi execute method called once for every event.

Definition at line 210 of file ParticleRemoverAlg.cxx.

{
  ATH_MSG_DEBUG ("Executing " << name() << "...");
  // Let's first clear some stuff
  m_inContList.clear();
  m_inContList.resize(m_inContNameList.size());
  m_outContList.clear();
 
  // Figure out what type the input container has, if we didn't do it yet
  if ( m_contType == UNKNOWN ){
    if ( evtStore()->contains<xAOD::PhotonContainer>(m_inCont.value()) ){ m_contType = PHOTON; }
    else if ( evtStore()->contains<xAOD::ElectronContainer>(m_inCont.value()) ){ m_contType = ELECTRON; }
    else if ( evtStore()->contains<xAOD::MuonContainer>(m_inCont.value()) ){ m_contType = MUON; }
    else if ( evtStore()->contains<xAOD::TauJetContainer>(m_inCont.value()) ){ m_contType = TAU; }
    else if ( evtStore()->contains<xAOD::JetContainer>(m_inCont.value()) ){ m_contType = JET; }
    else if ( evtStore()->contains<xAOD::TruthParticleContainer>(m_inCont.value()) ){ m_contType = TRUTHPARTICLE; }
    else if ( evtStore()->contains<xAOD::CompositeParticleContainer>(m_inCont.value()) ){ m_contType = COMPOSITEPARTICLE; }
    else if ( evtStore()->contains<xAOD::PFOContainer>(m_inCont.value()) ){ m_contType = PARITCLEFLOW; }
    else if ( evtStore()->contains<xAOD::NeutralParticleContainer>(m_inCont.value()) ){ m_contType = NEUTRALPARTICLE; }
    else if ( evtStore()->contains<xAOD::TrackParticleContainer>(m_inCont.value()) ){ m_contType = TRACKPARTICLE; }
    else if ( evtStore()->contains<xAOD::ParticleContainer>(m_inCont.value()) ){ m_contType = PARTICLE; }
    else if ( evtStore()->contains<xAOD::CaloClusterContainer>(m_inCont.value()) ){ m_contType = CALOCLUSTER; }
  }
  if ( m_contType == UNKNOWN ){
    ATH_MSG_FATAL("We couldn't determine the type of the container... abort!");
    return StatusCode::FAILURE;
  }
 
  // Open the input container
  for ( std::size_t i=0; i<m_inContNameList.size(); ++i ) {
    ATH_CHECK( evtStore()->retrieve( m_inContList[i], m_inContNameList.at(i) ));
  }
 
  // Make a quick check that all input containers have the same size
  const std::size_t inContSize = m_inContList[0]->size();
  for ( const xAOD::IParticleContainer* inCont : m_inContList ){
    if ( inContSize != inCont->size() ){
      ATH_MSG_FATAL("The input container and its shallow copies don't have the same size! Aborting...");
      return StatusCode::FAILURE;
    }
  }
 
  // Create a vector of bools with the same size as the input container. This
  // will be used to say if we want to keep that particular object.
  // All entries will be initialized to false.
  std::vector<bool> keepParticleVec (inContSize, false);
  // Now, loop over all view containers and flag the particles that we want to
  // keep with true in the above vector of bools.
  for ( const std::string& viewContName : m_viewContNames.value() ){
    const xAOD::IParticleContainer* inViewCont = nullptr;
    ATH_CHECK( evtStore()->retrieve( inViewCont, viewContName ) );
    // Make a quick check that the provided view containers are not larger
    if ( inViewCont->size() > inContSize ){
      ATH_MSG_FATAL("One of the input view containers is larger than the input container... aborting.");
      return StatusCode::FAILURE;
    }
    for ( const xAOD::IParticle* part : *inViewCont ){
      const std::size_t idx = part->index();
      keepParticleVec[idx] = true;
    }
  }
 
  // Do the heavy lifting of actually creating the new and reduced output container(s)
  if ( m_contType == PHOTON ){
    ATH_CHECK( this->removeParticles<xAOD::PhotonContainer>(keepParticleVec) );
  }
  else if ( m_contType == ELECTRON ){
    ATH_CHECK( this->removeParticles<xAOD::ElectronContainer>(keepParticleVec) );
  }
  else if ( m_contType == MUON ){
    ATH_CHECK( this->removeParticles<xAOD::MuonContainer>(keepParticleVec) );
  }
  else if ( m_contType == TAU ){
    ATH_CHECK( this->removeParticles<xAOD::TauJetContainer>(keepParticleVec) );
  }
  else if ( m_contType == JET ){
    ATH_CHECK( this->removeParticles<xAOD::JetContainer>(keepParticleVec) );
  }
  else if ( m_contType == TRUTHPARTICLE ){
    ATH_CHECK( this->removeParticles<xAOD::TruthParticleContainer>(keepParticleVec) );
  }
  else if ( m_contType == COMPOSITEPARTICLE ){
    ATH_CHECK( this->removeParticles<xAOD::CompositeParticleContainer>(keepParticleVec) );
  }
  else if ( m_contType == PARITCLEFLOW ){
    ATH_CHECK( this->removeParticles<xAOD::PFOContainer>(keepParticleVec) );
  }
  else if ( m_contType == NEUTRALPARTICLE ){
    ATH_CHECK( this->removeParticles<xAOD::NeutralParticleContainer>(keepParticleVec) );
  }
  else if ( m_contType == TRACKPARTICLE ){
    ATH_CHECK( this->removeParticles<xAOD::TrackParticleContainer>(keepParticleVec) );
  }
  else if ( m_contType == PARTICLE ){
    ATH_CHECK( this->removeParticles<xAOD::ParticleContainer>(keepParticleVec) );
  }
  else if ( m_contType == CALOCLUSTER ){
    ATH_CHECK( this->removeParticles<xAOD::CaloClusterContainer>(keepParticleVec) );
  }
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

finalize()

StatusCode ParticleRemoverAlg::finalize ( )

virtual

Standard Gaudi finalize method called once after the event loop.

Definition at line 201 of file ParticleRemoverAlg.cxx.

{
  ATH_MSG_DEBUG ("Finalizing " << name() << "...");
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode ParticleRemoverAlg::initialize ( )

virtual

Standard Gaudi initialize method called once before the event loop.

Definition at line 72 of file ParticleRemoverAlg.cxx.

{
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
 
  // Print the configuration to the log file
  ATH_MSG_DEBUG( "Using: " << m_inCont );
  ATH_MSG_DEBUG( "Using: " << m_outCont );
  ATH_MSG_DEBUG( "Using: " << m_separator );
  ATH_MSG_DEBUG( "Using: " << m_suffixes );
  ATH_MSG_DEBUG( "Using: " << m_viewContNames );
  ATH_MSG_DEBUG( "Using: " << m_resetViewConts );
  ATH_MSG_DEBUG( "Using: " << m_outPrefix );
 
  // Perform some sanity checks on the given container names
  if ( m_inCont.value().empty() || m_outCont.value().empty() || m_viewContNames.value().empty() ) {
    ATH_MSG_ERROR("Wrong user setup! You need to give a valid name for both the Input, Output, and SelectedViewContainers!");
    return StatusCode::FAILURE;
  }
 
  // Abort on an unchecked systematics code
  // StatusCode::enableFailure();
 
  // Build the vector of all input and output container names
  const std::size_t totSize = 1 + m_suffixes.value().size(); // the '1' comes from the InputContainer
  m_inContNameList.resize(totSize);
  m_inContList.resize(totSize);
  m_outContNameList.resize(totSize);
  m_inContNameList[0]  = m_inCont.value();
  m_outContNameList[0] = m_outCont.value();
  for ( std::size_t i=1; i<totSize; ++i ) {
    const std::string& currentSuffix = m_suffixes.value()[i-1];
    ATH_MSG_VERBOSE("Using current suffix " << currentSuffix << " to search for matching containers");
    if ( currentSuffix.rfind( m_separator.value(),0 ) == 0 ) { // If the currentSuffix starts with m_separator.value()
      m_inContNameList[i]  = m_inCont.value()  + currentSuffix;
      m_outContNameList[i] = m_outCont.value() + currentSuffix;
    }
    else {
      m_inContNameList[i]  = m_inCont.value()  + m_separator.value() + currentSuffix;
      m_outContNameList[i] = m_outCont.value() + m_separator.value() + currentSuffix;
    }
  }
  // Print out the matches that we found
  if ( msgLvl(MSG::VERBOSE) ) {
    for ( std::size_t i=0; i<m_inContNameList.size(); ++i ){
      ATH_MSG_VERBOSE("Matched input number " << i << " with input name " << m_inContNameList[i] << " to output name " << m_outContNameList[i]);
    }
  }
 
 
 
  // Now, also try to map all the view container names to the input (shallow
  // copy) containers. Set up with that the correct mapping of the new output
  // view container names.
  // Assume that all names where we have a suffix, but where we cannot match it
  // to a suffix of the input container, it belongs to the origninal one.
  if ( m_resetViewConts.value() || !(m_outPrefix.value().empty()) ){
    ATH_MSG_VERBOSE("Going to iterate over " << totSize << " elements");
    m_inViewContNameListList.reserve(totSize);
    m_outViewContNameListList.reserve(totSize);
    for ( std::size_t i=0; i<totSize; ++i ) {
      ATH_MSG_VERBOSE("At " << i << "-th element");
      if (i==0){
        // This is the master container without any "___" in its name
        std::vector<std::string> inViewNames;
        std::vector<std::string> outViewNames;
        for ( const std::string& inViewName : m_viewContNames.value() ){
          ATH_MSG_VERBOSE("Looking at input view container name: " << inViewName);
          std::size_t pos = inViewName.find(m_separator.value());
          if ( pos == std::string::npos ){ // the separator is not found
            ATH_MSG_VERBOSE("No seperator found");
            inViewNames.push_back(inViewName);
            outViewNames.push_back( m_outPrefix.value() + inViewName );
            ATH_MSG_VERBOSE("Added input name " << inViewNames.back() << " and output name " << outViewNames.back());
          }
          else {
            pos += m_separator.value().length();
            const std::string foundSuffix = inViewName.substr(pos, std::string::npos);
            ATH_MSG_VERBOSE("Seperator found and suffix found: " << foundSuffix);
            // the separator is found, but the found suffix doesn't match any of the provided ones
            if ( std::find( m_suffixes.value().begin(), m_suffixes.value().end(), foundSuffix) == m_suffixes.value().end() ){
              inViewNames.push_back(inViewName);
              outViewNames.push_back( m_outPrefix.value() + inViewName );
              ATH_MSG_VERBOSE("Added2 input name " << inViewNames.back() << " and output name " << outViewNames.back());
            }
          }
        }
        m_inViewContNameListList.push_back(inViewNames);
        m_outViewContNameListList.push_back(outViewNames);
      }
      else {
        const std::string& currentSuffix = m_suffixes.value()[i-1];
        ATH_MSG_VERBOSE("Looking at current suffix: " << currentSuffix);
        std::vector<std::string> inViewNames;
        std::vector<std::string> outViewNames;
        for ( const std::string& inViewName : m_viewContNames.value() ){
          ATH_MSG_VERBOSE("Looking at current input view container name: " << inViewName);
          if ( inViewName.find(m_separator.value()+currentSuffix) != std::string::npos ){ // the suffix is found
            inViewNames.push_back(inViewName);
            outViewNames.push_back( m_outPrefix.value() + inViewName );
            ATH_MSG_VERBOSE("Added3 input name " << inViewNames.back() << " and output name " << outViewNames.back());
          }
        }
        m_inViewContNameListList.push_back(inViewNames);
        m_outViewContNameListList.push_back(outViewNames);
      }
    } // End: loop over all containers
  }
  // Some sanity printouts
  if ( msgLvl(MSG::VERBOSE) ) {
    ATH_MSG_VERBOSE("Printing final input and output names...");
    for ( std::size_t i=0; i<m_inViewContNameListList.size(); ++i ){
      ATH_MSG_VERBOSE("    At i=" << i << "-th element");
      const std::vector<std::string>& inViewNameList  = m_inViewContNameListList[i];
      const std::vector<std::string>& outViewNameList = m_outViewContNameListList[i];
      ATH_MSG_VERBOSE("    Have " << inViewNameList.size() << " in view elements and " << outViewNameList.size() << " out view elements");
      for ( std::size_t j=0; j<inViewNameList.size(); ++j ){
        ATH_MSG_VERBOSE("        At j=" << j << "-th element");
        const std::string& inName  = inViewNameList[j];
        const std::string& outName = outViewNameList[j];
        ATH_MSG_VERBOSE("        Have input name " << inName << " paired with out name " << outName);
      }
    }
  }
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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.

removeParticles()

template<class CONT >

StatusCode ParticleRemoverAlg::removeParticles ( const std::vector< bool > &  keepParticleVec )

private

Private function to perform the actualy work.

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< Algorithm > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, PyAthena::Alg, and AthHistogramAlgorithm.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_contType

contType_t ParticleRemoverAlg::m_contType

private

The variable that holds the value that we find for the input container.

Definition at line 105 of file ParticleRemoverAlg.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_inCont

StringProperty ParticleRemoverAlg::m_inCont

private

The input container name.

Definition at line 42 of file ParticleRemoverAlg.h.

m_inContList

std::vector< const xAOD::IParticleContainer* > ParticleRemoverAlg::m_inContList

private

Vector of all input containers.

Definition at line 75 of file ParticleRemoverAlg.h.

m_inContNameList

std::vector<std::string> ParticleRemoverAlg::m_inContNameList

private

Vector of all input container names.

Definition at line 69 of file ParticleRemoverAlg.h.

m_inViewContNameListList

std::vector< std::vector<std::string> > ParticleRemoverAlg::m_inViewContNameListList

private

Vector of all input view container names.

Definition at line 81 of file ParticleRemoverAlg.h.

m_outCont

StringProperty ParticleRemoverAlg::m_outCont

private

The output container name.

Definition at line 48 of file ParticleRemoverAlg.h.

m_outContList

std::vector< xAOD::IParticleContainer* > ParticleRemoverAlg::m_outContList

private

Vector of all output containers.

Definition at line 78 of file ParticleRemoverAlg.h.

m_outContNameList

std::vector<std::string> ParticleRemoverAlg::m_outContNameList

private

Vector of all output container names.

Definition at line 72 of file ParticleRemoverAlg.h.

m_outPrefix

StringProperty ParticleRemoverAlg::m_outPrefix

private

Prefix to be used for all created output view containers.

Definition at line 60 of file ParticleRemoverAlg.h.

m_outViewContNameListList

std::vector< std::vector<std::string> > ParticleRemoverAlg::m_outViewContNameListList

private

Vector of all output view container names.

Definition at line 84 of file ParticleRemoverAlg.h.

m_resetViewConts

BooleanProperty ParticleRemoverAlg::m_resetViewConts

private

Boolean to decide if the existing view containers should be re-mapped (default: true)

Definition at line 57 of file ParticleRemoverAlg.h.

m_separator

StringProperty ParticleRemoverAlg::m_separator

private

The string separator between the output container name and the sytematic variation (default="___")

Definition at line 45 of file ParticleRemoverAlg.h.

m_suffixes

StringArrayProperty ParticleRemoverAlg::m_suffixes

private

The names of all suffixes for the input and output container names.

Definition at line 51 of file ParticleRemoverAlg.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_viewContNames

StringArrayProperty ParticleRemoverAlg::m_viewContNames

private

The names of all view containers that contain particles that we want to retain.

Definition at line 54 of file ParticleRemoverAlg.h.

---

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

• ParticleRemoverAlg.h
• ParticleRemoverAlg.cxx