#include <SimG4CMS/HcalTestBeam/interface/HcalTB02SD.h>

Inheritance diagram for HcalTB02SD:

Public Member Functions
	HcalTB02SD (const std::string &, const DDCompactView &, const SensitiveDetectorCatalog &, edm::ParameterSet const &, const SimTrackManager *)

uint32_t	setDetUnitId (const G4Step *step) override

void	setNumberingScheme (HcalTB02NumberingScheme *scheme)

	~HcalTB02SD () override

Public Member Functions inherited from CaloSD
	CaloSD (const std::string &aSDname, const DDCompactView &cpv, const SensitiveDetectorCatalog &clg, edm::ParameterSet const &p, const SimTrackManager *, float timeSlice=1., bool ignoreTkID=false)

void	clear () override

void	clearHits () override

void	DrawAll () override

void	EndOfEvent (G4HCofThisEvent *eventHC) override

void	fillHits (edm::PCaloHitContainer &, const std::string &) override

void	Initialize (G4HCofThisEvent *HCE) override

void	PrintAll () override

G4bool	ProcessHits (G4Step step, G4TouchableHistory ) override

bool	ProcessHits (G4GFlashSpot aSpot, G4TouchableHistory ) override

void	reset () override

	~CaloSD () override

Public Member Functions inherited from SensitiveCaloDetector
	SensitiveCaloDetector (const std::string &iname, const DDCompactView &cpv, const SensitiveDetectorCatalog &clg, edm::ParameterSet const &p)

Public Member Functions inherited from SensitiveDetector
void	EndOfEvent (G4HCofThisEvent *eventHC) override

const std::vector< std::string > &	getNames () const

void	Initialize (G4HCofThisEvent *eventHC) override

bool	isCaloSD () const

	SensitiveDetector (const std::string &iname, const DDCompactView &cpv, const SensitiveDetectorCatalog &, edm::ParameterSet const &p, bool calo)

	~SensitiveDetector () override

Public Member Functions inherited from Observer< const BeginOfRun * >
	Observer ()

void	slotForUpdate (const BeginOfRun * iT)

virtual	~Observer ()

Public Member Functions inherited from Observer< const BeginOfEvent * >
	Observer ()

void	slotForUpdate (const BeginOfEvent * iT)

virtual	~Observer ()

Public Member Functions inherited from Observer< const BeginOfTrack * >
	Observer ()

void	slotForUpdate (const BeginOfTrack * iT)

virtual	~Observer ()

Public Member Functions inherited from Observer< const EndOfTrack * >
	Observer ()

void	slotForUpdate (const EndOfTrack * iT)

virtual	~Observer ()

Public Member Functions inherited from Observer< const EndOfEvent * >
	Observer ()

void	slotForUpdate (const EndOfEvent * iT)

virtual	~Observer ()

Protected Member Functions
double	getEnergyDeposit (const G4Step *) override

Protected Member Functions inherited from CaloSD
bool	checkHit ()

CaloG4Hit *	createNewHit (const G4Step *)

virtual void	endEvent ()

virtual bool	filterHit (CaloG4Hit *, double)

double	getAttenuation (const G4Step *aStep, double birk1, double birk2, double birk3) const

virtual uint16_t	getDepth (const G4Step *)

virtual bool	getFromLibrary (const G4Step *step)

int	getNumberOfHits ()

double	getResponseWt (const G4Track *)

virtual int	getTrackID (const G4Track *)

bool	hitExists (const G4Step *)

virtual void	initEvent (const BeginOfEvent *)

virtual void	initRun ()

void	processHit (const G4Step *step)

void	resetForNewPrimary (const G4Step *)

void	setNumberCheckedHits (int val)

void	setParameterized (bool val)

G4ThreeVector	setToGlobal (const G4ThreeVector &, const G4VTouchable *) const

G4ThreeVector	setToLocal (const G4ThreeVector &, const G4VTouchable *) const

virtual int	setTrackID (const G4Step *)

void	setUseMap (bool val)

void	update (const BeginOfRun *) override
	This routine will be called when the appropriate signal arrives. More...

void	update (const BeginOfEvent *) override
	This routine will be called when the appropriate signal arrives. More...

void	update (const BeginOfTrack *trk) override
	This routine will be called when the appropriate signal arrives. More...

void	update (const EndOfTrack *trk) override
	This routine will be called when the appropriate signal arrives. More...

void	update (const ::EndOfEvent *) override

void	updateHit (CaloG4Hit *)

Protected Member Functions inherited from SensitiveDetector
TrackInformation *	cmsTrackInformation (const G4Track *aTrack)

Local3DPoint	ConvertToLocal3DPoint (const G4ThreeVector &point) const

Local3DPoint	FinalStepPosition (const G4Step *step, coordinates) const

Local3DPoint	InitialStepPosition (const G4Step *step, coordinates) const

