#include <HGCalSD.h>

Inheritance diagram for HGCalSD:

Public Member Functions
	HGCalSD (const std::string &, const HGCalDDDConstants , const SensitiveDetectorCatalog &, edm::ParameterSet const &, const SimTrackManager )

uint32_t	setDetUnitId (const G4Step *step) override

	~HGCalSD () override=default

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

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

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

void	slotForUpdate (const BeginOfJob *iT)

virtual	~Observer ()

Protected Member Functions
bool	filterHit (CaloG4Hit *, double) override

double	getEnergyDeposit (const G4Step *) override

void	initRun () override

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

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

unsigned int	findBoundaryCrossingParent (const G4Track *track, bool markParentAsSaveable=true)

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

void	ignoreRejection ()

virtual void	initEvent (const BeginOfEvent *)

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)

std::string	shortreprID (const CaloHitID &ID)

std::string	shortreprID (const CaloG4Hit *hit)

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
bool	isItinFidVolume (const G4ThreeVector &)

uint32_t	setDetUnitId (int, int, int, int, G4ThreeVector &)

Private Attributes
std::vector< double >	angles_

int	cornerMinMask_

double	distanceFromEdge_

double	eminHit_

bool	fiducialCut_

HGCalGeometryMode::GeometryMode	geom_mode_

const HGCalDDDConstants *	hgcons_

int	levelT1_

int	levelT2_

std::unique_ptr< HGCMouseBite >	mouseBite_

double	mouseBiteCut_

DetId::Detector	mydet_

std::string	nameX_

std::unique_ptr < HGCalNumberingScheme >	numberingScheme_

bool	rejectMB_

double	slopeMin_

bool	storeAllG4Hits_

const double	tan30deg_

bool	waferRot_

double	weight_

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

Definition at line 20 of file HGCalSD.h.

Constructor & Destructor Documentation

HGCalSD::HGCalSD	(	const std::string &	name,
		const HGCalDDDConstants *	hgc,
		const SensitiveDetectorCatalog &	clg,
		edm::ParameterSet const &	p,
		const SimTrackManager *	manager
	)

Definition at line 28 of file HGCalSD.cc.

References angles_, cornerMinMask_, distanceFromEdge_, eminHit_, fiducialCut_, DetId::Forward, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), DetId::HGCalEE, DetId::HGCalHSi, MeV, mouseBite_, mydet_, mergeVDriftHistosByStation::name, nameX_, numberingScheme_, rejectMB_, CaloSD::setNumberCheckedHits(), CaloSD::setUseMap(), storeAllG4Hits_, and waferRot_.

     : CaloSD(name,
              clg,
              p,
              manager,
              static_cast<float>(p.getParameter<edm::ParameterSet>("HGCSD").getParameter<double>("TimeSliceUnit")),
              p.getParameter<edm::ParameterSet>("HGCSD").getParameter<bool>("IgnoreTrackID")),
       hgcons_(hgc),
       slopeMin_(0),
       levelT1_(99),
       levelT2_(99),
       tan30deg_(std::tan(30.0 * CLHEP::deg)) {
   numberingScheme_.reset(nullptr);
   mouseBite_.reset(nullptr);
 
   edm::ParameterSet m_HGC = p.getParameter<edm::ParameterSet>("HGCSD");
   eminHit_ = m_HGC.getParameter<double>("EminHit") * CLHEP::MeV;
   fiducialCut_ = m_HGC.getParameter<bool>("FiducialCut");
   distanceFromEdge_ = m_HGC.getParameter<double>("DistanceFromEdge");
   storeAllG4Hits_ = m_HGC.getParameter<bool>("StoreAllG4Hits");
   rejectMB_ = m_HGC.getParameter<bool>("RejectMouseBite");
   waferRot_ = m_HGC.getParameter<bool>("RotatedWafer");
   cornerMinMask_ = m_HGC.getParameter<int>("CornerMinMask");
   angles_ = m_HGC.getUntrackedParameter<std::vector<double>>("WaferAngles");
 
   if (storeAllG4Hits_) {
     setUseMap(false);
     setNumberCheckedHits(0);
   }
 
   //this is defined in the hgcsens.xml
   G4String myName = name;
   mydet_ = DetId::Forward;
   nameX_ = "HGCal";
   if (myName.find("HitsEE") != std::string::npos) {
     mydet_ = DetId::HGCalEE;
     nameX_ = "HGCalEESensitive";
   } else if (myName.find("HitsHEfront") != std::string::npos) {
     mydet_ = DetId::HGCalHSi;
     nameX_ = "HGCalHESiliconSensitive";
   }
 
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("HGCSim") << "**************************************************"
                              << "\n"
                              << "*                                                *"
                              << "\n"
                              << "* Constructing a HGCalSD  with name " << name << "\n"
                              << "*                                                *"
                              << "\n"
                              << "**************************************************";
 #endif
   edm::LogVerbatim("HGCSim") << "HGCalSD:: Threshold for storing hits: " << eminHit_ << " for " << nameX_
                              << " detector " << mydet_;
   edm::LogVerbatim("HGCSim") << "Flag for storing individual Geant4 Hits " << storeAllG4Hits_;
   edm::LogVerbatim("HGCSim") << "Fiducial volume cut with cut from eta/phi "
                              << "boundary " << fiducialCut_ << " at " << distanceFromEdge_;
   edm::LogVerbatim("HGCSim") << "Reject MosueBite Flag: " << rejectMB_ << " cuts along " << angles_.size()
                              << " axes: " << angles_[0] << ", " << angles_[1];
 }

