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

SubsysReco module creating calorimeter tower objects (RawTowerv1) from hits (PHG4Hit) using j,k indeces of these hits. More...

#include <coresoftware/blob/master/simulation/g4simulation/g4calo/RawTowerBuilderByHitIndex.h>

+ Inheritance diagram for RawTowerBuilderByHitIndex:
+ Collaboration diagram for RawTowerBuilderByHitIndex:

Public Member Functions

 RawTowerBuilderByHitIndex (const std::string &name="RawTowerBuilderByHitIndex")
 
 ~RawTowerBuilderByHitIndex () override
 
int InitRun (PHCompositeNode *topNode) override
 
int process_event (PHCompositeNode *topNode) override
 
int End (PHCompositeNode *topNode) override
 Called at the end of all processing.
 
void Detector (const std::string &d)
 
void GeometryTableFile (const std::string &d)
 
void EminCut (const double e)
 
std::string get_sim_tower_node_prefix () const
 
void set_sim_tower_node_prefix (const std::string &simTowerNodePrefix)
 
- Public Member Functions inherited from SubsysReco
 ~SubsysReco () override
 
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.
 

Private Member Functions

void CreateNodes (PHCompositeNode *topNode)
 
bool ReadGeometryFromTable ()
 

Private Attributes

RawTowerContainerm_Towers = nullptr
 
RawTowerGeomContainerm_Geoms = nullptr
 
std::string m_Detector = "NONE"
 
std::string m_SimTowerNodePrefix
 
std::string m_MappingTowerFile = "default.txt"
 
RawTowerDefs::CalorimeterId m_CaloId = RawTowerDefs::NONE
 
double m_GlobalPlaceInX = 0.
 
double m_GlobalPlaceInY = 0.
 
double m_GlobalPlaceInZ = 0.
 
double m_RotInX = 0.
 
double m_RotInY = 0.
 
double m_RotInZ = 0.
 
double m_Emin = 1e-6
 
std::map< std::string, doublem_GlobalParameterMap
 

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
}
 
- Protected Member Functions inherited from SubsysReco
 SubsysReco (const std::string &name="NONAME")
 

Detailed Description

SubsysReco module creating calorimeter tower objects (RawTowerv1) from hits (PHG4Hit) using j,k indeces of these hits.

Definition at line 20 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 20 of file RawTowerBuilderByHitIndex.h

Constructor & Destructor Documentation

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

Definition at line 39 of file RawTowerBuilderByHitIndex.cc.

View newest version in sPHENIX GitHub at line 39 of file RawTowerBuilderByHitIndex.cc

RawTowerBuilderByHitIndex::~RawTowerBuilderByHitIndex ( )
inlineoverride

Definition at line 24 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 24 of file RawTowerBuilderByHitIndex.h

Member Function Documentation

void RawTowerBuilderByHitIndex::CreateNodes ( PHCompositeNode topNode)
private

Create nodes for output.

Name of output node for RawTowerContainer: "TOWER_" + detector;

Definition at line 157 of file RawTowerBuilderByHitIndex.cc.

View newest version in sPHENIX GitHub at line 157 of file RawTowerBuilderByHitIndex.cc

References PHCompositeNode::addNode(), RawTowerDefs::convert_name_to_caloid(), PHNodeIterator::findFirst(), m_Detector, m_Geoms, m_SimTowerNodePrefix, m_Towers, and PHWHERE.

Referenced by InitRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void RawTowerBuilderByHitIndex::Detector ( const std::string &  d)

Name of the detector node the G4Hits should be taken from.

Definition at line 151 of file RawTowerBuilderByHitIndex.cc.

View newest version in sPHENIX GitHub at line 151 of file RawTowerBuilderByHitIndex.cc

References RawTowerDefs::convert_name_to_caloid(), m_CaloId, and m_Detector.

Referenced by EEMC_Towers(), FEMC_Towers(), FHCAL_Towers(), and ZDC_Towers().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void RawTowerBuilderByHitIndex::EminCut ( const double  e)
inline

