Class for shower library shower lib interface. More...

#include <IShowerLib.h>

Inheritance diagram for ShowerLib::IShowerLib:

Collaboration diagram for ShowerLib::IShowerLib:

Public Member Functions
virtual	~IShowerLib ()
	empty destructor More...

virtual std::vector< EnergySpot > *	getShower (const G4Track track, ShowerLibStatistics stats, int randomShift) const =0
	get shower for given G4 track More...

virtual double	getContainmentZ (const G4Track *track) const =0
	get average length of showers for the given energy More...

virtual double	getContainmentR (const G4Track *track) const =0
	get average lateral spread of the showers for the given energy More...

virtual bool	storeShower (HepMC::ConstGenParticlePtr genParticle, const Shower *shower)=0
	store shower in the library More...

virtual bool	writeToROOT (TFile *dest)=0
	write library to ROOT file More...

virtual ShowerLibStatistics *	createStatistics () const =0

const std::string	statistics () const
	print library statistics More...

virtual const std::string	detector () const
	get detector tag More...

virtual int	particle_id () const
	get particle tag More...

virtual const std::string	release () const
	get Release tag More...

virtual void	release (const std::string &release)
	set Release tag More...

virtual const std::string	geometry () const
	get Geometry tag More...

virtual void	geometry (const std::string &geometry)
	set Geometry tag More...

virtual const std::string	geantVersion () const
	get geant version tag More...

virtual void	geantVersion (const std::string &version)
	set geant version tag More...

virtual const std::string	physicsList () const
	get geant 4 physics list name More...

virtual void	physicsList (const std::string &list)
	set geant 4 physics list name More...

virtual const std::string	comment () const
	get comment More...

virtual void	comment (const std::string &comment)
	set given string as comment More...

virtual void	addComment (const std::string &comment)
	add given string to comment More...

virtual const std::string	getName () const

Protected Member Functions
	IShowerLib ()
	default constructor More...

bool	readMeta (TTree *source)
	read metadata from the given TTree More...

bool	writeMeta (TTree *dest) const
	write metadata to the given TTree More...

virtual const std::string	printParameters () const =0

Protected Attributes
std::string	m_detector
	name of the detector More...

int	m_particle
	ID of the generated particles. More...

std::string	m_release
	atlas software release More...

std::string	m_geometry
	atlas geometry version More...

std::string	m_geantVersion
	geant 4 version More...

std::string	m_physicsList
	used geant 4 physics list More...

std::string	m_comment
	comment More...

bool	m_filled
	is the library read from ROOT or from structure file More...

Detailed Description

Class for shower library shower lib interface.

   Define interface for top level shower library access

Author: Wolfgang Ehrenfeld, University of Hamburg, Germany; Sasha Glazov, DESY Hamburg, Germany

Version: $Id: IShowerLib.h 576158 2013-12-18 16:58:58Z gsedov $

Definition at line 40 of file IShowerLib.h.

Constructor & Destructor Documentation

◆ ~IShowerLib()

virtual ShowerLib::IShowerLib::~IShowerLib ( )

inlinevirtual

empty destructor

Definition at line 45 of file IShowerLib.h.

45 {}

◆ IShowerLib()

ShowerLib::IShowerLib::IShowerLib ( )

inlineprotected

default constructor

Definition at line 98 of file IShowerLib.h.

98 : m_detector("NotSet"), m_particle(0), m_release("NotSet"), m_geometry("NotSet"), m_geantVersion("NotSet"), m_physicsList("NotSet"), m_filled(false) {}

Member Function Documentation

◆ addComment()

void ShowerLib::IShowerLib::addComment ( const std::string & comment )

inlinevirtual

add given string to comment

Definition at line 141 of file IShowerLib.h.

141 { m_comment += comment; }

◆ comment() [1/2]

const std::string ShowerLib::IShowerLib::comment ( ) const

inlinevirtual

get comment

Definition at line 139 of file IShowerLib.h.

139 { return m_comment; }

◆ comment() [2/2]

void ShowerLib::IShowerLib::comment ( const std::string & comment )

inlinevirtual

set given string as comment

Definition at line 140 of file IShowerLib.h.

140 { m_comment = comment; }

◆ createStatistics()

virtual ShowerLibStatistics* ShowerLib::IShowerLib::createStatistics ( ) const

pure virtual

Implemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

◆ detector()

const std::string ShowerLib::IShowerLib::detector ( ) const

inlinevirtual

get detector tag

Definition at line 121 of file IShowerLib.h.

121 { return m_detector; }

◆ geantVersion() [1/2]

