Trk::MCTrueSeedFinder Class Reference

#include <MCTrueSeedFinder.h>

Inheritance diagram for Trk::MCTrueSeedFinder:

Collaboration diagram for Trk::MCTrueSeedFinder:

Public Member Functions
	MCTrueSeedFinder (const std::string &t, const std::string &n, const IInterface *p)
virtual	~MCTrueSeedFinder ()
virtual StatusCode	initialize () override
virtual Amg::Vector3D	findSeed (const std::vector< const Trk::Track * > &vectorTrk, const xAOD::Vertex *constraint=0) const override final
	Finds a linearization point out of a vector of tracks and returns it as an Amg::Vector3D object.
virtual Amg::Vector3D	findSeed (const std::vector< const Trk::TrackParameters * > &perigeeList, const xAOD::Vertex *constraint=0) const override final
	Finds a linearization point out of a vector of TrackParameters and returns it as an Amg::Vector3D object.
virtual std::vector< Amg::Vector3D >	findMultiSeeds (const std::vector< const Trk::Track * > &vectorTrk, const xAOD::Vertex *constraint=0) const override final
	Finds full vector of linearization points from a vector of tracks and returns it as an Amg::Vector3D object.
virtual std::vector< Amg::Vector3D >	findMultiSeeds (const std::vector< const Trk::TrackParameters * > &perigeeList, const xAOD::Vertex *constraint=0) const override final
	Finds full vector of linearization points from a vector of TrackParameters and returns it as an Amg::Vector3D object.
virtual Amg::Vector3D	findSeed (const double, const double, const std::vector< const Trk::TrackParameters * > &perigeeList, const xAOD::Vertex *constraint=0) const
	Finds a linearization point out of a vector of TrackParameters and returns it as an Amg::Vector3D object.
virtual Amg::Vector3D	findSeed (const double, const double, std::unique_ptr< Trk::IMode3dInfo > &, const std::vector< const Trk::TrackParameters * > &perigeeList, const xAOD::Vertex *constraint=0) const
	Finds a linearization point out of a vector of TrackParameters and returns it as an Amg::Vector3D object.

Private Member Functions
bool	pass (const HepMC::GenEvent *evt, const McEventCollection *coll=0) const
	Function selecting GenEvent objects.
bool	pass (const HepMC::ConstGenParticlePtr &part, const McEventCollection *coll=0) const
	Function selecting GenParticle objects.
StatusCode	retrieveInteractionsInfo (std::vector< Amg::Vector3D > &interactions) const

Private Attributes
SG::ReadHandleKey< McEventCollection >	m_mcEventCollectionKey
ServiceHandle< IPartPropSvc >	m_partPropSvc
	Get particle properties.
bool	m_removeInTimePileUp
	Flag to consider in-time pile-up interactions.
bool	m_removeHardScattering
	Flag to consider hard-scattering interaction.

Detailed Description

Definition at line 35 of file MCTrueSeedFinder.h.

Constructor & Destructor Documentation

MCTrueSeedFinder()

Trk::MCTrueSeedFinder::MCTrueSeedFinder	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 50 of file MCTrueSeedFinder.cxx.

                                                                                                 : 
    base_class(t,n,p),
    m_partPropSvc( "PartPropSvc", n ),
    m_removeInTimePileUp(false),
    m_removeHardScattering(false)
  {   
    declareProperty("RemoveHardScattering", m_removeHardScattering, "Do not consider hard-scattering");
    declareProperty("RemoveInTimePileUp", m_removeInTimePileUp, "Do not consider in-time pile-up");
    declareProperty( "PartPropSvc", m_partPropSvc, "Handle to the particle property service" );
  }

~MCTrueSeedFinder()

Trk::MCTrueSeedFinder::~MCTrueSeedFinder ( )

virtualdefault

Member Function Documentation

findMultiSeeds() [1/2]

std::vector< Amg::Vector3D > Trk::MCTrueSeedFinder::findMultiSeeds ( const std::vector< const Trk::Track * > & vectorTrk, const xAOD::Vertex * constraint = 0 ) const

finaloverridevirtual

Finds full vector of linearization points from a vector of tracks and returns it as an Amg::Vector3D object.

Intended for seed finders that produce all at once. If you want an additional constraint can be taken into account.

Definition at line 108 of file MCTrueSeedFinder.cxx.

  {
    std::vector<Amg::Vector3D> seeds;
    if( retrieveInteractionsInfo (seeds).isFailure() ) {
      seeds.clear();
    }
 
    return seeds;
  }

findMultiSeeds() [2/2]

std::vector< Amg::Vector3D > Trk::MCTrueSeedFinder::findMultiSeeds ( const std::vector< const Trk::TrackParameters * > & perigeeList, const xAOD::Vertex * constraint = 0 ) const

finaloverridevirtual

Finds full vector of linearization points from a vector of TrackParameters and returns it as an Amg::Vector3D object.

Intended for seed finders that produce all at once. If you want an additional constraint can be taken into account.

Definition at line 97 of file MCTrueSeedFinder.cxx.

  {
    std::vector<Amg::Vector3D> seeds;
    if( retrieveInteractionsInfo (seeds).isFailure() ) {
      seeds.clear();
    }
 
    return seeds;
  }

