Class for shower library shower lib. More...

#include <TestShowerLib.h>

Inheritance diagram for ShowerLib::TestShowerLib:

Collaboration diagram for ShowerLib::TestShowerLib:

Classes
struct	genInfo

Public Member Functions
virtual	~TestShowerLib ()
	default destructor More...

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

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

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

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

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

virtual ShowerLibStatistics *	createStatistics () const

virtual const std::string	getName () const

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...

Static Public Member Functions
static IShowerLib *	readFromROOTFile (TFile *source)
	factory method. create a library from root file. returns NULL if file is invalid. More...

static IShowerLib *	createEmptyLib (const std::string &inputFile)
	factory method. create empty library with the given structure. returns NULL if file is invalid. More...

Protected Member Functions
virtual const std::string	printParameters () const

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

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

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...

Private Types
typedef std::pair< genInfo, Shower >	storedShower

typedef std::list< storedShower >	library

Private Member Functions
	TestShowerLib ()

bool	read (TTree *source)
	read library from given TTree More...

bool	write (TTree *dest) const
	write library to given TTree More...

Private Attributes
library	m_libData

Detailed Description

Class for shower library shower lib.

   Store complete shower library (collection of energy bins)

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

Version: $Id: TestShowerLib.h 769594 2016-08-23 13:48:34Z ssnyder $

Definition at line 35 of file TestShowerLib.h.

Member Typedef Documentation

◆ library

typedef std::list<storedShower> ShowerLib::TestShowerLib::library

private

Definition at line 77 of file TestShowerLib.h.

◆ storedShower

typedef std::pair<genInfo,Shower> ShowerLib::TestShowerLib::storedShower

private

Definition at line 76 of file TestShowerLib.h.

Constructor & Destructor Documentation

◆ ~TestShowerLib()

ShowerLib::TestShowerLib::~TestShowerLib ( )

virtual

default destructor

Definition at line 37 of file TestShowerLib.cxx.

38 {

39 }

◆ TestShowerLib()

ShowerLib::TestShowerLib::TestShowerLib ( )

inlineprivate

Definition at line 69 of file TestShowerLib.h.

69 {}

Member Function Documentation

◆ addComment()

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

inlinevirtualinherited

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

inlinevirtualinherited

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 )

inlinevirtualinherited

set given string as comment

Definition at line 140 of file IShowerLib.h.

140 { m_comment = comment; }

◆ createEmptyLib()

IShowerLib * ShowerLib::TestShowerLib::createEmptyLib ( const std::string & inputFile )

static

factory method. create empty library with the given structure. returns NULL if file is invalid.

Definition at line 67 of file TestShowerLib.cxx.

   {
       /*
        * Test library Structure format:
        *
        * VER PART DET
        * COMMENT
        *
        * where
        *
        * VER == 10
        */
       std::ifstream filestr(inputFile.c_str(),std::ios::in);
  
       if (!filestr.is_open()) {
           std::cout << "TestShowerLib         " << inputFile << ": bad file!" << std::endl;
           return nullptr;
       }
  
       std::string instr;
       std::getline(filestr,instr);
       std::stringstream ss(instr);
  
       int ver;
  
       ss >> ver;
  
       if (ver != LIB_VERSION) {
           return nullptr;
       }
  
  
       int part;
       std::string det;
  
       ss >> part >> det;
  
  
       TestShowerLib* newlib = new TestShowerLib();
  
       newlib->m_detector = std::move(det);
       newlib->m_particle = part;
       newlib->m_filled = false;
  
       std::getline(filestr,instr);
       newlib->m_comment = std::move(instr);
  
       return newlib;
   }

◆ createStatistics()

ShowerLibStatistics * ShowerLib::TestShowerLib::createStatistics ( ) const

virtual

Implements ShowerLib::IShowerLib.

Definition at line 281 of file TestShowerLib.cxx.

   {
       return nullptr;
   }

◆ detector()

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

inlinevirtualinherited

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

inlinevirtualinherited

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 )

inlinevirtualinherited

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

inlinevirtualinherited

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 )

inlinevirtualinherited

set Geometry tag

Definition at line 131 of file IShowerLib.h.

131 { m_geometry = geometry; }

◆ getContainmentR()

double ShowerLib::TestShowerLib::getContainmentR ( const G4Track * track ) const

virtual

get average lateral spread of the showers for the given energy

Implements ShowerLib::IShowerLib.

Definition at line 140 of file TestShowerLib.cxx.

   {
       if (!m_filled) {
           std::cout << "Library is not created for production use" << std::endl;
           return 0.0;
       }
  
       std::cout << "Library is only for testing, not for production use" << std::endl;
       return 0.0;
   }

◆ getContainmentZ()

double ShowerLib::TestShowerLib::getContainmentZ ( const G4Track * track ) const

virtual

get average length of showers for the given energy

Implements ShowerLib::IShowerLib.