Local3DPoint	LocalPostStepPosition (const G4Step *step) const

Local3DPoint	LocalPreStepPosition (const G4Step *step) const

void	NaNTrap (const G4Step *step) const

void	setNames (const std::vector< std::string > &)

Protected Member Functions inherited from Observer< const EndOfEvent * >
virtual void	update (const EndOfEvent *)=0
	This routine will be called when the appropriate signal arrives. More...

Private Member Functions
double	crystalLength (const G4String &)

double	curve_LY (const G4String &, const G4StepPoint *)

void	initMap (const std::string &, const DDCompactView &)

Private Attributes
double	birk1

double	birk2

double	birk3

std::map< G4String, double >	lengthMap

HcalTB02NumberingScheme *	numberingScheme

bool	useBirk

bool	useWeight

Additional Inherited Members
Protected Types inherited from SensitiveDetector
enum	coordinates { WorldCoordinates, LocalCoordinates }

Protected Attributes inherited from CaloSD
CaloG4Hit *	currentHit

CaloHitID	currentID

float	edepositEM

float	edepositHAD

double	eminHit

double	energyCut

G4ThreeVector	entranceLocal

G4ThreeVector	entrancePoint

bool	forceSave

float	incidentEnergy

double	kmaxIon

double	kmaxNeutron

double	kmaxProton

G4ThreeVector	posGlobal

CaloHitID	previousID

bool	suppressHeavy

double	tmaxHit

Detailed Description

Description: Stores hits of Test Beam 2002 calorimeters

Usage: Activation is done using the XML file by choosing HcalTB02SensitiveDetector

Definition at line 29 of file HcalTB02SD.h.

Constructor & Destructor Documentation

HcalTB02SD::HcalTB02SD	(	const std::string &	name,
		const DDCompactView &	cpv,
		const SensitiveDetectorCatalog &	clg,
		edm::ParameterSet const &	p,
		const SimTrackManager *	manager
	)

Definition at line 36 of file HcalTB02SD.cc.

References birk1, birk2, birk3, g, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), initMap(), LogDebug, MeV, setNumberingScheme(), useBirk, and useWeight.

                                                : 
   CaloSD(name, cpv, clg, p, manager), numberingScheme(nullptr) {
   
   edm::ParameterSet m_SD = p.getParameter<edm::ParameterSet>("HcalTB02SD");
   useBirk= m_SD.getUntrackedParameter<bool>("UseBirkLaw",false);
   birk1  = m_SD.getUntrackedParameter<double>("BirkC1",0.013)*(g/(MeV*cm2));
   birk2  = m_SD.getUntrackedParameter<double>("BirkC2",0.0568);
   birk3  = m_SD.getUntrackedParameter<double>("BirkC3",1.75);
   useWeight= true;
 
   HcalTB02NumberingScheme* scheme=nullptr;
   if      (name == "EcalHitsEB") {
     scheme = dynamic_cast<HcalTB02NumberingScheme*>(new HcalTB02XtalNumberingScheme());
     useBirk = false;
   } else if (name == "HcalHits") {
     scheme = dynamic_cast<HcalTB02NumberingScheme*>(new HcalTB02HcalNumberingScheme());
       useWeight= false;
   } else {edm::LogWarning("HcalTBSim") << "HcalTB02SD: ReadoutName " << name
                        << " not supported\n";}
 
   if (scheme)  setNumberingScheme(scheme);
   LogDebug("HcalTBSim") 
     << "***************************************************" 
     << "\n"
     << "*                                                 *" 
     << "\n"
     << "* Constructing a HcalTB02SD  with name " << GetName()
     << "\n"
     << "*                                                 *"
     << "\n"
     << "***************************************************" ;
   edm::LogInfo("HcalTBSim")  << "HcalTB02SD:: Use of Birks law is set to      "
                  << useBirk << "        with three constants kB = "
                  << birk1 << ", C1 = " << birk2 << ", C2 = "
                  << birk3;
 
   if (useWeight) initMap(name,cpv);
 
 }

HcalTB02SD::~HcalTB02SD ( )

override

Definition at line 79 of file HcalTB02SD.cc.

References numberingScheme.

                         {
   if (numberingScheme) delete numberingScheme;
 }

Member Function Documentation

double HcalTB02SD::crystalLength ( const G4String & name )

private

Definition at line 172 of file HcalTB02SD.cc.

References lengthMap.

Referenced by curve_LY().

                                                      {
 
   double length = 230.;
   std::map<G4String,double>::const_iterator it = lengthMap.find(name);
   if (it != lengthMap.end()) length = it->second;
   return length;
 }

double HcalTB02SD::curve_LY	(	const G4String &	nameVolume,
		const G4StepPoint *	stepPoint
	)

private

Definition at line 147 of file HcalTB02SD.cc.

References crystalLength(), LogDebug, CaloSD::setToLocal(), and mps_merge::weight.

