HGCSD Class Reference

#include <HGCSD.h>

Inheritance diagram for HGCSD:

Public Member Functions
double	getEnergyDeposit (G4Step *) override
	HGCSD (G4String, const DDCompactView &, const SensitiveDetectorCatalog &, edm::ParameterSet const &, const SimTrackManager *)
bool	ProcessHits (G4Step *, G4TouchableHistory *) override
uint32_t	setDetUnitId (G4Step *step) override
	~HGCSD () override
Public Member Functions inherited from CaloSD
	CaloSD (G4String aSDname, const DDCompactView &cpv, const SensitiveDetectorCatalog &clg, edm::ParameterSet const &p, const SimTrackManager *, float timeSlice=1., bool ignoreTkID=false)
void	clear () override
void	DrawAll () override
void	EndOfEvent (G4HCofThisEvent *eventHC) override
void	fillHits (edm::PCaloHitContainer &, std::string n) override
void	Initialize (G4HCofThisEvent *HCE) override
void	PrintAll () override
bool	ProcessHits (G4GFlashSpot *aSpot, G4TouchableHistory *) override
	~CaloSD () override
Public Member Functions inherited from SensitiveCaloDetector
	SensitiveCaloDetector (std::string &iname, const DDCompactView &cpv, const SensitiveDetectorCatalog &clg, edm::ParameterSet const &p)
Public Member Functions inherited from SensitiveDetector
virtual void	AssignSD (const std::string &vname)
Local3DPoint	ConvertToLocal3DPoint (const G4ThreeVector &point)
void	EndOfEvent (G4HCofThisEvent *eventHC) override
Local3DPoint	FinalStepPosition (G4Step *s, coordinates)
virtual std::vector< std::string >	getNames ()
void	Initialize (G4HCofThisEvent *eventHC) override
Local3DPoint	InitialStepPosition (G4Step *s, coordinates)
std::string	nameOfSD ()
void	NaNTrap (G4Step *step)
void	Register ()
	SensitiveDetector (std::string &iname, const DDCompactView &cpv, const SensitiveDetectorCatalog &, edm::ParameterSet const &p)
	~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
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
G4bool	checkHit ()
void	clearHits () override
CaloG4Hit *	createNewHit ()
double	getAttenuation (G4Step *aStep, double birk1, double birk2, double birk3)
virtual uint16_t	getDepth (G4Step *)
int	getNumberOfHits ()
double	getResponseWt (G4Track *)
virtual G4bool	getStepInfo (G4Step *aStep)
virtual int	getTrackID (G4Track *)
G4bool	hitExists ()
void	resetForNewPrimary (const G4ThreeVector &, double)
G4ThreeVector	setToGlobal (const G4ThreeVector &, const G4VTouchable *)
G4ThreeVector	setToLocal (const G4ThreeVector &, const G4VTouchable *)
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 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 (G4ThreeVector &)
uint32_t	setDetUnitId (ForwardSubdetector &, int, int, int, int, G4ThreeVector &)
int	setTrackID (G4Step *step)

Private Attributes
std::vector< double >	angles_
double	eminHit
int	levelT_
HGCalGeometryMode::GeometryMode	m_mode
HGCMouseBite *	mouseBite_
double	mouseBiteCut_
G4int	mumPDG
G4int	mupPDG
ForwardSubdetector	myFwdSubdet_
std::string	nameX
HGCNumberingScheme *	numberingScheme
bool	rejectMB_
double	slopeMin_
bool	storeAllG4Hits_
bool	waferRot_

Additional Inherited Members
Public Types inherited from SensitiveDetector
enum	coordinates { WorldCoordinates, LocalCoordinates }
Protected Attributes inherited from CaloSD
int	checkHits
double	correctT
bool	corrTOFBeam
CaloG4Hit *	currentHit
CaloHitID	currentID
float	edepositEM
float	edepositHAD
double	eminHit
double	eminHitD
G4int	emPDG
double	energyCut
G4ThreeVector	entranceLocal
G4ThreeVector	entrancePoint
G4int	epPDG
bool	forceSave
G4int	gammaPDG
float	incidentEnergy
double	kmaxIon
double	kmaxNeutron
double	kmaxProton
const SimTrackManager *	m_trackManager
G4ThreeVector	posGlobal
G4StepPoint *	preStepPoint
CaloHitID	previousID
int	primIDSaved
bool	runInit
bool	suppressHeavy
G4Track *	theTrack
double	tmaxHit
bool	useMap