HGCalSD::~HGCalSD ( )

overridedefault

Member Function Documentation

bool HGCalSD::filterHit	(	CaloG4Hit *	aHit,
		double	time
	)

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 230 of file HGCalSD.cc.

References eminHit_, CaloG4Hit::getEnergyDeposit(), and CaloSD::tmaxHit.

                                                     {
   return ((time <= tmaxHit) && (aHit->getEnergyDeposit() > eminHit_));
 }

double HGCalSD::getEnergyDeposit ( const G4Step * aStep )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 93 of file HGCalSD.cc.

References funct::abs(), CaloSD::getResponseWt(), alignCSCRings::r, slopeMin_, weight_, and z.

                                                     {
   double r = aStep->GetPreStepPoint()->GetPosition().perp();
   double z = std::abs(aStep->GetPreStepPoint()->GetPosition().z());
 #ifdef EDM_ML_DEBUG
   G4int parCode = aStep->GetTrack()->GetDefinition()->GetPDGEncoding();
   G4String parName = aStep->GetTrack()->GetDefinition()->GetParticleName();
   G4LogicalVolume* lv = aStep->GetPreStepPoint()->GetPhysicalVolume()->GetLogicalVolume();
   edm::LogVerbatim("HGCSim") << "HGCalSD: Hit from standard path from " << lv->GetName() << " for Track "
                              << aStep->GetTrack()->GetTrackID() << " (" << parCode << ":" << parName << ") R = " << r
                              << " Z = " << z << " slope = " << r / z << ":" << slopeMin_;
 #endif
   // Apply fiducial cut
   if (r < z * slopeMin_) {
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("HGCSim") << "HGCalSD: Fiducial Volume cut";
 #endif
     return 0.0;
   }
 
   double wt1 = getResponseWt(aStep->GetTrack());
   double wt2 = aStep->GetTrack()->GetWeight();
   double destep = weight_ * wt1 * (aStep->GetTotalEnergyDeposit());
   if (wt2 > 0)
     destep *= wt2;
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("HGCSim") << "HGCalSD: weights= " << weight_ << ":" << wt1 << ":" << wt2 << " Total weight "
                              << weight_ * wt1 * wt2 << " deStep: " << aStep->GetTotalEnergyDeposit() << ":" << destep;
 #endif
   return destep;
 }

void HGCalSD::initRun ( )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 228 of file HGCalSD.cc.