findSeed() [1/4]

virtual Amg::Vector3D Trk::IVertexSeedFinder::findSeed ( const double , const double , const std::vector< const Trk::TrackParameters * > & perigeeList, const xAOD::Vertex * constraint = 0 ) const

inline

Finds a linearization point out of a vector of TrackParameters and returns it as an Amg::Vector3D object.

If you want an additional constraint can be taken into account. Must specify the primary vertex position.

Definition at line 79 of file IVertexSeedFinder.h.

    {
      return findSeed (perigeeList, constraint);
    }

findSeed() [2/4]

virtual Amg::Vector3D Trk::IVertexSeedFinder::findSeed ( const double , const double , std::unique_ptr< Trk::IMode3dInfo > & , const std::vector< const Trk::TrackParameters * > & perigeeList, const xAOD::Vertex * constraint = 0 ) const

inline

Finds a linearization point out of a vector of TrackParameters and returns it as an Amg::Vector3D object.

If you want an additional constraint can be taken into account. Must specify the primary vertex position. Allows returning additional diagnostic information.

Definition at line 96 of file IVertexSeedFinder.h.

    {
      return findSeed (perigeeList, constraint);
    }

findSeed() [3/4]

Amg::Vector3D Trk::MCTrueSeedFinder::findSeed ( const std::vector< const Trk::Track * > & vectorTrk, const xAOD::Vertex * constraint = 0 ) const

finaloverridevirtual

Finds a linearization point out of a vector of tracks and returns it as an Amg::Vector3D object.

If you want an additional constraint can be taken into account.

Definition at line 74 of file MCTrueSeedFinder.cxx.

  {
    std::vector<Amg::Vector3D> seeds = findMultiSeeds (perigeeList, constraint);
    if (seeds.empty()) {
      return Amg::Vector3D(0.,0.,0.);
    }
    return seeds[0];
  }

findSeed() [4/4]

Amg::Vector3D Trk::MCTrueSeedFinder::findSeed ( const std::vector< const Trk::TrackParameters * > & perigeeList, const xAOD::Vertex * constraint = 0 ) const

finaloverridevirtual

Finds a linearization point out of a vector of TrackParameters and returns it as an Amg::Vector3D object.

If you want an additional constraint can be taken into account.

Definition at line 86 of file MCTrueSeedFinder.cxx.

  {
    std::vector<Amg::Vector3D> seeds = findMultiSeeds (vectorTrk, constraint);
    if (seeds.empty()) {
      return Amg::Vector3D(0.,0.,0.);
    }
    return seeds[0];
  }

initialize()

StatusCode Trk::MCTrueSeedFinder::initialize ( )

overridevirtual

Definition at line 66 of file MCTrueSeedFinder.cxx.

  { 
    ATH_CHECK( m_mcEventCollectionKey.initialize() );
    return StatusCode::SUCCESS;
  }

pass() [1/2]

bool Trk::MCTrueSeedFinder::pass ( const HepMC::ConstGenParticlePtr & part, const McEventCollection * coll = 0 ) const

private

Function selecting GenParticle objects.

remove gluons and quarks of status 2 that pass IsGenStable!!!

Definition at line 221 of file MCTrueSeedFinder.cxx.

                                                         {
 
    // Check if the particle is coming from a "good" GenEvent:
    if( ! pass( part->parent_event(), coll ) ) return false;
 
    // Now check for stable particles
    if (!HepMC::is_simulation_particle(part)) {
      if( ! MC::isGenStable( part ) ) return false;
      if( ! MC::isSimInteracting( part ) ) return false;
    }
 
    // finally require it to be charged
    int pdg = part->pdg_id();

    if( std::abs(pdg) < 7 || std::abs(pdg) == 21 ) return false;
 
    const HepPDT::ParticleData* pd = m_partPropSvc->PDT()->particle( std::abs( pdg ) );
    if( ! pd ) {
      ATH_MSG_DEBUG( "Could not get particle data for = " << part 
             << " process id " <<HepMC::signal_process_id(part->parent_event()));
      return false;
    }
    float charge = pd->charge();
 
    return std::abs( charge ) >= 1E-5;
  }

pass() [2/2]

bool Trk::MCTrueSeedFinder::pass ( const HepMC::GenEvent * evt, const McEventCollection * coll = 0 ) const

private

Function selecting GenEvent objects.

