HGCSD Class Reference

#include <HGCSD.h>

Inheritance diagram for HGCSD:

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

Private Attributes
std::vector< double >	angles_
double	eminHit_
HGCalGeometryMode::GeometryMode	geom_mode_
int	levelT_
std::unique_ptr< HGCMouseBite >	mouseBite_
double	mouseBiteCut_
ForwardSubdetector	myFwdSubdet_
std::string	nameX_
std::unique_ptr< HGCNumberingScheme >	numberingScheme_
bool	rejectMB_
double	slopeMin_
bool	storeAllG4Hits_
bool	waferRot_

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 23 of file HGCSD.h.

Constructor & Destructor Documentation

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

Definition at line 36 of file HGCSD.cc.

References angles_, CaloSD::eminHit, eminHit_, ForwardEmpty, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), HGCEE, HGCHEB, HGCHEF, MeV, mouseBite_, mouseBiteCut_, myFwdSubdet_, dataset::name, nameX_, numberingScheme_, rejectMB_, CaloSD::setNumberCheckedHits(), CaloSD::setUseMap(), 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")), 
  slopeMin_(0), levelT_(99) {

  numberingScheme_.reset(nullptr); mouseBite_.reset(nullptr);

  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;

  if(storeAllG4Hits_) {
    setUseMap(false);
    setNumberCheckedHits(0);
  }
  //this is defined in the hgcsens.xml
  G4String myName = name;
  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::LogVerbatim("HGCSim")<< "**************************************************"
                << "\n"
                << "*                                                *"
                << "\n"
                << "* Constructing a HGCSD  with name " << name << "\n"
                << "*                                                *"
                << "\n"
                << "**************************************************";
#endif
  edm::LogVerbatim("HGCSim") << "HGCSD:: Threshold for storing hits: " 
                 << eminHit << " for " << nameX_ << " subdet "
                 << myFwdSubdet_;
  edm::LogVerbatim("HGCSim") << "Flag for storing individual Geant4 Hits "
                 << storeAllG4Hits_;
  edm::LogVerbatim("HGCSim") << "Reject MosueBite Flag: " << rejectMB_ 
                 << " Size of wafer " << waferSize 
                 << " Mouse Bite " << mouseBite << ":"
                 << mouseBiteCut_ << " along " << angles_.size() 
                 << " axes";
}

HGCSD::~HGCSD ( )

overridedefault

Member Function Documentation

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

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 216 of file HGCSD.cc.

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

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

double HGCSD::getEnergyDeposit ( const G4Step *  aStep )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 97 of file HGCSD.cc.

References funct::abs(), CaloSD::getResponseWt(), alignCSCRings::r, slopeMin_, 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();
  G4LogicalVolume* lv =
    aStep->GetPreStepPoint()->GetPhysicalVolume()->GetLogicalVolume();
  edm::LogVerbatim("HGCSim") << "HGCSD: Hit from standard path from "
                 << lv->GetName() << " for Track " 
                 << aStep->GetTrack()->GetTrackID() << " ("
                 << aStep->GetTrack()->GetDefinition()->GetParticleName() 
                 << ") R = " << r << " Z = "
                 << z << " slope = " << r/z << ":" << slopeMin_;
#endif

  // Apply fiductial volume
  if (r < z*slopeMin_) { return 0.0; }
 
  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 ( )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 213 of file HGCSD.cc.

                    {
}

bool HGCSD::isItinFidVolume ( const G4ThreeVector &  )

inlineprivate

Definition at line 45 of file HGCSD.h.

{return true;}

uint32_t HGCSD::setDetUnitId ( const G4Step *  step )

overridevirtual

Implements CaloSD.

Definition at line 124 of file HGCSD.cc.