228 {}

bool HGCalSD::isItinFidVolume ( const G4ThreeVector & pos )

private

Definition at line 247 of file HGCalSD.cc.

References distanceFromEdge_, HGCalDDDConstants::distFromEdgeHex(), fiducialCut_, and hgcons_.

                                                       {
   if (fiducialCut_) {
     return (hgcons_->distFromEdgeHex(pos.x(), pos.y(), pos.z()) > distanceFromEdge_);
   } else {
     return true;
   }
 }

uint32_t HGCalSD::setDetUnitId ( const G4Step * step )

overridevirtual

Implements CaloSD.

Definition at line 124 of file HGCalSD.cc.

References TauDecayModes::dec, geom_mode_, HGCalGeometryMode::Hexagon8Module, gpuClustering::id, phase1PixelTopology::layer, levelT1_, levelT2_, callgraph::module, mouseBite_, CaloSD::printDetectorLevels(), rejectMB_, and HGCSiliconDetId::waferUV().

                                                   {
   const G4StepPoint* preStepPoint = aStep->GetPreStepPoint();
   const G4VTouchable* touch = preStepPoint->GetTouchable();
 
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("HGCSim") << "DepthsTop: " << touch->GetHistoryDepth() << ":" << levelT1_ << ":" << levelT2_;
   printDetectorLevels(touch);
 #endif
   //determine the exact position in global coordinates in the mass geometry
   G4ThreeVector hitPoint = preStepPoint->GetPosition();
   float globalZ = touch->GetTranslation(0).z();
   int iz(globalZ > 0 ? 1 : -1);
 
   int layer(0), module(-1), cell(-1);
   if (geom_mode_ == HGCalGeometryMode::Hexagon8Module) {
     if (touch->GetHistoryDepth() > levelT2_) {
       layer = touch->GetReplicaNumber(4);
       module = touch->GetReplicaNumber(3);
       cell = touch->GetReplicaNumber(1);
     } else {
       layer = touch->GetReplicaNumber(3);
       module = touch->GetReplicaNumber(2);
     }
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("HGCSim") << "DepthsTop: " << touch->GetHistoryDepth() << ":" << levelT1_ << ":" << levelT2_
                                << " name " << touch->GetVolume(0)->GetName() << " layer:module:cell " << layer << ":"
                                << module << ":" << cell;
     printDetectorLevels(touch);
 #endif
   } else if ((touch->GetHistoryDepth() == levelT1_) || (touch->GetHistoryDepth() == levelT2_)) {
     layer = touch->GetReplicaNumber(0);
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("HGCSim") << "DepthsTop: " << touch->GetHistoryDepth() << ":" << levelT1_ << ":" << levelT2_
                                << " name " << touch->GetVolume(0)->GetName() << " layer:module:cell " << layer << ":"
                                << module << ":" << cell;
 #endif
   } else {
     layer = touch->GetReplicaNumber(3);
     module = touch->GetReplicaNumber(2);
     cell = touch->GetReplicaNumber(1);
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("HGCSim") << "DepthsInside: " << touch->GetHistoryDepth() << " name "
                                << touch->GetVolume(0)->GetName() << " layer:module:cell " << layer << ":" << module
                                << ":" << cell;
 #endif
   }
 #ifdef EDM_ML_DEBUG
   G4Material* mat = aStep->GetPreStepPoint()->GetMaterial();
   edm::LogVerbatim("HGCSim") << "Depths: " << touch->GetHistoryDepth() << " name " << touch->GetVolume(0)->GetName()
                              << ":" << touch->GetReplicaNumber(0) << "   " << touch->GetVolume(1)->GetName() << ":"
                              << touch->GetReplicaNumber(1) << "   " << touch->GetVolume(2)->GetName() << ":"
                              << touch->GetReplicaNumber(2) << "   " << touch->GetVolume(3)->GetName() << ":"
                              << touch->GetReplicaNumber(3) << "   " << touch->GetVolume(4)->GetName() << ":"
                              << touch->GetReplicaNumber(4) << "   "
                              << " layer:module:cell " << layer << ":" << module << ":" << cell << " Material "
                              << mat->GetName() << ":" << mat->GetRadlen();
 #endif
   // The following statement should be examined later before elimination
   if (aStep->GetPreStepPoint()->GetMaterial()->GetRadlen() > 100000.)
     return 0;
 
   uint32_t id = setDetUnitId(layer, module, cell, iz, hitPoint);
   if (rejectMB_ && id != 0) {
     auto uv = HGCSiliconDetId(id).waferUV();
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("HGCSim") << "ID " << std::hex << id << std::dec << " " << HGCSiliconDetId(id);
 #endif
     if (mouseBite_->exclude(hitPoint, iz, uv.first, uv.second)) {
       id = 0;
 #ifdef EDM_ML_DEBUG
       edm::LogVerbatim("HGCSim") << "Rejected by mousebite cutoff *****";
 #endif
     }
   }
 #ifdef EDM_ML_DEBUG
   if (id != 0)
     edm::LogVerbatim("HGCSim") << HGCSiliconDetId(id);
 #endif
   return id;
 }