Definition at line 129 of file TestShowerLib.cxx.

   {
       if (!m_filled) {
           std::cout << "Library is not created for production use" << std::endl;
           return 0.0;
       }
  
       std::cout << "Library is only for testing, not for production use" << std::endl;
       return 0.0;
   }

◆ getName()

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

inlinevirtual

Reimplemented from ShowerLib::IShowerLib.

Definition at line 61 of file TestShowerLib.h.

61 { return "Test Energy ShowerLib"; }

◆ getShower()

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

virtual

get shower for given G4 track

Implements ShowerLib::IShowerLib.

Definition at line 118 of file TestShowerLib.cxx.

   {
       if (!m_filled) {
           std::cout << "Library is not created for production use" << std::endl;
           return nullptr;
       }
  
       std::cout << "Library is only for testing, not for production use" << std::endl;
       return nullptr;
   }

◆ particle_id()

int ShowerLib::IShowerLib::particle_id ( ) const

inlinevirtualinherited

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

inlinevirtualinherited

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 )

inlinevirtualinherited

set geant 4 physics list name

Definition at line 137 of file IShowerLib.h.

137 { m_physicsList = list; }

◆ printParameters()

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

inlineprotectedvirtual

Implements ShowerLib::IShowerLib.

Definition at line 65 of file TestShowerLib.h.

65 {return "";}

◆ read()

bool ShowerLib::TestShowerLib::read ( TTree * source )

private

read library from given TTree

Definition at line 187 of file TestShowerLib.cxx.

   {
       /*
        * Eta Energy library format:
        * |       x      |       y      |       z      |    e     |  time  |  - name of branch in TTree
        * ------------------------------------------------------------------
        * |    vertex    |    vertex    |    vertex    |  num of  |  cont  |  - shower header
        * |      X       |      Y       |      Z       |  hits    |    Z   |
        * ------------------------------------------------------------------
        * |   momentum   |   momentum   |   momentum   |  truth   |  cont  |  - shower header
        * |      X       |      Y       |      Z       |  energy  |    R   |
        * ------------------------------------------------------------------
        * |x-coord of hit|y-coord of hit|z-coord of hit|dep.energy|hit time|  - hit
        */
       int nentr = source->GetEntriesFast();
       if (nentr < 3) return false;
       Float_t x,y,z,e,time;
       source->SetBranchAddress("x",&x);
       source->SetBranchAddress("y",&y);
       source->SetBranchAddress("z",&z);
       source->SetBranchAddress("e",&e);
       source->SetBranchAddress("time",&time);
       int entr = 0;
  
       do {
           //read eta bin header
           source->GetEntry(entr++);
           int nhits = (int)(e+0.1); // +0.1 just in case - c++ has low round
           Shower shower;
           shower.setZSize(time);
           genInfo theinfo{};
           theinfo.vertex = std::make_unique<HepMC::FourVector>(x,y,z,0);
           source->GetEntry(entr++);
           shower.setRSize(time);
           theinfo.momentum = std::make_unique<HepMC::FourVector>(x,y,z,e);
           for(int i = 0; i < nhits; i++) {
               source->GetEntry(entr++); //variables mean what the name suggests
               shower.push_back(new ShowerEnergySpot(G4ThreeVector(x,y,z),e,time));
           }
           m_libData.emplace_back(std::move(theinfo),shower);
       } while (entr < nentr);
  
       m_filled = true;
       return true;
   }

◆ readFromROOTFile()

IShowerLib * ShowerLib::TestShowerLib::readFromROOTFile ( TFile * source )

static

factory method. create a library from root file. returns NULL if file is invalid.

Definition at line 41 of file TestShowerLib.cxx.

   {
       TParameter<int>* ver;
       ver = (TParameter<int>*)source->Get("version");
  
       if ((ver == nullptr) || (ver->GetVal() != LIB_VERSION)) return nullptr; //Test library header = 10
  
       TTree* TTreeMeta = (TTree*)source->Get("meta");
       TTree* TTreeLib  = (TTree*)source->Get("library");
  
       if ((TTreeMeta == nullptr) || (TTreeLib == nullptr)) return nullptr;
  
       std::cout << "TestShowerLib header found." << std::endl;
  
       TestShowerLib* newlib = new TestShowerLib();
  
       if (!(newlib->readMeta(TTreeMeta)) || !(newlib->read(TTreeLib))) {
           delete newlib;
           std::cout << "TestShowerLib read unsuccessful." << std::endl;
           return nullptr;
       }
  
       return newlib;
  
   }

◆ readMeta()

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

protectedinherited

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

inlinevirtualinherited

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 )

inlinevirtualinherited

set Release tag

Definition at line 128 of file IShowerLib.h.

128 { m_release = release; }

◆ statistics()

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

inherited

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()

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

virtual

store shower in the library

Implements ShowerLib::IShowerLib.