const std::string ShowerLib::IShowerLib::geantVersion ( ) const

inlinevirtual

get geant version tag

Definition at line 133 of file IShowerLib.h.

133 { return m_geantVersion; }

◆ geantVersion() [2/2]

void ShowerLib::IShowerLib::geantVersion ( const std::string & version )

inlinevirtual

set geant version tag

Definition at line 134 of file IShowerLib.h.

134 { m_geantVersion = version; }

◆ geometry() [1/2]

const std::string ShowerLib::IShowerLib::geometry ( ) const

inlinevirtual

get Geometry tag

Definition at line 130 of file IShowerLib.h.

130 { return m_geometry; }

◆ geometry() [2/2]

void ShowerLib::IShowerLib::geometry ( const std::string & geometry )

inlinevirtual

set Geometry tag

Definition at line 131 of file IShowerLib.h.

131 { m_geometry = geometry; }

◆ getContainmentR()

virtual double ShowerLib::IShowerLib::getContainmentR ( const G4Track * track ) const

pure virtual

get average lateral spread of the showers for the given energy

Implemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

◆ getContainmentZ()

virtual double ShowerLib::IShowerLib::getContainmentZ ( const G4Track * track ) const

pure virtual

get average length of showers for the given energy

Implemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

◆ getName()

virtual const std::string ShowerLib::IShowerLib::getName ( ) const

inlinevirtual

Reimplemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

Definition at line 93 of file IShowerLib.h.

93 { return "IShowerLib"; }

◆ getShower()

virtual std::vector<EnergySpot>* ShowerLib::IShowerLib::getShower	(	const G4Track *	track,
		ShowerLibStatistics *	stats,
		int	randomShift
	)		const

pure virtual

get shower for given G4 track

Implemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

◆ particle_id()

int ShowerLib::IShowerLib::particle_id ( ) const

inlinevirtual

get particle tag

Definition at line 124 of file IShowerLib.h.

124 { return m_particle; }

◆ physicsList() [1/2]

const std::string ShowerLib::IShowerLib::physicsList ( ) const

inlinevirtual

get geant 4 physics list name

Definition at line 136 of file IShowerLib.h.

136 { return m_physicsList; }

◆ physicsList() [2/2]

void ShowerLib::IShowerLib::physicsList ( const std::string & list )

inlinevirtual

set geant 4 physics list name

Definition at line 137 of file IShowerLib.h.

137 { m_physicsList = list; }

◆ printParameters()

virtual const std::string ShowerLib::IShowerLib::printParameters ( ) const

protectedpure virtual

Implemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

◆ readMeta()

bool ShowerLib::IShowerLib::readMeta ( TTree * source )

protected

read metadata from the given TTree

Definition at line 16 of file IShowerLib.cxx.

                                          {
       char detector[40];
       char release[40];
       char geometry[40];
       char geant[40];
       char physics[40];
       char comment[100];
       source->SetBranchAddress("detector",&detector);
       source->SetBranchAddress("particle",&m_particle);
       source->SetBranchAddress("release",&release);
       source->SetBranchAddress("geometry",&geometry);
       source->SetBranchAddress("geantVersion",&geant);
       source->SetBranchAddress("physicsList",&physics);
       source->SetBranchAddress("comment",&comment);
       source->GetEntry(0);
       m_detector = detector;
       m_release = release;
       m_geometry = geometry;
       m_geantVersion = geant;
       m_physicsList = physics;
       m_comment = comment;
       return true;
   }

◆ release() [1/2]

const std::string ShowerLib::IShowerLib::release ( ) const

inlinevirtual

get Release tag

Definition at line 127 of file IShowerLib.h.

127 { return m_release; }

◆ release() [2/2]

void ShowerLib::IShowerLib::release ( const std::string & release )

inlinevirtual

set Release tag

Definition at line 128 of file IShowerLib.h.

128 { m_release = release; }

◆ statistics()

const std::string ShowerLib::IShowerLib::statistics ( ) const

print library statistics

Definition at line 71 of file IShowerLib.cxx.

                                                {
  
       if (m_filled) {
       std::stringstream out;
  
       out << "======================================================" << std::endl;
       out << "             Statistics of the shower library         " << std::endl;
       out << "======================================================" << std::endl;
       out << "Library Type: "<< getName() <<" PARTICLE: " << m_particle << " DETECTOR: "<< m_detector << std::endl;
       out << m_release << " " << m_geometry << " " << m_geantVersion << " " << m_physicsList << std::endl;
       if (printParameters().length() > 0)
           out << printParameters() << std::endl;
       out << m_comment << std::endl;
       return out.str();
       } else { //statistics for the genlib, shorter version
       std::stringstream out;
       out << getName() <<" PARTICLE: " << m_particle << " DETECTOR: "<< m_detector << ", ";
       out << m_release << " " << m_geometry << " " << m_geantVersion << " " << m_physicsList << std::endl;
       if (printParameters().length() > 0)
           out << printParameters() << std::endl;
       out << m_comment << std::endl;
       return out.str();
       }
   }

