SensitiveDetector Class Reference

#include <SensitiveDetector.h>

Inheritance diagram for SensitiveDetector:

Public Member Functions
virtual void	clearHits ()=0
void	EndOfEvent (G4HCofThisEvent *eventHC) override
const std::vector< std::string > &	getNames () const
void	Initialize (G4HCofThisEvent *eventHC) override
bool	isCaloSD () const
G4bool	ProcessHits (G4Step *step, G4TouchableHistory *tHistory) override=0
	SensitiveDetector (const std::string &iname, const SensitiveDetectorCatalog &, bool calo, const std::string &newcollname="")
virtual uint32_t	setDetUnitId (const G4Step *step)=0
	~SensitiveDetector () override

Protected Types
enum	coordinates { WorldCoordinates, LocalCoordinates }

Protected Member Functions
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 > &)

Private Member Functions
void	AssignSD (const std::string &vname)

Private Attributes
bool	m_isCalo
std::vector< std::string >	m_namesOfSD

Detailed Description

Definition at line 19 of file SensitiveDetector.h.

Member Enumeration Documentation

coordinates

enum SensitiveDetector::coordinates

protected

Enumerator
WorldCoordinates
LocalCoordinates

Definition at line 41 of file SensitiveDetector.h.

{ WorldCoordinates, LocalCoordinates };

Constructor & Destructor Documentation

SensitiveDetector()

SensitiveDetector::SensitiveDetector ( const std::string &  iname, const SensitiveDetectorCatalog &  clg, bool  calo, const std::string &  newcollname = ""  )

explicit

Definition at line 17 of file SensitiveDetector.cc.

References AssignSD(), bysipixelclustmulteventfilter_cfi::collectionName, SensitiveDetectorCatalog::logicalNames(), materialBudgetVolume_cfi::lvNames, m_namesOfSD, and contentValuesCheck::ss.

    : G4VSensitiveDetector(iname), m_isCalo(calo) {
  // for CMS hits
  m_namesOfSD.push_back(iname);

  // Geant4 hit collection
  collectionName.insert(iname);
  if (!newcollname.empty())
    collectionName.insert(newcollname);

  // register sensitive detector
  G4SDManager* SDman = G4SDManager::GetSDMpointer();
  SDman->AddNewDetector(this);

  const std::vector<std::string_view>& lvNames = clg.logicalNames(iname);
  std::stringstream ss;
  for (auto& lvname : lvNames) {
    this->AssignSD({lvname.data(), lvname.size()});
    ss << " " << lvname << "\n";
  }
  if (newcollname.empty())
    ss << " Collection " << iname;
  else
    ss << " Collections " << iname << " and " << newcollname;
  edm::LogVerbatim("SensitiveDetector") << " <" << iname << "> : Assigns SD to " << lvNames.size() << " LVs "
                                        << ss.str();
}

~SensitiveDetector()

SensitiveDetector::~SensitiveDetector ( )

override

Definition at line 48 of file SensitiveDetector.cc.

{}

Member Function Documentation

AssignSD()

void SensitiveDetector::AssignSD ( const std::string &  vname )

private

Definition at line 54 of file SensitiveDetector.cc.

Referenced by SensitiveDetector().

                                                       {
  G4LogicalVolumeStore* theStore = G4LogicalVolumeStore::GetInstance();
  for (auto& lv : *theStore) {
    if (vname == lv->GetName()) {
      lv->SetSensitiveDetector(this);
    }
  }
}

clearHits()

virtual void SensitiveDetector::clearHits ( )

pure virtual

Implemented in CaloSD, FP420SD, PPSPixelSD, TotemSD, MuonSensitiveDetector, FiberSD, TkAccumulatingSensitiveDetector, CaloTrkProcessing, PPSDiamondSD, TotemRPSD, TimingSD, HFChamberSD, and HFWedgeSD.

cmsTrackInformation()

TrackInformation * SensitiveDetector::cmsTrackInformation ( const G4Track *  aTrack )

protected

Definition at line 101 of file SensitiveDetector.cc.

References info().

Referenced by TkAccumulatingSensitiveDetector::createHit(), MuonSensitiveDetector::createHit(), CaloSD::createNewHit(), CaloSD::findBoundaryCrossingParent(), CaloSD::getResponseWt(), TimingSD::getStepInfo(), MtdSD::getTrackID(), CaloSD::getTrackID(), CaloSD::setTrackID(), TkAccumulatingSensitiveDetector::update(), and CaloSD::update().

                                                                              {
  TrackInformation* info = (TrackInformation*)(aTrack->GetUserInformation());
  if (nullptr == info) {
    edm::LogWarning("SensitiveDetector") << " no TrackInformation available for trackID= " << aTrack->GetTrackID()
                                         << " inside SD " << GetName();
    G4Exception(
        "SensitiveDetector::cmsTrackInformation()", "sd01", FatalException, "cannot handle hits without trackinfo");
  }
  return info;
}