Define minimum tower energy. After processing an event, towers with lower energy are will be deleted.

Definition at line 46 of file RawTowerBuilderByHitIndex.h.

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

References Acts::UnitConstants::e, and m_Emin.

int RawTowerBuilderByHitIndex::End ( PHCompositeNode )
overridevirtual

Called at the end of all processing.

Reimplemented from SubsysReco.

Definition at line 146 of file RawTowerBuilderByHitIndex.cc.

View newest version in sPHENIX GitHub at line 146 of file RawTowerBuilderByHitIndex.cc

References Fun4AllReturnCodes::EVENT_OK.

void RawTowerBuilderByHitIndex::GeometryTableFile ( const std::string &  d)
inline

Specifiy text-file with table for tower mapping

Definition at line 38 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 38 of file RawTowerBuilderByHitIndex.h

References m_MappingTowerFile.

Referenced by EEMC_Towers(), FEMC_Towers(), FHCAL_Towers(), and ZDC_Towers().

+ Here is the caller graph for this function:

std::string RawTowerBuilderByHitIndex::get_sim_tower_node_prefix ( ) const
inline

Get prefix for tower collection to identify simulated towers before digitization.

Definition at line 52 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 52 of file RawTowerBuilderByHitIndex.h

References m_SimTowerNodePrefix.

int RawTowerBuilderByHitIndex::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 44 of file RawTowerBuilderByHitIndex.cc.

View newest version in sPHENIX GitHub at line 44 of file RawTowerBuilderByHitIndex.cc

References CreateNodes(), Acts::UnitConstants::e, Fun4AllReturnCodes::EVENT_OK, PHNodeIterator::findFirst(), PHWHERE, and ReadGeometryFromTable().

+ Here is the call graph for this function:

int RawTowerBuilderByHitIndex::process_event ( PHCompositeNode )
overridevirtual

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

Reimplemented from SubsysReco.

Definition at line 80 of file RawTowerBuilderByHitIndex.cc.

View newest version in sPHENIX GitHub at line 80 of file RawTowerBuilderByHitIndex.cc

References RawTowerContainer::AddTower(), RawTowerContainer::compress(), RawTowerDefs::encode_towerid(), Fun4AllReturnCodes::EVENT_OK, PHG4Hit::get_edep(), PHG4Hit::get_index_j(), PHG4Hit::get_index_k(), PHG4Hit::get_light_yield(), PHG4Hit::get_shower_id(), PHG4HitContainer::getHits(), RawTowerContainer::getTotalEdep(), RawTowerContainer::getTower(), RawTowerContainer::getTowers(), RawTowerContainer::identify(), m_CaloId, m_Detector, m_Emin, m_Towers, RawTowerContainer::size(), and Fun4AllBase::Verbosity().

+ Here is the call graph for this function:

bool RawTowerBuilderByHitIndex::ReadGeometryFromTable ( )
private

Read geometry information from table stored in text-file

Definition at line 210 of file RawTowerBuilderByHitIndex.cc.

View newest version in sPHENIX GitHub at line 210 of file RawTowerBuilderByHitIndex.cc

References RawTowerGeomContainer::add_tower_geometry(), RawTowerDefs::encode_towerid(), RawTowerGeomContainer::get_tower_geometries(), it, m_CaloId, m_Detector, m_Geoms, m_GlobalParameterMap, m_GlobalPlaceInX, m_GlobalPlaceInY, m_GlobalPlaceInZ, m_MappingTowerFile, m_RotInX, m_RotInY, m_RotInZ, RawTowerGeom::set_center_x(), RawTowerGeom::set_center_y(), RawTowerGeom::set_center_z(), RawTowerGeom::set_size_x(), RawTowerGeom::set_size_y(), RawTowerGeom::set_size_z(), RawTowerGeom::set_tower_type(), RawTowerGeomContainer::size(), G4HCALOUT::size_z, parse_cmake_options::type, and Fun4AllBase::Verbosity().

