HGCScintSD Class Reference

#include <HGCScintSD.h>

Inheritance diagram for HGCScintSD:

Public Member Functions
	HGCScintSD (const std::string &, const DDCompactView &, const SensitiveDetectorCatalog &, edm::ParameterSet const &, const SimTrackManager *)
uint32_t	setDetUnitId (const G4Step *step) override
	~HGCScintSD () override=default
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
	~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
	SensitiveDetector (const 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
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 *)
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	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
bool	isItinFidVolume (const G4ThreeVector &)
uint32_t	setDetUnitId (int, int, int, int, G4ThreeVector &)

Private Attributes
double	birk1_
double	birk2_
double	birk3_
double	distanceFromEdge_
double	eminHit_
bool	fiducialCut_
HGCalGeometryMode::GeometryMode	geom_mode_
const HGCalDDDConstants *	hgcons_
int	levelT1_
int	levelT2_
DetId::Detector	mydet_
std::string	nameX_
std::unique_ptr< HGCalNumberingScheme >	numberingScheme_
double	slopeMin_
bool	storeAllG4Hits_
bool	useBirk_
double	weight_

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

Definition at line 20 of file HGCScintSD.h.

Constructor & Destructor Documentation

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

Definition at line 37 of file HGCScintSD.cc.

References birk1_, birk2_, birk3_, distanceFromEdge_, eminHit_, fiducialCut_, DetId::Forward, g, edm::ParameterSet::getParameter(), DetId::HGCalHSc, MeV, mydet_, dataset::name, nameX_, numberingScheme_, CaloSD::setNumberCheckedHits(), CaloSD::setUseMap(), storeAllG4Hits_, and useBirk_.

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

  numberingScheme_.reset(nullptr);

  edm::ParameterSet m_HGC = p.getParameter<edm::ParameterSet>("HGCScintSD");
  eminHit_         = m_HGC.getParameter<double>("EminHit")*CLHEP::MeV;
  fiducialCut_     = m_HGC.getParameter<bool>("FiducialCut");
  distanceFromEdge_= m_HGC.getParameter<double>("DistanceFromEdge");
  useBirk_         = m_HGC.getParameter<bool>("UseBirkLaw");
  birk1_           = m_HGC.getParameter<double>("BirkC1")*(CLHEP::g/(CLHEP::MeV*CLHEP::cm2));
  birk2_           = m_HGC.getParameter<double>("BirkC2");
  birk3_           = m_HGC.getParameter<double>("BirkC3");
  storeAllG4Hits_  = m_HGC.getParameter<bool>("StoreAllG4Hits");

  if (storeAllG4Hits_) {
    setUseMap(false);
    setNumberCheckedHits(0);
  }

  //this is defined in the hgcsens.xml
  G4String myName = name;
  mydet_ = DetId::Forward;
  nameX_ = "HGCal";
  if (myName.find("HitsHEback")!=std::string::npos) {
    mydet_  = DetId::HGCalHSc;
    nameX_  = "HGCalHEScintillatorSensitive";
  }

#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("HGCSim")<< "**************************************************"
                << "\n"
                << "*                                                *"
                << "\n"
                << "* Constructing a HGCScintSD  with name " << name << "\n"
                << "*                                                *"
                << "\n"
                << "**************************************************";
#endif
  edm::LogVerbatim("HGCSim") << "HGCScintSD:: 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") << "Use of Birks law is set to      " << useBirk_
                 << "  with three constants kB = " << birk1_
                 << ", C1 = " << birk2_ << ", C2 = " << birk3_;
}

HGCScintSD::~HGCScintSD ( )

overridedefault

Member Function Documentation

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

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 227 of file HGCScintSD.cc.

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

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

double HGCScintSD::getEnergyDeposit ( const G4Step *  aStep )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 95 of file HGCScintSD.cc.

References funct::abs(), birk1_, birk2_, birk3_, CaloSD::getAttenuation(), CaloSD::getResponseWt(), alignCSCRings::r, slopeMin_, useBirk_, 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") << "HGCScintSD: 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") << "HGCScintSD: Fiducial Volume cut";
#endif
    return 0.0; 
  }

  double wt1    = getResponseWt(aStep->GetTrack());
  double wt2    = aStep->GetTrack()->GetWeight();
  double wt3    = (useBirk_ ? getAttenuation(aStep, birk1_, birk2_, birk3_) :
           1.0);
  double destep = weight_*wt1*wt3*(aStep->GetTotalEnergyDeposit());
  if (wt2 > 0) destep *= wt2;
#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("HGCalSim")  << "HGCScintSD: weights= " << weight_ << ":" 
                << wt1 << ":" << wt2 << ":" << wt3 
                << " Total weight " << weight_*wt1*wt2*wt3 
                << " deStep: " <<aStep->GetTotalEnergyDeposit()
                << ":" <<destep;
#endif
  return destep;
}

void HGCScintSD::initRun ( )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 224 of file HGCScintSD.cc.

                         {
}

bool HGCScintSD::isItinFidVolume ( const G4ThreeVector &  pos )

private