ConvertToLocal3DPoint()

Local3DPoint SensitiveDetector::ConvertToLocal3DPoint ( const G4ThreeVector &  point ) const

inlineprotected

Definition at line 49 of file SensitiveDetector.h.

References point.

Referenced by TkAccumulatingSensitiveDetector::createHit(), MuonSensitiveDetector::createHit(), TimingSD::EndOfEvent(), FinalStepPosition(), MuonSensitiveDetector::FinalStepPositionVsParent(), InitialStepPosition(), MuonSensitiveDetector::InitialStepPositionVsParent(), LocalPostStepPosition(), LocalPreStepPosition(), TotemRPSD::stepInfo(), PPSDiamondSD::stepInfo(), and TkAccumulatingSensitiveDetector::updateHit().

                                                                              {
    return Local3DPoint(point.x(), point.y(), point.z());
  }

EndOfEvent()

void SensitiveDetector::EndOfEvent ( G4HCofThisEvent *  eventHC )

override

Definition at line 52 of file SensitiveDetector.cc.

{}

FinalStepPosition()

Local3DPoint SensitiveDetector::FinalStepPosition ( const G4Step *  step, coordinates  cd  ) const

protected

Definition at line 75 of file SensitiveDetector.cc.

References hippyaddtobaddatafiles::cd(), ConvertToLocal3DPoint(), and WorldCoordinates.

Referenced by MuonSensitiveDetector::createHit(), and MuonSensitiveDetector::updateHit().

                                                                                          {
  const G4StepPoint* postStepPoint = step->GetPostStepPoint();
  const G4ThreeVector& globalCoordinates = postStepPoint->GetPosition();
  if (cd == WorldCoordinates) {
    return ConvertToLocal3DPoint(globalCoordinates);
  }
  const G4StepPoint* preStepPoint = step->GetPreStepPoint();
  const G4ThreeVector localCoordinates =
      preStepPoint->GetTouchable()->GetHistory()->GetTopTransform().TransformPoint(globalCoordinates);
  return ConvertToLocal3DPoint(localCoordinates);
}

getNames()

const std::vector<std::string>& SensitiveDetector::getNames ( ) const

inline

Definition at line 35 of file SensitiveDetector.h.

References m_namesOfSD.

{ return m_namesOfSD; }

Initialize()

void SensitiveDetector::Initialize ( G4HCofThisEvent *  eventHC )

override

Definition at line 50 of file SensitiveDetector.cc.

{}

InitialStepPosition()

Local3DPoint SensitiveDetector::InitialStepPosition ( const G4Step *  step, coordinates  cd  ) const

protected

Definition at line 63 of file SensitiveDetector.cc.

References hippyaddtobaddatafiles::cd(), ConvertToLocal3DPoint(), and WorldCoordinates.

Referenced by MuonSensitiveDetector::createHit(), and MuonSensitiveDetector::ProcessHits().

                                                                                            {
  const G4StepPoint* preStepPoint = step->GetPreStepPoint();
  const G4ThreeVector& globalCoordinates = preStepPoint->GetPosition();
  if (cd == WorldCoordinates) {
    return ConvertToLocal3DPoint(globalCoordinates);
  }
  const G4TouchableHistory* theTouchable = static_cast<const G4TouchableHistory*>(preStepPoint->GetTouchable());
  const G4ThreeVector localCoordinates =
      theTouchable->GetHistory()->GetTopTransform().TransformPoint(globalCoordinates);
  return ConvertToLocal3DPoint(localCoordinates);
}

isCaloSD()

bool SensitiveDetector::isCaloSD ( ) const

inline

Definition at line 37 of file SensitiveDetector.h.

References m_isCalo.

{ return m_isCalo; }

LocalPostStepPosition()

Local3DPoint SensitiveDetector::LocalPostStepPosition ( const G4Step *  step ) const

protected

Definition at line 94 of file SensitiveDetector.cc.

References ConvertToLocal3DPoint().

Referenced by TkAccumulatingSensitiveDetector::createHit(), and TkAccumulatingSensitiveDetector::updateHit().

                                                                              {
  const G4ThreeVector& globalCoordinates = step->GetPostStepPoint()->GetPosition();
  G4ThreeVector localCoordinates =
      step->GetPreStepPoint()->GetTouchable()->GetHistory()->GetTopTransform().TransformPoint(globalCoordinates);
  return ConvertToLocal3DPoint(localCoordinates);
}