Detailed Description

Definition at line 26 of file HGCSD.h.

Constructor & Destructor Documentation

HGCSD::HGCSD	(	G4String	name,
		const DDCompactView &	cpv,
		const SensitiveDetectorCatalog &	clg,
		edm::ParameterSet const &	p,
		const SimTrackManager *	manager
	)

Definition at line 36 of file HGCSD.cc.

References angles_, eminHit, ForwardEmpty, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), HGCEE, HGCHEB, HGCHEF, MeV, mouseBiteCut_, myFwdSubdet_, SensitiveDetector::nameOfSD(), nameX, rejectMB_, storeAllG4Hits_, funct::tan(), and waferRot_.

                                                                    : 
  CaloSD(name, cpv, clg, p, manager,
         (float)(p.getParameter<edm::ParameterSet>("HGCSD").getParameter<double>("TimeSliceUnit")),
         p.getParameter<edm::ParameterSet>("HGCSD").getParameter<bool>("IgnoreTrackID")), 
  numberingScheme(nullptr), mouseBite_(nullptr), slopeMin_(0), levelT_(99) {

  edm::ParameterSet m_HGC = p.getParameter<edm::ParameterSet>("HGCSD");
  eminHit          = m_HGC.getParameter<double>("EminHit")*CLHEP::MeV;
  storeAllG4Hits_  = m_HGC.getParameter<bool>("StoreAllG4Hits");
  rejectMB_        = m_HGC.getParameter<bool>("RejectMouseBite");
  waferRot_        = m_HGC.getParameter<bool>("RotatedWafer");
  angles_          = m_HGC.getUntrackedParameter<std::vector<double>>("WaferAngles");
  double waferSize = m_HGC.getUntrackedParameter<double>("WaferSize")*CLHEP::mm;
  double mouseBite = m_HGC.getUntrackedParameter<double>("MouseBite")*CLHEP::mm;
  mouseBiteCut_    = waferSize*tan(30.0*CLHEP::deg) - mouseBite;

  //this is defined in the hgcsens.xml
  G4String myName(this->nameOfSD());
  myFwdSubdet_= ForwardSubdetector::ForwardEmpty;
  nameX = "HGCal";
  if (myName.find("HitsEE")!=std::string::npos) {
    myFwdSubdet_ = ForwardSubdetector::HGCEE;
    nameX        = "HGCalEESensitive";
  } else if (myName.find("HitsHEfront")!=std::string::npos) {
    myFwdSubdet_ = ForwardSubdetector::HGCHEF;
    nameX        = "HGCalHESiliconSensitive";
  } else if (myName.find("HitsHEback")!=std::string::npos) {
    myFwdSubdet_ = ForwardSubdetector::HGCHEB;
    nameX        = "HGCalHEScintillatorSensitive";
  }

#ifdef EDM_ML_DEBUG
  edm::LogInfo("HGCSim")<< "**************************************************"
            << "\n"
            << "*                                                *"
            << "\n"
            << "* Constructing a HGCSD  with name " << name << "\n"
            << "*                                                *"
            << "\n"
            << "**************************************************";
#endif
  edm::LogInfo("HGCSim") << "HGCSD:: Threshold for storing hits: " << eminHit
             << " for " << nameX << " subdet " << myFwdSubdet_;
  edm::LogInfo("HGCSim") << "Flag for storing individual Geant4 Hits "
             << storeAllG4Hits_;
  edm::LogInfo("HGCSim") << "Reject MosueBite Flag: " << rejectMB_ 
             << " Size of wafer " << waferSize << " Mouse Bite "
             << mouseBite << ":" << mouseBiteCut_ << " along "
             << angles_.size() << " axes";
}

HGCSD::~HGCSD ( )

override

Definition at line 89 of file HGCSD.cc.

References mouseBite_, and numberingScheme.

              { 
  if (numberingScheme)  delete numberingScheme;
  if (mouseBite_)       delete mouseBite_;
}

Member Function Documentation

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

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 235 of file HGCSD.cc.

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

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

double HGCSD::getEnergyDeposit ( G4Step *  aStep )

overridevirtual

Reimplemented from CaloSD.