Definition at line 238 of file HGCScintSD.cc.

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

Referenced by setDetUnitId().

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

uint32_t HGCScintSD::setDetUnitId ( const G4Step *  step )

overridevirtual

Implements CaloSD.

Definition at line 135 of file HGCScintSD.cc.

References TauDecayModes::dec, triggerObjects_cff::id, isItinFidVolume(), levelT1_, and levelT2_.

                                                      { 

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

  int layer, module, cell;
  if ((touch->GetHistoryDepth() == levelT1_) || 
      (touch->GetHistoryDepth() == levelT2_)) {
    layer  = touch->GetReplicaNumber(0);
    module = -1;
    cell   = -1;
#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 (!isItinFidVolume(hitPoint)) {
#ifdef EDM_ML_DEBUG
    edm::LogVerbatim("HGCSim") << "ID " << std::hex << id << std::dec 
                   << " " << HGCScintillatorDetId(id) 
                   << " is rejected by fiducilal volume cut";
#endif
    id = 0;
  }
  return id;
}

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

private

Definition at line 231 of file HGCScintSD.cc.

References triggerObjects_cff::id, numberingScheme_, and weight_.

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

void HGCScintSD::update ( const BeginOfJob *  )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfJob * >.

Definition at line 201 of file HGCScintSD.cc.

References Exception, geom_mode_, HGCalDDDConstants::geomMode(), edm::EventSetup::get(), hgcons_, levelT1_, levelT2_, HGCalDDDConstants::levelTop(), HGCalDDDConstants::minSlope(), mydet_, nameX_, numberingScheme_, and slopeMin_.

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()) {
    hgcons_    = hdc.product();
    geom_mode_ = hgcons_->geomMode();
    slopeMin_  = hgcons_->minSlope();
    levelT1_   = hgcons_->levelTop(0);
    levelT2_   = hgcons_->levelTop(1);
#ifdef EDM_ML_DEBUG
    edm::LogVerbatim("HGCSim") << "HGCScintSD::Initialized with mode " 
                   << geom_mode_ << " Slope cut " << slopeMin_ 
                   << " top Level " << levelT1_ << ":" << levelT2_;
#endif

    numberingScheme_.reset(new HGCalNumberingScheme(*hgcons_,mydet_,nameX_));
  } else {
    throw cms::Exception("Unknown", "HGCScintSD") << "Cannot find HGCalDDDConstants for " << nameX_ << "\n";
  }
}

Member Data Documentation

double HGCScintSD::birk1_

private

Definition at line 52 of file HGCScintSD.h.

Referenced by getEnergyDeposit(), and HGCScintSD().

double HGCScintSD::birk2_

private

Definition at line 52 of file HGCScintSD.h.

Referenced by getEnergyDeposit(), and HGCScintSD().

double HGCScintSD::birk3_

private

Definition at line 52 of file HGCScintSD.h.

Referenced by getEnergyDeposit(), and HGCScintSD().

double HGCScintSD::distanceFromEdge_

private

Definition at line 48 of file HGCScintSD.h.

Referenced by HGCScintSD(), and isItinFidVolume().

double HGCScintSD::eminHit_

private

Definition at line 48 of file HGCScintSD.h.

Referenced by filterHit(), and HGCScintSD().

bool HGCScintSD::fiducialCut_

private

Definition at line 50 of file HGCScintSD.h.

Referenced by HGCScintSD(), and isItinFidVolume().

HGCalGeometryMode::GeometryMode HGCScintSD::geom_mode_

private

Definition at line 47 of file HGCScintSD.h.

Referenced by update().

const HGCalDDDConstants* HGCScintSD::hgcons_

private

Definition at line 43 of file HGCScintSD.h.

Referenced by isItinFidVolume(), and update().

int HGCScintSD::levelT1_

private

Definition at line 49 of file HGCScintSD.h.

Referenced by setDetUnitId(), and update().

int HGCScintSD::levelT2_

private

Definition at line 49 of file HGCScintSD.h.

Referenced by setDetUnitId(), and update().

DetId::Detector HGCScintSD::mydet_

private

Definition at line 45 of file HGCScintSD.h.

Referenced by HGCScintSD(), and update().

std::string HGCScintSD::nameX_

private

Definition at line 46 of file HGCScintSD.h.

Referenced by HGCScintSD(), and update().

std::unique_ptr<HGCalNumberingScheme> HGCScintSD::numberingScheme_

private

Definition at line 44 of file HGCScintSD.h.

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

double HGCScintSD::slopeMin_

private

Definition at line 48 of file HGCScintSD.h.

Referenced by getEnergyDeposit(), and update().

bool HGCScintSD::storeAllG4Hits_

private

Definition at line 50 of file HGCScintSD.h.

Referenced by HGCScintSD().

bool HGCScintSD::useBirk_

private

Definition at line 51 of file HGCScintSD.h.

Referenced by getEnergyDeposit(), and HGCScintSD().

double HGCScintSD::weight_

private

Definition at line 52 of file HGCScintSD.h.

Referenced by getEnergyDeposit(), and setDetUnitId().