◆ storeShower()

virtual bool ShowerLib::IShowerLib::storeShower	(	HepMC::ConstGenParticlePtr	genParticle,
		const Shower *	shower
	)

pure virtual

store shower in the library

Implemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

◆ writeMeta()

bool ShowerLib::IShowerLib::writeMeta ( TTree * dest ) const

protected

write metadata to the given TTree

Definition at line 40 of file IShowerLib.cxx.

                                                 {
       char detector[40];
       char release[40];
       char geometry[40];
       char geant[40];
       char physics[40];
       char comment[100];
       int  particle(m_particle);
       m_detector.copy(detector,39,0);
       detector[m_detector.length()] = '\0';
       m_release.copy(release,39,0);
       release[m_release.length()] = '\0';
       m_geometry.copy(geometry,39,0);
       geometry[m_geometry.length()] = '\0';
       m_geantVersion.copy(geant,39,0);
       geant[m_geantVersion.length()] = '\0';
       m_physicsList.copy(physics,39,0);
       physics[m_physicsList.length()] = '\0';
       m_comment.copy(comment,99,0);
       comment[m_comment.length()] = '\0';
       source->Branch("detector",&detector,"detector/C");
       source->Branch("particle",&particle,"particle/I");
       source->Branch("release",&release,"release/C");
       source->Branch("geometry",&geometry,"geometry/C");
       source->Branch("geantVersion",&geant,"geantVersion/C");
       source->Branch("physicsList",&physics,"physicsList/C");
       source->Branch("comment",&comment,"comment/C");
       source->Fill();
       return true;
   }

◆ writeToROOT()

virtual bool ShowerLib::IShowerLib::writeToROOT ( TFile * dest )

pure virtual

write library to ROOT file

Implemented in ShowerLib::FCALDistEtaEnergyShowerLib, ShowerLib::FCALDistEnergyShowerLib, ShowerLib::EtaEnergyShowerLib, and ShowerLib::TestShowerLib.

Member Data Documentation

◆ m_comment

std::string ShowerLib::IShowerLib::m_comment

protected

comment

Definition at line 112 of file IShowerLib.h.

◆ m_detector

std::string ShowerLib::IShowerLib::m_detector

protected

name of the detector

Definition at line 106 of file IShowerLib.h.

◆ m_filled

bool ShowerLib::IShowerLib::m_filled

protected

is the library read from ROOT or from structure file

Definition at line 114 of file IShowerLib.h.

◆ m_geantVersion

std::string ShowerLib::IShowerLib::m_geantVersion

protected

geant 4 version

Definition at line 110 of file IShowerLib.h.

◆ m_geometry

std::string ShowerLib::IShowerLib::m_geometry

protected

atlas geometry version

Definition at line 109 of file IShowerLib.h.

◆ m_particle

int ShowerLib::IShowerLib::m_particle

protected

ID of the generated particles.

Definition at line 107 of file IShowerLib.h.

◆ m_physicsList

std::string ShowerLib::IShowerLib::m_physicsList

protected

used geant 4 physics list

Definition at line 111 of file IShowerLib.h.

◆ m_release

std::string ShowerLib::IShowerLib::m_release

protected

atlas software release

Definition at line 108 of file IShowerLib.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~IShowerLib()

◆ IShowerLib()

Member Function Documentation

◆ addComment()

◆ comment() [1/2]

◆ comment() [2/2]

◆ createStatistics()

◆ detector()

◆ geantVersion() [1/2]

◆ geantVersion() [2/2]

◆ geometry() [1/2]

◆ geometry() [2/2]

◆ getContainmentR()

◆ getContainmentZ()

◆ getName()

◆ getShower()

◆ particle_id()

◆ physicsList() [1/2]

◆ physicsList() [2/2]

◆ printParameters()

◆ readMeta()

◆ release() [1/2]

◆ release() [2/2]

◆ statistics()

◆ storeShower()

◆ writeMeta()

◆ writeToROOT()

Member Data Documentation

◆ m_comment

◆ m_detector

◆ m_filled

◆ m_geantVersion

◆ m_geometry

◆ m_particle

◆ m_physicsList

◆ m_release