Definition at line 126 of file HGCSD.cc.

References CaloSD::getResponseWt().

                                            {
  double wt1    = getResponseWt(aStep->GetTrack());
  double wt2    = aStep->GetTrack()->GetWeight();
  double destep = wt1*(aStep->GetTotalEnergyDeposit());
  if (wt2 > 0) destep *= wt2;
  return destep;
}

void HGCSD::initRun ( void  )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 224 of file HGCSD.cc.

References mumPDG, mupPDG, and HiggsValidation_cfi::particleName.

                    {
  G4ParticleTable * theParticleTable = G4ParticleTable::GetParticleTable();
  G4String          particleName;
  mumPDG = theParticleTable->FindParticle(particleName="mu-")->GetPDGEncoding();
  mupPDG = theParticleTable->FindParticle(particleName="mu+")->GetPDGEncoding();
#ifdef EDM_ML_DEBUG
  edm::LogInfo("HGCSim") << "HGCSD: Particle code for mu- = " << mumPDG
             << " for mu+ = " << mupPDG;
#endif
}

bool HGCSD::isItinFidVolume ( G4ThreeVector &  )

inlineprivate

Definition at line 47 of file HGCSD.h.

References setTrackID().

{return true;}

bool HGCSD::ProcessHits ( G4Step *  aStep, G4TouchableHistory *    )

overridevirtual

Reimplemented from CaloSD.

Definition at line 94 of file HGCSD.cc.

References funct::abs(), CaloSD::createNewHit(), CaloSD::currentHit, CaloSD::edepositEM, CaloSD::edepositHAD, CaloSD::getStepInfo(), CaloSD::hitExists(), mumPDG, mupPDG, SensitiveDetector::NaNTrap(), alignCSCRings::r, slopeMin_, storeAllG4Hits_, and z.

                                                             {

  NaNTrap( aStep ) ;
  
  if (aStep == nullptr) {
    return true;
  } else {
    double r = aStep->GetPreStepPoint()->GetPosition().perp();
    double z = std::abs(aStep->GetPreStepPoint()->GetPosition().z());
#ifdef EDM_ML_DEBUG
    G4int parCode = aStep->GetTrack()->GetDefinition()->GetPDGEncoding();
    bool notaMuon = (parCode == mupPDG || parCode == mumPDG ) ? false : true;
    G4LogicalVolume* lv =
      aStep->GetPreStepPoint()->GetPhysicalVolume()->GetLogicalVolume();
    edm::LogInfo("HGCSim") << "HGCSD: Hit from standard path from "
               << lv->GetName() << " for Track " 
               << aStep->GetTrack()->GetTrackID() << " ("
               << aStep->GetTrack()->GetDefinition()->GetParticleName() 
               << ":" << notaMuon << ") R = " << r << " Z = " << z
               << " slope = " << r/z << ":" << slopeMin_;
#endif
    // Apply fiducial cuts
    if (r/z >= slopeMin_) {
      if (getStepInfo(aStep)) {
    if ((storeAllG4Hits_ || (hitExists() == false)) && 
        (edepositEM+edepositHAD>0.)) currentHit = createNewHit();
      }
    }
    return true;
  }
} 

uint32_t HGCSD::setDetUnitId ( G4Step *  step )

overridevirtual

Implements CaloSD.

Definition at line 134 of file HGCSD.cc.

