Class Reference for E1039 Core & Analysis Software
Public Member Functions | List of all members
RndmEmbed Class Reference

#include </dev/shm/kenichi/update-github-e1039-doc/e1039-core/packages/embedding/RndmEmbed.h>

+ Inheritance diagram for RndmEmbed:
+ Collaboration diagram for RndmEmbed:

Public Member Functions

 RndmEmbed (const std::string &name="RndmEmbed")
 
virtual ~RndmEmbed ()
 
int Init (PHCompositeNode *topNode)
 
int InitRun (PHCompositeNode *topNode)
 
int process_event (PHCompositeNode *topNode)
 
int End (PHCompositeNode *topNode)
 Called at the end of all processing. More...
 
int InitEvalTree ()
 
int ResetEvalVars ()
 
const std::string & get_hit_container_choice () const
 
void set_hit_container_choice (const std::string &hitContainerChoice)
 
const std::string & get_out_name () const
 
void set_out_name (const std::string &outName)
 
void print_noise_rate () const
 
void set_noise_rate (const std::string &name, const double &rate)
 
- Public Member Functions inherited from SubsysReco
virtual ~SubsysReco ()
 
virtual int EndRun (const int)
 Called at the end of each run. More...
 
virtual int Reset (PHCompositeNode *)
 Reset. More...
 
virtual int ResetEvent (PHCompositeNode *)
 Clean up after each event. More...
 
virtual void Print (const std::string &what="ALL") const
 
- Public Member Functions inherited from Fun4AllBase
virtual ~Fun4AllBase ()
 
virtual const std::string Name () const
 Returns the name of this module. More...
 
virtual void Name (const std::string &name)
 Sets the name of this module. More...
 
virtual void Verbosity (const int ival)
 Sets the verbosity of this module (0 by default=quiet). More...
 
virtual void Verbosity (enu_Verbosity ival)
 Sets the verbosity of this module (0 by default=quiet). More...
 
virtual int Verbosity () const
 Gets the verbosity of this module. More...
 

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 = INT_MAX - 10
}
 
- 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 inherited from Fun4AllBase
std::string ThisName
 
int verbosity
 The verbosity level. 0 means not verbose at all. More...
 

Detailed Description

Definition at line 43 of file RndmEmbed.h.

Constructor & Destructor Documentation

◆ RndmEmbed()

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

Definition at line 58 of file RndmEmbed.cxx.

◆ ~RndmEmbed()

virtual RndmEmbed::~RndmEmbed ( )
inlinevirtual

Definition at line 48 of file RndmEmbed.h.

Member Function Documentation

◆ End()

int RndmEmbed::End ( PHCompositeNode *  )
virtual

Called at the end of all processing.

Reimplemented from SubsysReco.

Definition at line 194 of file RndmEmbed.cxx.

References PHTFileServer::cd(), Fun4AllReturnCodes::EVENT_OK, PHTFileServer::get(), Fun4AllBase::Verbosity(), and Fun4AllBase::VERBOSITY_SOME.

+ Here is the call graph for this function:

◆ get_hit_container_choice()

const std::string& RndmEmbed::get_hit_container_choice ( ) const
inline

Definition at line 59 of file RndmEmbed.h.

◆ get_out_name()

const std::string& RndmEmbed::get_out_name ( ) const
inline

Definition at line 67 of file RndmEmbed.h.

◆ Init()

int RndmEmbed::Init ( PHCompositeNode *  )
virtual

Called during initialization, i.e. registered via Fun4AllServer::registerSubsystem(). Typically this is where you can book histograms, and e.g. register them to Fun4AllServer (so they can be output to file using Fun4AllServer::dumpHistos() method).

Reimplemented from SubsysReco.

Definition at line 69 of file RndmEmbed.cxx.

References Fun4AllReturnCodes::EVENT_OK.

◆ InitEvalTree()

int RndmEmbed::InitEvalTree ( )

Definition at line 204 of file RndmEmbed.cxx.

References PHTFileServer::get(), and PHTFileServer::open().

Referenced by InitRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ InitRun()

int RndmEmbed::InitRun ( PHCompositeNode *  )
virtual

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 73 of file RndmEmbed.cxx.

References Fun4AllReturnCodes::EVENT_OK, InitEvalTree(), GeomSvc::instance(), and ResetEvalVars().

+ Here is the call graph for this function:

◆ print_noise_rate()

void RndmEmbed::print_noise_rate ( ) const
inline

Definition at line 75 of file RndmEmbed.h.

◆ process_event()

int RndmEmbed::process_event ( PHCompositeNode *  )
virtual

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

Reimplemented from SubsysReco.

Definition at line 86 of file RndmEmbed.cxx.

References Fun4AllReturnCodes::ABORTRUN, Fun4AllReturnCodes::EVENT_OK, GeomSvc::getDetectorID(), GeomSvc::getMeasurement(), GeomSvc::getPlane(), LogInfo, Plane::nElements, SQHitVector::push_back(), ResetEvalVars(), SQHitVector::size(), Plane::spacing, Fun4AllBase::Verbosity(), and Fun4AllBase::VERBOSITY_SOME.

+ Here is the call graph for this function:

◆ ResetEvalVars()

int RndmEmbed::ResetEvalVars ( )

Definition at line 212 of file RndmEmbed.cxx.

Referenced by InitRun(), and process_event().

+ Here is the caller graph for this function:

◆ set_hit_container_choice()

void RndmEmbed::set_hit_container_choice ( const std::string &  hitContainerChoice)
inline

Definition at line 63 of file RndmEmbed.h.

◆ set_noise_rate()

void RndmEmbed::set_noise_rate ( const std::string &  name,
const double &  rate 
)
inline

Definition at line 81 of file RndmEmbed.h.

◆ set_out_name()

void RndmEmbed::set_out_name ( const std::string &  outName)
inline

Definition at line 71 of file RndmEmbed.h.

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