Referenced by getEnergyDeposit().

                                                                                     {
 
   double weight = 1.;
   G4ThreeVector  localPoint = setToLocal(stepPoint->GetPosition(),
                      stepPoint->GetTouchable());
   double crlength = crystalLength(nameVolume);
   double dapd = 0.5 * crlength - localPoint.z();
   if (dapd >= -0.1 || dapd <= crlength+0.1) {
     if (dapd <= 100.)
       weight = 1.05 - dapd * 0.0005;
   } else {
     edm::LogWarning("HcalTBSim") << "HcalTB02SD: light coll curve : wrong "
                  << "distance to APD " << dapd <<" crlength = "
                  << crlength << " crystal name = " <<nameVolume
                  << " z of localPoint = " << localPoint.z() 
                  << " take weight = " << weight;
   }
   LogDebug("HcalTBSim") << "HcalTB02SD, light coll curve : " << dapd 
             << " crlength = " << crlength
             << " crystal name = " << nameVolume 
             << " z of localPoint = " << localPoint.z() 
             << " take weight = " << weight;
   return weight;
 }

double HcalTB02SD::getEnergyDeposit ( const G4Step * aStep )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 87 of file HcalTB02SD.cc.

References birk1, birk2, birk3, curve_LY(), CaloSD::getAttenuation(), LogDebug, MeV, useBirk, useWeight, and mps_merge::weight.

                                                         {
   
   auto const preStepPoint = aStep->GetPreStepPoint();
   auto const & nameVolume = preStepPoint->GetPhysicalVolume()->GetName();
 
   // take into account light collection curve for crystals
   double weight = 1.;
   if (useWeight) weight *= curve_LY(nameVolume, preStepPoint);
   if (useBirk)   weight *= getAttenuation(aStep, birk1, birk2, birk3);
   double edep   = aStep->GetTotalEnergyDeposit() * weight;
   LogDebug("HcalTBSim") << "HcalTB02SD:: " << nameVolume
             <<" Light Collection Efficiency " << weight 
             << " Weighted Energy Deposit " << edep/MeV << " MeV";
   return edep;
 }

void HcalTB02SD::initMap	(	const std::string &	sd,
		const DDCompactView &	cpv
	)

private

Definition at line 116 of file HcalTB02SD.cc.

References ddtrap, PVValHelper::dz, ALCARECOTkAlBeamHalo_cff::filter, DDFilteredView::firstChild(), mps_fire::i, lengthMap, LogDebug, DDFilteredView::logicalPart(), DDName::name(), dataset::name, DDBase< N, C >::name(), DDFilteredView::next(), DDSolid::parameters(), DDSolid::shape(), and DDLogicalPart::solid().

Referenced by HcalTB02SD().

                                                                        {
 
   G4String attribute = "ReadOutName";
   DDSpecificsMatchesValueFilter filter{DDValue(attribute,sd,0)};
   DDFilteredView fv(cpv,filter);
   fv.firstChild();
 
   bool dodet=true;
   while (dodet) {
     const DDSolid & sol  = fv.logicalPart().solid();
     const std::vector<double> & paras = sol.parameters();
     G4String name = sol.name().name();
     LogDebug("HcalTBSim") << "HcalTB02SD::initMap (for " << sd << "): Solid " 
               << name << " Shape " << sol.shape() 
               << " Parameter 0 = " << paras[0];
     if (sol.shape() == DDSolidShape::ddtrap) {
       double dz = 2*paras[0];
       lengthMap.insert(std::pair<G4String,double>(name,dz));
     }
     dodet = fv.next();
   }
   LogDebug("HcalTBSim") << "HcalTB02SD: Length Table for " << attribute 
             << " = " << sd << ":";   
   std::map<G4String,double>::const_iterator it = lengthMap.begin();
   int i=0;
   for (; it != lengthMap.end(); it++, i++) {
     LogDebug("HcalTBSim") << " " << i << " " << it->first << " L = " 
               << it->second;
   }
 }

uint32_t HcalTB02SD::setDetUnitId ( const G4Step * step )

overridevirtual

Implements CaloSD.

Definition at line 103 of file HcalTB02SD.cc.

References HcalTB02NumberingScheme::getUnitID(), and numberingScheme.

                                                       { 
   return (numberingScheme == nullptr ? 0 : (uint32_t)(numberingScheme->getUnitID(aStep)));
 }

void HcalTB02SD::setNumberingScheme ( HcalTB02NumberingScheme * scheme )

Definition at line 107 of file HcalTB02SD.cc.

References numberingScheme.

Referenced by HcalTB02SD().

                                                                    {
   if (scheme != nullptr) {
     edm::LogInfo("HcalTBSim") << "HcalTB02SD: updates numbering scheme for " 
                   << GetName();
     if (numberingScheme) delete numberingScheme;
     numberingScheme = scheme;
   }
 }