Definition at line 151 of file TestShowerLib.cxx.

   {
       if (m_filled) {
           std::cout << "ERROR: filled" << std::endl;
           return false;
       }
  
       genInfo theinfo{};
       theinfo.vertex = std::make_unique<HepMC::FourVector>(genParticle->production_vertex()->position());
       theinfo.momentum = std::make_unique<HepMC::FourVector>(genParticle->momentum());
  
       m_libData.emplace_back(std::move(theinfo), *shower);
  
       return true;
   }

◆ write()

bool ShowerLib::TestShowerLib::write ( TTree * dest ) const

private

write library to given TTree

Definition at line 233 of file TestShowerLib.cxx.

   {
       /*
        * Eta Energy library format:
        * |       x      |       y      |       z      |    e     |  time  |  - name of branch in TTree
        * ------------------------------------------------------------------
        * |    vertex    |    vertex    |    vertex    |  num of  |  cont  |  - shower header
        * |      X       |      Y       |      Z       |   hits   |    Z   |
        * ------------------------------------------------------------------
        * |   momentum   |   momentum   |   momentum   |  truth   |  cont  |  - shower header
        * |      X       |      Y       |      Z       |  energy  |    R   |
        * ------------------------------------------------------------------
        * |x-coord of hit|y-coord of hit|z-coord of hit|dep.energy|hit time|  - hit
        */
       Float_t x,y,z,e,time;
       dest->Branch("x",&x);
       dest->Branch("y",&y);
       dest->Branch("z",&z);
       dest->Branch("e",&e);
       dest->Branch("time",&time);
           for (const storedShower& lib : m_libData) {
           HepMC::FourVector vertex = *lib.first.vertex;
           HepMC::FourVector momentum = *lib.first.momentum;
           x = vertex.x();
           y = vertex.y();
           z = vertex.z();
           e = lib.second.size();
           time = lib.second.getZSize();
           dest->Fill(); //eta bin header
           x = momentum.px();
           y = momentum.py();
           z = momentum.pz();
           e = momentum.e();
           time = lib.second.getRSize();
           dest->Fill(); //eta bin header
                   for (const ShowerEnergySpot* spot : lib.second) {
               x = spot->GetPosition().x();
               y = spot->GetPosition().y();
               z = spot->GetPosition().z();
               e = spot->GetEnergy();
               time = spot->GetTime();
               dest->Fill();
           }
       }
       //dest->Write();
       return true;
   }

◆ writeMeta()

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

protectedinherited

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()

bool ShowerLib::TestShowerLib::writeToROOT ( TFile * dest )

virtual

write library to ROOT file

Implements ShowerLib::IShowerLib.

Definition at line 167 of file TestShowerLib.cxx.

   {
       if (m_libData.empty()) return false;
       TParameter<int> ver("version",LIB_VERSION);
  
       dest->WriteObject(&ver,"version");
  
       TTree TTreeMeta;
       TTree TTreeLib;
  
       write(&TTreeLib);
       writeMeta(&TTreeMeta);
  
       dest->WriteObject(&TTreeLib,"library");
       dest->WriteObject(&TTreeMeta,"meta");
  
       return true;
   }

Member Data Documentation

◆ m_comment

std::string ShowerLib::IShowerLib::m_comment

protectedinherited

comment

Definition at line 112 of file IShowerLib.h.

◆ m_detector

std::string ShowerLib::IShowerLib::m_detector

protectedinherited

name of the detector

Definition at line 106 of file IShowerLib.h.

◆ m_filled

bool ShowerLib::IShowerLib::m_filled

protectedinherited

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

protectedinherited

geant 4 version

Definition at line 110 of file IShowerLib.h.

◆ m_geometry

std::string ShowerLib::IShowerLib::m_geometry

protectedinherited

atlas geometry version

Definition at line 109 of file IShowerLib.h.

◆ m_libData

library ShowerLib::TestShowerLib::m_libData

private

Definition at line 84 of file TestShowerLib.h.

◆ m_particle

int ShowerLib::IShowerLib::m_particle

protectedinherited

ID of the generated particles.

Definition at line 107 of file IShowerLib.h.

◆ m_physicsList

std::string ShowerLib::IShowerLib::m_physicsList

protectedinherited

used geant 4 physics list

Definition at line 111 of file IShowerLib.h.

◆ m_release

std::string ShowerLib::IShowerLib::m_release

protectedinherited

atlas software release

Definition at line 108 of file IShowerLib.h.

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ library

◆ storedShower

Constructor & Destructor Documentation

◆ ~TestShowerLib()

◆ TestShowerLib()

Member Function Documentation

◆ addComment()

◆ comment() [1/2]

◆ comment() [2/2]

◆ createEmptyLib()

◆ 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()

◆ read()

◆ readFromROOTFile()

◆ readMeta()

◆ release() [1/2]

◆ release() [2/2]

◆ statistics()

◆ storeShower()

◆ write()

◆ writeMeta()

◆ writeToROOT()

Member Data Documentation

◆ m_comment

◆ m_detector

◆ m_filled

◆ m_geantVersion

◆ m_geometry

◆ m_libData

◆ m_particle

◆ m_physicsList

◆ m_release