uint32_t HGCalSD::setDetUnitId	(	int	layer,
		int	module,
		int	cell,
		int	iz,
		G4ThreeVector &	pos
	)

private

Definition at line 234 of file HGCalSD.cc.

References cornerMinMask_, geom_mode_, HGCalGeometryMode::Hexagon8File, HGCalGeometryMode::Hexagon8Module, hgcons_, gpuClustering::id, CaloSD::ignoreRejection(), HGCalDDDConstants::maskCell(), numberingScheme_, and weight_.

                                                                                           {
   uint32_t id = numberingScheme_ ? numberingScheme_->getUnitID(layer, module, cell, iz, pos, weight_) : 0;
   if (cornerMinMask_ > 2) {
     if (hgcons_->maskCell(DetId(id), cornerMinMask_)) {
       id = 0;
       ignoreRejection();
     }
   }
   if ((geom_mode_ == HGCalGeometryMode::Hexagon8File) || (geom_mode_ == HGCalGeometryMode::Hexagon8Module) || (id == 0))
     ignoreRejection();
   return id;
 }

void HGCalSD::update ( const BeginOfJob * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfJob * >.

Definition at line 205 of file HGCalSD.cc.

References angles_, Exception, geom_mode_, HGCalDDDConstants::geomMode(), hgcons_, levelT1_, levelT2_, HGCalDDDConstants::levelTop(), HGCalDDDConstants::minSlope(), HGCalDDDConstants::mouseBite(), mouseBite_, mouseBiteCut_, mydet_, nameX_, numberingScheme_, rejectMB_, slopeMin_, tan30deg_, waferRot_, and HGCalDDDConstants::waferSize().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

                                           {
   if (hgcons_ != nullptr) {
     geom_mode_ = hgcons_->geomMode();
     slopeMin_ = hgcons_->minSlope();
     levelT1_ = hgcons_->levelTop(0);
     levelT2_ = hgcons_->levelTop(1);
     double waferSize = hgcons_->waferSize(false);
     double mouseBite = hgcons_->mouseBite(false);
     mouseBiteCut_ = waferSize * tan30deg_ - mouseBite;
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("HGCSim") << "HGCalSD::Initialized with mode " << geom_mode_ << " Slope cut " << slopeMin_
                                << " top Level " << levelT1_ << ":" << levelT2_ << " wafer " << waferSize << ":"
                                << mouseBite;
 #endif
 
     numberingScheme_ = std::make_unique<HGCalNumberingScheme>(*hgcons_, mydet_, nameX_);
     if (rejectMB_)
       mouseBite_ = std::make_unique<HGCMouseBite>(*hgcons_, angles_, mouseBiteCut_, waferRot_);
   } else {
     throw cms::Exception("Unknown", "HGCalSD") << "Cannot find HGCalDDDConstants for " << nameX_ << "\n";
   }
 }