References TauDecayModes::dec, HGCMouseBite::exclude(), triggerObjects_cff::id, levelT_, m_mode, python.rootplot.argparse::module, mouseBite_, myFwdSubdet_, CaloSD::preStepPoint, rejectMB_, HGCalGeometryMode::Square, HGCalTestNumbering::unpackHexagonIndex(), and z.

                                           { 

  G4StepPoint* preStepPoint = aStep->GetPreStepPoint(); 
  const G4VTouchable* touch = preStepPoint->GetTouchable();

  //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);

  //convert to local coordinates (=local to the current volume): 
  G4ThreeVector localpos = touch->GetHistory()->GetTopTransform().TransformPoint(hitPoint);
  
  //get the det unit id with 
  ForwardSubdetector subdet = myFwdSubdet_;

  int layer(0), module(0), cell(0);
  if (m_mode == HGCalGeometryMode::Square) {
    layer  = touch->GetReplicaNumber(0);
    module = touch->GetReplicaNumber(1);
  } else {
    if (touch->GetHistoryDepth() == levelT_) {
      layer  = touch->GetReplicaNumber(0);
      module = -1;
      cell   = -1;
#ifdef EDM_ML_DEBUG
      edm::LogInfo("HGCSim") << "Depths: " << touch->GetHistoryDepth() 
                 << " name " << touch->GetVolume(0)->GetName() 
                 << " layer:module:cell " << layer << ":" 
                 << module << ":" << cell << std::endl;
#endif
    } else {
      layer  = touch->GetReplicaNumber(2);
      module = touch->GetReplicaNumber(1);
      cell   = touch->GetReplicaNumber(0);
    }
#ifdef EDM_ML_DEBUG
    edm::LogInfo("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) << "   "
               << " layer:module:cell " << layer << ":" << module 
               << ":" << cell <<" Material " << mat->GetName()<<":"
               << aStep->GetPreStepPoint()->GetMaterial()->GetRadlen()
               << std::endl;
#endif
    if (aStep->GetPreStepPoint()->GetMaterial()->GetRadlen() > 100000.) return 0;
  }

  uint32_t id = setDetUnitId (subdet, layer, module, cell, iz, localpos);
  if (rejectMB_ && m_mode != HGCalGeometryMode::Square && id != 0) {
    int det, z, lay, wafer, type, ic;
    HGCalTestNumbering::unpackHexagonIndex(id, det, z, lay, wafer, type, ic);
#ifdef EDM_ML_DEBUG
    edm::LogInfo("HGCSim") << "ID " << std::hex << id << std::dec << " Decode "
               << det << ":" << z << ":" << lay << ":" << wafer 
               << ":" << type << ":" << ic << std::endl;
#endif
    if (mouseBite_->exclude(hitPoint, z, wafer)) id = 0;
  }
  return id;
}

uint32_t HGCSD::setDetUnitId ( ForwardSubdetector &  subdet, int  layer, int  module, int  cell, int  iz, G4ThreeVector &  pos  )

private

Definition at line 239 of file HGCSD.cc.

References HGCNumberingScheme::getUnitID(), triggerObjects_cff::id, and numberingScheme.

                                                        {  
  uint32_t id = numberingScheme ? 
    numberingScheme->getUnitID(subdet, layer, module, cell, iz, pos) : 0;
  return id;
}

int HGCSD::setTrackID ( G4Step *  step )

private

Definition at line 246 of file HGCSD.cc.

References TrackInformation::getIDonCaloSurface(), CaloSD::preStepPoint, CaloSD::previousID, CaloSD::resetForNewPrimary(), CaloSD::theTrack, and CaloHitID::trackID().

Referenced by isItinFidVolume().

                                    {
  theTrack     = aStep->GetTrack();

  double etrack = preStepPoint->GetKineticEnergy();
  TrackInformation * trkInfo = (TrackInformation *)(theTrack->GetUserInformation());
  int      primaryID = trkInfo->getIDonCaloSurface();
  if (primaryID == 0) {
#ifdef EDM_ML_DEBUG
    edm::LogInfo("HGCSim") << "HGCSD: Problem with primaryID **** set by "
               << "force to TkID **** " <<theTrack->GetTrackID();
#endif
    primaryID = theTrack->GetTrackID();
  }

  if (primaryID != previousID.trackID())
    resetForNewPrimary(preStepPoint->GetPosition(), etrack);

  return primaryID;
}

void HGCSD::update ( const BeginOfJob *  )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfJob * >.

Definition at line 200 of file HGCSD.cc.

References angles_, Exception, HGCalDDDConstants::geomMode(), edm::EventSetup::get(), levelT_, HGCalDDDConstants::levelTop(), m_mode, HGCalDDDConstants::minSlope(), mouseBite_, mouseBiteCut_, nameX, numberingScheme, rejectMB_, slopeMin_, and waferRot_.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), Vispa.Gui.VispaWidget.VispaWidget::autosize(), Vispa.Views.LineDecayView.LineDecayContainer::createObject(), Vispa.Views.LineDecayView.LineDecayContainer::deselectAllObjects(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::deselectAllWidgets(), Vispa.Gui.VispaWidget.VispaWidget::enableAutosizing(), progressbar.ProgressBar::finish(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseMoveEvent(), Vispa.Gui.MenuWidget.MenuWidget::mouseMoveEvent(), Vispa.Views.LineDecayView.LineDecayContainer::mouseMoveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseReleaseEvent(), Vispa.Views.LineDecayView.LineDecayContainer::objectMoved(), MatrixUtil.Steps::overwrite(), Vispa.Views.LineDecayView.LineDecayContainer::removeObject(), Vispa.Gui.ConnectableWidget.ConnectableWidget::removePorts(), Vispa.Gui.FindDialog.FindDialog::reset(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), Vispa.Gui.VispaWidget.VispaWidget::setText(), Vispa.Gui.VispaWidget.VispaWidget::setTitle(), Vispa.Gui.ZoomableWidget.ZoomableWidget::setZoom(), Vispa.Views.LineDecayView.LineDecayContainer::setZoom(), and Vispa.Gui.PortConnection.PointToPointConnection::updateConnection().

                                         {

  const edm::EventSetup* es = (*job)();
  edm::ESHandle<HGCalDDDConstants>    hdc;
  es->get<IdealGeometryRecord>().get(nameX,hdc);
  if (hdc.isValid()) {
    const HGCalDDDConstants* hgcons = hdc.product();
    m_mode                    = hgcons->geomMode();
    slopeMin_                 = hgcons->minSlope();
    levelT_                   = hgcons->levelTop();
    numberingScheme           = new HGCNumberingScheme(*hgcons,nameX);
    if (rejectMB_) mouseBite_ = new HGCMouseBite(*hgcons,angles_,mouseBiteCut_,waferRot_);
  } else {
    edm::LogError("HGCSim") << "HCalSD : Cannot find HGCalDDDConstants for "
                << nameX;
    throw cms::Exception("Unknown", "HGCSD") << "Cannot find HGCalDDDConstants for " << nameX << "\n";
  }
#ifdef EDM_ML_DEBUG
  edm::LogInfo("HGCSim") << "HGCSD::Initialized with mode " << m_mode 
             << " Slope cut " << slopeMin_ << " top Level "
             << levelT_ << std::endl;
#endif
}

Member Data Documentation

std::vector<double> HGCSD::angles_

private

Definition at line 62 of file HGCSD.h.

Referenced by HGCSD(), and update().

double HGCSD::eminHit

private

Definition at line 56 of file HGCSD.h.

Referenced by filterHit(), and HGCSD().

int HGCSD::levelT_

private

Definition at line 59 of file HGCSD.h.

Referenced by setDetUnitId(), and update().

HGCalGeometryMode::GeometryMode HGCSD::m_mode

private

Definition at line 52 of file HGCSD.h.

Referenced by setDetUnitId(), and update().

HGCMouseBite* HGCSD::mouseBite_

private

Definition at line 54 of file HGCSD.h.

Referenced by setDetUnitId(), update(), and ~HGCSD().

double HGCSD::mouseBiteCut_

private

Definition at line 61 of file HGCSD.h.

Referenced by HGCSD(), and update().

G4int HGCSD::mumPDG

private

Definition at line 55 of file HGCSD.h.

Referenced by initRun(), and ProcessHits().

G4int HGCSD::mupPDG

private

Definition at line 55 of file HGCSD.h.

Referenced by initRun(), and ProcessHits().

ForwardSubdetector HGCSD::myFwdSubdet_

private

Definition at line 57 of file HGCSD.h.

Referenced by HGCSD(), and setDetUnitId().

std::string HGCSD::nameX

private

Definition at line 50 of file HGCSD.h.

Referenced by HGCSD(), and update().

HGCNumberingScheme* HGCSD::numberingScheme

private

Definition at line 53 of file HGCSD.h.

Referenced by setDetUnitId(), update(), and ~HGCSD().

bool HGCSD::rejectMB_

private

Definition at line 60 of file HGCSD.h.

Referenced by HGCSD(), setDetUnitId(), and update().

double HGCSD::slopeMin_

private

Definition at line 58 of file HGCSD.h.

Referenced by ProcessHits(), and update().

bool HGCSD::storeAllG4Hits_

private

Definition at line 60 of file HGCSD.h.

Referenced by HGCSD(), and ProcessHits().

bool HGCSD::waferRot_

private

Definition at line 60 of file HGCSD.h.

Referenced by HGCSD(), and update().