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

Inheritance diagram for HcalTB02SD:

Public Member Functions
	HcalTB02SD (const std::string &, const HcalTB02Parameters , 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 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

bool	isItFineCalo (const G4VTouchable *touch)

void	PrintAll () override

bool	ProcessHits (G4GFlashSpot aSpot, G4TouchableHistory ) override

G4bool	ProcessHits (G4Step step, G4TouchableHistory ) override

void	reset () override

	~CaloSD () override

Public Member Functions inherited from SensitiveCaloDetector
	SensitiveCaloDetector (const std::string &iname, const SensitiveDetectorCatalog &clg)

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 SensitiveDetectorCatalog &, 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 , const G4Track )

virtual void	endEvent ()

virtual double	EnergyCorrected (const G4Step &step, const G4Track *)

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

void	hitBookkeepingFineCalo (const G4Step step, const G4Track currentTrack, CaloG4Hit *hit)

bool	hitExists (const G4Step *)

void	ignoreRejection ()

virtual void	initEvent (const BeginOfEvent *)

virtual void	initRun ()

void	printDetectorLevels (const G4VTouchable *) const

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 ::EndOfEvent *) override

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

void	update (const BeginOfRun *) 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	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 std::string &)

double	curve_LY (const std::string &, const G4StepPoint *)

Private Attributes
double	birk1_

double	birk2_

double	birk3_

const HcalTB02Parameters *	hcalTB02Parameters_

std::unique_ptr< HcalTB02NumberingScheme >	numberingScheme_

bool	useBirk_

bool	useWeight_

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

Static Protected Member Functions inherited from CaloSD
static std::string	printableDecayChain (const std::vector< unsigned int > &decayChain)

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 31 of file HcalTB02SD.h.

Constructor & Destructor Documentation

◆ HcalTB02SD()

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

Definition at line 34 of file HcalTB02SD.cc.

     : CaloSD(name, clg, p, manager), hcalTB02Parameters_(es) {
   numberingScheme_.reset(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) * (CLHEP::g / (CLHEP::MeV * CLHEP::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);
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("HcalTBSim") << "***************************************************\n"
                                 << "*                                                 *\n"
                                 << "* Constructing a HcalTB02SD  with name " << GetName() << "\n"
                                 << "*                                                 *\n"
                                 << "***************************************************";
   edm::LogVerbatim("HcalTBSim") << "HcalTB02SD:: Use of Birks law is set to      " << useBirk_
                                 << "        with three constants kB = " << birk1_ << ", C1 = " << birk2_
                                 << ", C2 = " << birk3_;
 #endif
 }

References birk1_, birk2_, birk3_, g, edm::ParameterSet::getUntrackedParameter(), MeV, Skims_PA_cff::name, numberingScheme_, AlCaHLTBitMon_ParallelJobs::p, generator_cfi::scheme, setNumberingScheme(), useBirk_, and useWeight_.

◆ ~HcalTB02SD()

HcalTB02SD::~HcalTB02SD ( )

override

Definition at line 73 of file HcalTB02SD.cc.

73 {}

Member Function Documentation

◆ crystalLength()

double HcalTB02SD::crystalLength ( const std::string & name )

private

Definition at line 130 of file HcalTB02SD.cc.

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

References hcalTB02Parameters_, HcalTB02Parameters::lengthMap_, and Skims_PA_cff::name.

Referenced by curve_LY().

◆ curve_LY()

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

private

Definition at line 108 of file HcalTB02SD.cc.

                                                                                      {
   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;
   }
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("HcalTBSim") << "HcalTB02SD, light coll curve : " << dapd << " crlength = " << crlength
                                 << " crystal name = " << nameVolume << " z of localPoint = " << localPoint.z()
                                 << " take weight = " << weight;
 #endif
   return weight;
 }

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

Referenced by getEnergyDeposit().

◆ getEnergyDeposit()

double HcalTB02SD::getEnergyDeposit ( const G4Step * aStep )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 79 of file HcalTB02SD.cc.

                                                        {
   auto const preStepPoint = aStep->GetPreStepPoint();
   std::string nameVolume = static_cast<std::string>(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;
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("HcalTBSim") << "HcalTB02SD:: " << nameVolume << " Light Collection Efficiency " << weight
                                 << " Weighted Energy Deposit " << edep / CLHEP::MeV << " MeV";
 #endif
   return edep;
 }

References birk1_, birk2_, birk3_, curve_LY(), CaloSD::getAttenuation(), MeV, AlCaHLTBitMon_QueryRunRegistry::string, useBirk_, useWeight_, and mps_merge::weight.

◆ setDetUnitId()

uint32_t HcalTB02SD::setDetUnitId ( const G4Step * step )

overridevirtual

Implements CaloSD.

Definition at line 97 of file HcalTB02SD.cc.

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

References numberingScheme_.

◆ setNumberingScheme()

void HcalTB02SD::setNumberingScheme ( HcalTB02NumberingScheme * scheme )

Definition at line 101 of file HcalTB02SD.cc.

                                                                    {
   if (scheme != nullptr) {
     edm::LogVerbatim("HcalTBSim") << "HcalTB02SD: updates numbering scheme for " << GetName();
     numberingScheme_.reset(scheme);
   }
 }

References numberingScheme_, and generator_cfi::scheme.

Referenced by HcalTB02SD().

Member Data Documentation

◆ birk1_

double HcalTB02SD::birk1_

private

Definition at line 51 of file HcalTB02SD.h.

Referenced by getEnergyDeposit(), and HcalTB02SD().

◆ birk2_

double HcalTB02SD::birk2_

private

Definition at line 51 of file HcalTB02SD.h.

Referenced by getEnergyDeposit(), and HcalTB02SD().

◆ birk3_

double HcalTB02SD::birk3_

private

Definition at line 51 of file HcalTB02SD.h.

Referenced by getEnergyDeposit(), and HcalTB02SD().

◆ hcalTB02Parameters_

const HcalTB02Parameters* HcalTB02SD::hcalTB02Parameters_

private

Definition at line 52 of file HcalTB02SD.h.

Referenced by crystalLength().

◆ numberingScheme_

std::unique_ptr<HcalTB02NumberingScheme> HcalTB02SD::numberingScheme_

private

Definition at line 49 of file HcalTB02SD.h.

Referenced by HcalTB02SD(), setDetUnitId(), and setNumberingScheme().

◆ useBirk_

bool HcalTB02SD::useBirk_

private

Definition at line 50 of file HcalTB02SD.h.

Referenced by getEnergyDeposit(), and HcalTB02SD().

◆ useWeight_

bool HcalTB02SD::useWeight_

private

Definition at line 50 of file HcalTB02SD.h.

Referenced by getEnergyDeposit(), and HcalTB02SD().

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HcalTB02SD()

◆ ~HcalTB02SD()

Member Function Documentation

◆ crystalLength()

◆ curve_LY()

◆ getEnergyDeposit()

◆ setDetUnitId()

◆ setNumberingScheme()

Member Data Documentation

◆ birk1_

◆ birk2_

◆ birk3_

◆ hcalTB02Parameters_

◆ numberingScheme_

◆ useBirk_

◆ useWeight_