LocalPreStepPosition()

Local3DPoint SensitiveDetector::LocalPreStepPosition ( const G4Step *  step ) const

protected

Definition at line 87 of file SensitiveDetector.cc.

References ConvertToLocal3DPoint().

Referenced by TkAccumulatingSensitiveDetector::closeHit(), and TkAccumulatingSensitiveDetector::createHit().

                                                                             {
  const G4StepPoint* preStepPoint = step->GetPreStepPoint();
  G4ThreeVector localCoordinates =
      preStepPoint->GetTouchable()->GetHistory()->GetTopTransform().TransformPoint(preStepPoint->GetPosition());
  return ConvertToLocal3DPoint(localCoordinates);
}

NaNTrap()

void SensitiveDetector::NaNTrap ( const G4Step *  step ) const

protected

Definition at line 117 of file SensitiveDetector.cc.

References edm::isNotFinite().

Referenced by CaloSD::ProcessHits().

                                                         {
  G4Track* currentTrk = aStep->GetTrack();
  double ekin = currentTrk->GetKineticEnergy();
  if (ekin < 0.0) {
    const G4VPhysicalVolume* pCurrentVol = aStep->GetPreStepPoint()->GetPhysicalVolume();
    edm::LogWarning("SensitiveDetector") << "Negative kinetic energy Ekin(MeV)=" << ekin / CLHEP::MeV << " of "
                                         << currentTrk->GetDefinition()->GetParticleName()
                                         << " trackID= " << currentTrk->GetTrackID() << " inside "
                                         << pCurrentVol->GetName();
    currentTrk->SetKineticEnergy(0.0);
  }
  const G4ThreeVector& currentPos = currentTrk->GetPosition();
  double xyz = currentPos.x() + currentPos.y() + currentPos.z();
  const G4ThreeVector& currentMom = currentTrk->GetMomentum();
  xyz += currentMom.x() + currentMom.y() + currentMom.z();

  if (edm::isNotFinite(xyz)) {
    const G4VPhysicalVolume* pCurrentVol = aStep->GetPreStepPoint()->GetPhysicalVolume();
    edm::LogWarning("SensitiveDetector") << "NaN detected for trackID= " << currentTrk->GetTrackID() << " inside "
                                         << pCurrentVol->GetName();
    G4Exception("SensitiveDetector::NaNTrap()", "sd01", FatalException, "corrupted event or step");
  }
}

ProcessHits()

G4bool SensitiveDetector::ProcessHits ( G4Step *  step, G4TouchableHistory *  tHistory  )

overridepure virtual

Implemented in CaloSD, PPSPixelSD, FP420SD, TotemSD, MuonSensitiveDetector, CaloTrkProcessing, FiberSD, TkAccumulatingSensitiveDetector, PPSDiamondSD, TotemRPSD, TimingSD, HFChamberSD, HFWedgeSD, and ZdcSD.

setDetUnitId()

virtual uint32_t SensitiveDetector::setDetUnitId ( const G4Step *  step )

pure virtual

Implemented in CaloSD, PPSPixelSD, FP420SD, TotemSD, FiberSD, HCalSD, MuonSensitiveDetector, CaloTrkProcessing, PPSDiamondSD, TotemRPSD, TkAccumulatingSensitiveDetector, ECalSD, HcalTB02SD, CastorSD, HGCSD, HFChamberSD, HFWedgeSD, HGCalSD, HFNoseSD, DreamSD, HGCScintSD, EcalTBH4BeamSD, HcalTB06BeamSD, MtdSD, BHMSD, ZdcSD, BscSD, HGCalTB16SD01, Bcm1fSD, PltSD, AHCalSD, and TotemT2ScintSD.

Referenced by TimingSD::getStepInfo().

setNames()

void SensitiveDetector::setNames ( const std::vector< std::string > &  hnames )

protected

Definition at line 112 of file SensitiveDetector.cc.

References m_namesOfSD.

Referenced by TkAccumulatingSensitiveDetector::TkAccumulatingSensitiveDetector().

                                                                   {
  m_namesOfSD.clear();
  m_namesOfSD = hnames;
}

Member Data Documentation

m_isCalo

bool SensitiveDetector::m_isCalo

private

Definition at line 62 of file SensitiveDetector.h.

Referenced by isCaloSD().

m_namesOfSD

std::vector<std::string> SensitiveDetector::m_namesOfSD

private

Definition at line 61 of file SensitiveDetector.h.

Referenced by getNames(), SensitiveDetector(), and setNames().