Definition at line 179 of file MCTrueSeedFinder.cxx.

                                                         {
 
    //we select in-time pile-up interactions and hard-scattering, if valid
 
 
    bool isEmpty = ( evt->particles_size() == 0 );
    bool isDummy = ( ( evt->event_number() == -1 ) &&
             ( HepMC::signal_process_id(evt) == 0 ) );
    if( isDummy ) isEmpty = false;
 
    if( isEmpty ) return false;
    if( isDummy ) return false;
 
    // We can't do the further selection without the full truth record:
    if( ! coll ) return true;
 
    McEventCollection::const_iterator iter = coll->begin();
    McEventCollection::const_iterator end = coll->end();
 
    if( *iter == evt ) {
      //this is the hard-scattering event (first of the collection)
      return ! m_removeHardScattering;
    }
 
    int gotzero = 1;
    for( ; iter != end; ++iter ) {
      if( ( ( ( *iter )->event_number() == -1 ) &&
            ( HepMC::signal_process_id( *iter ) == 0 ) ) ) {
    ++gotzero;
      }
      if( evt == *iter ) break;
    }
 
    if( gotzero == 1 && m_removeInTimePileUp ) return false;
    if( gotzero == 2 ) return false; //remove2BCPileUp
    if( gotzero == 3 ) return false; //remove800nsPileUp
    if( gotzero == 4 ) return false; //removeCavernBkg
 
    return true;
  }

retrieveInteractionsInfo()

StatusCode Trk::MCTrueSeedFinder::retrieveInteractionsInfo ( std::vector< Amg::Vector3D > & interactions ) const

private

Definition at line 119 of file MCTrueSeedFinder.cxx.

  {
    ATH_MSG_DEBUG("Retrieving interactions information");
    msg(MSG::DEBUG) << "StoreGate Step: MCTrueSeedFinder retrieves -- " << m_mcEventCollectionKey.key() << endmsg;
    SG::ReadHandle<McEventCollection> mcEventCollection( m_mcEventCollectionKey );
    if ( !mcEventCollection.isValid() ) {
      msg(MSG::DEBUG)
    << "Could not retrieve McEventCollection/" << m_mcEventCollectionKey.key() << " from StoreGate."  << endmsg;
      return StatusCode::FAILURE;
    }
 
    interactions.clear();    
    std::vector<Interactions_pair> interactionsColl;
    McEventCollection::const_iterator itr = mcEventCollection->begin();
    for ( ; itr != mcEventCollection->end(); ++itr ) {
      const HepMC::GenEvent* myEvent=(*itr);
      if(!pass( myEvent, mcEventCollection.cptr())) continue; //checked if events is acceptable
      
      
      //get "intensity" (scalar sum ot p_T^2)
      double sum_pt2(0.0);
      for (const auto& part: *myEvent) {
    if(!pass(part, mcEventCollection.cptr())) continue; //select stable charged particles
    sum_pt2 += part->momentum().perp2();
      }
      ATH_MSG_DEBUG("Calculated Sum P_T^2 = " << sum_pt2);
      
      //get position of interaction from first non-zero vertex
      Amg::Vector3D vtxPosition;
#ifdef HEPMC3
      auto Vert = myEvent->vertices().begin();
#else
      HepMC::GenEvent::vertex_const_iterator Vert = myEvent->vertices_begin();
#endif
      msg(MSG::DEBUG) << "Retrieved position  x: " << (*Vert)->position().x()  << 
    " y: " << (*Vert)->position().y() << 
    " z: " << (*Vert)->position().z() << endmsg;
      vtxPosition = Amg::Vector3D((*Vert)->position().x(),
                  (*Vert)->position().y(),
                  (*Vert)->position().z());
      
      //now store info about position and "intensity" (here: scalar sum of p_T^2)
      interactionsColl.emplace_back(sum_pt2, vtxPosition );
    } // end loop over GenEvent
 
    //now sort the container and store results to interactions
    std::sort(interactionsColl.begin(), interactionsColl.end());
    std::vector<Interactions_pair>::iterator itIp = interactionsColl.begin();
    ATH_MSG_DEBUG("Sorted collection:");
    for (; itIp < interactionsColl.end(); ++itIp) {
      interactions.push_back(itIp->second);
      ATH_MSG_DEBUG("(" << itIp->second.x() << ", " << itIp->second.y() << ", " 
            << itIp->second.z() << "), SumPt2 = " << itIp->first);
    }
 
    ATH_MSG_DEBUG("New interactions info stored successfully: " << interactions.size() << " interactions found.");
    return StatusCode::SUCCESS;
 
  }

Member Data Documentation

m_mcEventCollectionKey

SG::ReadHandleKey<McEventCollection> Trk::MCTrueSeedFinder::m_mcEventCollectionKey

private

Initial value:

{
      this,
      "McTruthCollection",
      "G4Truth",
      "MC Event Collection Name"
    }

Definition at line 95 of file MCTrueSeedFinder.h.

                                                             {
      this,
      "McTruthCollection",
      "G4Truth",
      "MC Event Collection Name"
    };

m_partPropSvc

ServiceHandle< IPartPropSvc > Trk::MCTrueSeedFinder::m_partPropSvc

private

Get particle properties.

Definition at line 103 of file MCTrueSeedFinder.h.

m_removeHardScattering

bool Trk::MCTrueSeedFinder::m_removeHardScattering

private

Flag to consider hard-scattering interaction.

Definition at line 107 of file MCTrueSeedFinder.h.

m_removeInTimePileUp

bool Trk::MCTrueSeedFinder::m_removeInTimePileUp

private

Flag to consider in-time pile-up interactions.

Definition at line 106 of file MCTrueSeedFinder.h.

---

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

• MCTrueSeedFinder.h
• MCTrueSeedFinder.cxx