Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PHInitVertexing Class Referenceabstract

Base class for inital vertexing. More...

#include <coresoftware/blob/master/offline/packages/trackreco/PHInitVertexing.h>

+ Inheritance diagram for PHInitVertexing:
+ Collaboration diagram for PHInitVertexing:

Public Member Functions

 PHInitVertexing (const std::string &name="PHInitVertexing")
 
 ~PHInitVertexing () override=default
 
int InitRun (PHCompositeNode *topNode) override
 
int process_event (PHCompositeNode *topNode) override
 
- Public Member Functions inherited from SubsysReco
 ~SubsysReco () override
 
virtual int End (PHCompositeNode *)
 Called at the end of all processing.
 
virtual int EndRun (const int)
 Called at the end of each run.
 
virtual int Init (PHCompositeNode *)
 
virtual int Reset (PHCompositeNode *)
 Reset.
 
virtual int ResetEvent (PHCompositeNode *)
 Clean up after each event.
 
void Print (const std::string &="ALL") const override
 
- Public Member Functions inherited from Fun4AllBase
virtual ~Fun4AllBase ()
 
virtual const std::string Name () const
 Returns the name of this module.
 
virtual void Name (const std::string &name)
 Sets the name of this module.
 
virtual void Verbosity (const int ival)
 Sets the verbosity of this module (0 by default=quiet).
 
virtual void Verbosity (enu_Verbosity ival)
 Sets the verbosity of this module (0 by default=quiet).
 
virtual int Verbosity () const
 Gets the verbosity of this module.
 

Protected Member Functions

virtual int Setup (PHCompositeNode *topNode)
 
virtual int Process (PHCompositeNode *topNode)=0
 
- Protected Member Functions inherited from SubsysReco
 SubsysReco (const std::string &name="NONAME")
 
- Protected Member Functions inherited from Fun4AllBase
 Fun4AllBase (const std::string &name="NONAME")
 

Protected Attributes

TrkrClusterContainer_cluster_map = nullptr
 
SvtxVertexMap_vertex_map = nullptr
 

Private Member Functions

int CreateNodes (PHCompositeNode *topNode)
 create new node output pointers
 
int GetNodes (PHCompositeNode *topNode)
 fetch node pointers
 

Additional Inherited Members

- Public Types inherited from Fun4AllBase
enum  enu_Verbosity {
  VERBOSITY_QUIET = 0, VERBOSITY_SOME = 1, VERBOSITY_MORE = 2, VERBOSITY_EVEN_MORE = 3,
  VERBOSITY_A_LOT = 4, VERBOSITY_MAX = std::numeric_limits<int>::max() - 10
}
 

Detailed Description

Base class for inital vertexing.

Definition at line 26 of file PHInitVertexing.h.

View newest version in sPHENIX GitHub at line 26 of file PHInitVertexing.h

Constructor & Destructor Documentation

PHInitVertexing::PHInitVertexing ( const std::string &  name = "PHInitVertexing")

Definition at line 22 of file PHInitVertexing.cc.

View newest version in sPHENIX GitHub at line 22 of file PHInitVertexing.cc

PHInitVertexing::~PHInitVertexing ( )
overridedefault

Member Function Documentation

int PHInitVertexing::CreateNodes ( PHCompositeNode topNode)
private

create new node output pointers

Definition at line 47 of file PHInitVertexing.cc.

View newest version in sPHENIX GitHub at line 47 of file PHInitVertexing.cc

References _vertex_map, Fun4AllReturnCodes::ABORTEVENT, PHCompositeNode::addNode(), Fun4AllReturnCodes::EVENT_OK, PHNodeIterator::findFirst(), PHWHERE, and Fun4AllBase::Verbosity().

Referenced by Setup().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int PHInitVertexing::GetNodes ( PHCompositeNode topNode)
private

fetch node pointers

Definition at line 83 of file PHInitVertexing.cc.

View newest version in sPHENIX GitHub at line 83 of file PHInitVertexing.cc

References _cluster_map, _vertex_map, Fun4AllReturnCodes::ABORTEVENT, Fun4AllReturnCodes::EVENT_OK, and PHWHERE.

Referenced by Setup().

+ Here is the caller graph for this function:

int PHInitVertexing::InitRun ( PHCompositeNode )
overridevirtual

Called for first event when run number is known. Typically this is where you may want to fetch data from database, because you know the run number.

Reimplemented from SubsysReco.

Definition at line 26 of file PHInitVertexing.cc.

View newest version in sPHENIX GitHub at line 26 of file PHInitVertexing.cc

References Setup().

+ Here is the call graph for this function:

virtual int PHInitVertexing::Process ( PHCompositeNode topNode)
protectedpure virtual

process event interface for trackers, called in process_event. implemented in derived classes

Implemented in PHActsInitialVertexFinder, PHTruthVertexing, and PHActsVertexFinder.

Referenced by process_event().

+ Here is the caller graph for this function:

int PHInitVertexing::process_event ( PHCompositeNode )
overridevirtual

Called for each event. This is where you do the real work.

Reimplemented from SubsysReco.

Definition at line 31 of file PHInitVertexing.cc.

View newest version in sPHENIX GitHub at line 31 of file PHInitVertexing.cc

References Process().

+ Here is the call graph for this function:

int PHInitVertexing::Setup ( PHCompositeNode topNode)
protectedvirtual

setup interface for trackers, called in InitRun, setup things like pointers to nodes. overrided in derived classes

Reimplemented in PHActsInitialVertexFinder, PHTruthVertexing, and PHActsVertexFinder.

Definition at line 36 of file PHInitVertexing.cc.

View newest version in sPHENIX GitHub at line 36 of file PHInitVertexing.cc

References CreateNodes(), Fun4AllReturnCodes::EVENT_OK, and GetNodes().

Referenced by InitRun(), and PHTruthVertexing::Setup().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

TrkrClusterContainer* PHInitVertexing::_cluster_map = nullptr
protected

Definition at line 46 of file PHInitVertexing.h.

View newest version in sPHENIX GitHub at line 46 of file PHInitVertexing.h

Referenced by GetNodes().

SvtxVertexMap* PHInitVertexing::_vertex_map = nullptr
protected

Definition at line 47 of file PHInitVertexing.h.

View newest version in sPHENIX GitHub at line 47 of file PHInitVertexing.h

Referenced by PHTruthVertexing::assignTracksVertices(), CreateNodes(), GetNodes(), and PHTruthVertexing::Process().


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