References TauDecayModes::dec, triggerObjects_cff::id, levelT_, mouseBite_, myFwdSubdet_, rejectMB_, HGCalTestNumbering::unpackHexagonIndex(), and z.

                                                 { 

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

  //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, module, cell;
  if (touch->GetHistoryDepth() == levelT_) {
    layer  = touch->GetReplicaNumber(0);
    module = -1;
    cell   = -1;
#ifdef EDM_ML_DEBUG
    edm::LogVerbatim("HGCSim") << "Depths: " << touch->GetHistoryDepth() 
                   << " name " << touch->GetVolume(0)->GetName() 
                   << " layer:module:cell " << layer << ":" 
                   << module << ":" << cell;
#endif
  } else {
    layer  = touch->GetReplicaNumber(2);
    module = touch->GetReplicaNumber(1);
    cell   = touch->GetReplicaNumber(0);
  }
#ifdef EDM_ML_DEBUG
  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) << "   "
                 << " layer:module:cell " << layer << ":"
                 << module << ":" << cell <<" Material "
                 << mat->GetName() << ":"
                 << aStep->GetPreStepPoint()->GetMaterial()->GetRadlen();
#endif
  // The following statement should be examined later before elimination
  // VI: this is likely a check if media is vacuum - not needed 
  if (aStep->GetPreStepPoint()->GetMaterial()->GetRadlen() > 100000.) return 0;
  
  uint32_t id = setDetUnitId (subdet, layer, module, cell, iz, localpos);
  if (rejectMB_ && id != 0) {
    int det, z, lay, wafer, type, ic;
    HGCalTestNumbering::unpackHexagonIndex(id, det, z, lay, wafer, type, ic);
#ifdef EDM_ML_DEBUG
    edm::LogVerbatim("HGCSim") << "ID " << std::hex << id << std::dec 
                   << " Decode " << det << ":" << z << ":" << lay
                   << ":" << wafer << ":" << type << ":" << ic;
#endif
    if (mouseBite_->exclude(hitPoint, z, wafer, 0)) id = 0;
  }
  return id;
}

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

private

Definition at line 220 of file HGCSD.cc.

References triggerObjects_cff::id, and numberingScheme_.

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

void HGCSD::update ( const BeginOfJob *  )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfJob * >.

Definition at line 187 of file HGCSD.cc.

References angles_, Exception, geom_mode_, HGCalDDDConstants::geomMode(), edm::EventSetup::get(), levelT_, HGCalDDDConstants::levelTop(), 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();
    geom_mode_                = hgcons->geomMode();
    slopeMin_                 = hgcons->minSlope();
    levelT_                   = hgcons->levelTop();
    numberingScheme_.reset(new HGCNumberingScheme(*hgcons,nameX_));
    if (rejectMB_) mouseBite_.reset(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::LogVerbatim("HGCSim") << "HGCSD::Initialized with mode " << geom_mode_ 
                 << " Slope cut " << slopeMin_ << " top Level "
                 << levelT_;
#endif
}

Member Data Documentation

std::vector<double> HGCSD::angles_

private

Definition at line 57 of file HGCSD.h.

Referenced by HGCSD(), and update().

double HGCSD::eminHit_

private

Definition at line 51 of file HGCSD.h.

Referenced by filterHit(), and HGCSD().

HGCalGeometryMode::GeometryMode HGCSD::geom_mode_

private

Definition at line 48 of file HGCSD.h.

Referenced by update().

int HGCSD::levelT_

private

Definition at line 54 of file HGCSD.h.

Referenced by setDetUnitId(), and update().

std::unique_ptr<HGCMouseBite> HGCSD::mouseBite_

private

Definition at line 50 of file HGCSD.h.

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

double HGCSD::mouseBiteCut_

private

Definition at line 56 of file HGCSD.h.

Referenced by HGCSD(), and update().

ForwardSubdetector HGCSD::myFwdSubdet_

private

Definition at line 52 of file HGCSD.h.

Referenced by HGCSD(), and setDetUnitId().

std::string HGCSD::nameX_

private

Definition at line 47 of file HGCSD.h.

Referenced by HGCSD(), and update().

std::unique_ptr<HGCNumberingScheme> HGCSD::numberingScheme_

private

Definition at line 49 of file HGCSD.h.

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

bool HGCSD::rejectMB_

private

Definition at line 55 of file HGCSD.h.

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

double HGCSD::slopeMin_

private

Definition at line 53 of file HGCSD.h.

Referenced by getEnergyDeposit(), and update().

bool HGCSD::storeAllG4Hits_

private

Definition at line 55 of file HGCSD.h.

Referenced by HGCSD().

bool HGCSD::waferRot_

private

Definition at line 55 of file HGCSD.h.

Referenced by HGCSD(), and update().