Referenced by InitRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void RawTowerBuilderByHitIndex::set_sim_tower_node_prefix ( const std::string &  simTowerNodePrefix)
inline

Set prefix for tower collection to identify simulated towers before digitization.

Definition at line 61 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 61 of file RawTowerBuilderByHitIndex.h

References m_SimTowerNodePrefix.

Referenced by EEMC_Towers(), FEMC_Towers(), FHCAL_Towers(), and ZDC_Towers().

+ Here is the caller graph for this function:

Member Data Documentation

RawTowerDefs::CalorimeterId RawTowerBuilderByHitIndex::m_CaloId = RawTowerDefs::NONE
private

Definition at line 85 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 85 of file RawTowerBuilderByHitIndex.h

Referenced by Detector(), process_event(), and ReadGeometryFromTable().

std::string RawTowerBuilderByHitIndex::m_Detector = "NONE"
private

Definition at line 80 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 80 of file RawTowerBuilderByHitIndex.h

Referenced by CreateNodes(), Detector(), process_event(), and ReadGeometryFromTable().

double RawTowerBuilderByHitIndex::m_Emin = 1e-6
private

Definition at line 95 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 95 of file RawTowerBuilderByHitIndex.h

Referenced by EminCut(), and process_event().

RawTowerGeomContainer* RawTowerBuilderByHitIndex::m_Geoms = nullptr
private

Definition at line 78 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 78 of file RawTowerBuilderByHitIndex.h

Referenced by CreateNodes(), and ReadGeometryFromTable().

std::map<std::string, double> RawTowerBuilderByHitIndex::m_GlobalParameterMap
private

Definition at line 97 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 97 of file RawTowerBuilderByHitIndex.h

Referenced by ReadGeometryFromTable().

double RawTowerBuilderByHitIndex::m_GlobalPlaceInX = 0.
private

Definition at line 87 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 87 of file RawTowerBuilderByHitIndex.h

Referenced by ReadGeometryFromTable().

double RawTowerBuilderByHitIndex::m_GlobalPlaceInY = 0.
private

Definition at line 88 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 88 of file RawTowerBuilderByHitIndex.h

Referenced by ReadGeometryFromTable().

double RawTowerBuilderByHitIndex::m_GlobalPlaceInZ = 0.
private

Definition at line 89 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 89 of file RawTowerBuilderByHitIndex.h

Referenced by ReadGeometryFromTable().

std::string RawTowerBuilderByHitIndex::m_MappingTowerFile = "default.txt"
private

Definition at line 83 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 83 of file RawTowerBuilderByHitIndex.h

Referenced by GeometryTableFile(), and ReadGeometryFromTable().

double RawTowerBuilderByHitIndex::m_RotInX = 0.
private

Definition at line 91 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 91 of file RawTowerBuilderByHitIndex.h

Referenced by ReadGeometryFromTable().

double RawTowerBuilderByHitIndex::m_RotInY = 0.
private

Definition at line 92 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 92 of file RawTowerBuilderByHitIndex.h

Referenced by ReadGeometryFromTable().

double RawTowerBuilderByHitIndex::m_RotInZ = 0.
private

Definition at line 93 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 93 of file RawTowerBuilderByHitIndex.h

Referenced by ReadGeometryFromTable().

std::string RawTowerBuilderByHitIndex::m_SimTowerNodePrefix
private

Definition at line 81 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 81 of file RawTowerBuilderByHitIndex.h

Referenced by CreateNodes(), get_sim_tower_node_prefix(), and set_sim_tower_node_prefix().

RawTowerContainer* RawTowerBuilderByHitIndex::m_Towers = nullptr
private

Definition at line 77 of file RawTowerBuilderByHitIndex.h.

View newest version in sPHENIX GitHub at line 77 of file RawTowerBuilderByHitIndex.h

Referenced by CreateNodes(), and process_event().


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