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 DDCompactView &cpv, const SensitiveDetectorCatalog &, edm::ParameterSet const &p, bool calo)
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 22 of file SensitiveDetector.h.

Member Enumeration Documentation

enum SensitiveDetector::coordinates

protected

Enumerator
WorldCoordinates
LocalCoordinates

Definition at line 47 of file SensitiveDetector.h.

{WorldCoordinates, LocalCoordinates};

Constructor & Destructor Documentation

SensitiveDetector::SensitiveDetector ( const std::string &  iname, const DDCompactView &  cpv, const SensitiveDetectorCatalog &  clg, edm::ParameterSet const &  p, bool  calo  )

explicit

Definition at line 18 of file SensitiveDetector.cc.

References AssignSD(), ecaldqm::collectionName, SensitiveDetectorCatalog::logicalNames(), and m_namesOfSD.

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

  // Geant4 hit collection
  collectionName.insert(iname);

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

  const std::vector<std::string>& lvNames = clg.logicalNames(iname);
  std::stringstream ss;
  for (auto & lvname : lvNames) {
    this->AssignSD(lvname);
    ss << " " << lvname;
  }
  edm::LogVerbatim("SensitiveDetector") 
    << " <" << iname <<"> : Assigns SD to LVs " << ss.str();
}

SensitiveDetector::~SensitiveDetector ( )

override

Definition at line 45 of file SensitiveDetector.cc.

{}

Member Function Documentation

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

private

Definition at line 51 of file SensitiveDetector.cc.

Referenced by ConvertToLocal3DPoint(), and SensitiveDetector().

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

virtual void SensitiveDetector::clearHits ( )

pure virtual

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

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

protected

Definition at line 100 of file SensitiveDetector.cc.

References info().

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

{
  TrackInformation* info = (TrackInformation*)(aTrack->GetUserInformation());
  if (!info) { 
    edm::LogWarning("SensitiveDetector") 
      << " no TrackInformation available for trackID= " 
      << aTrack->GetTrackID();
    throw SimG4Exception("SimG4CoreSensitiveDetector: cannot handle hits for "
             + GetName());
  }
  return info;
}

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

inlineprotected

Definition at line 55 of file SensitiveDetector.h.

References AssignSD(), cmsTrackInformation(), NaNTrap(), setNames(), and AlCaHLTBitMon_QueryRunRegistry::string.

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

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

void SensitiveDetector::EndOfEvent ( G4HCofThisEvent *  eventHC )

override

Definition at line 49 of file SensitiveDetector.cc.

{}

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

protected

Definition at line 73 of file SensitiveDetector.cc.

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

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

inline

Definition at line 40 of file SensitiveDetector.h.

References m_namesOfSD.

Referenced by CaloTrkProcessing::CaloTrkProcessing(), CaloTrkProcessing::fillHits(), HCalSD::fillLogVolumeVector(), HCalSD::HCalSD(), and HcalTB06BeamSD::HcalTB06BeamSD().

{ return m_namesOfSD; }

void SensitiveDetector::Initialize ( G4HCofThisEvent *  eventHC )

override

Definition at line 47 of file SensitiveDetector.cc.

{}

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

protected

Definition at line 62 of file SensitiveDetector.cc.

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

bool SensitiveDetector::isCaloSD ( ) const

inline

Definition at line 42 of file SensitiveDetector.h.

References m_isCalo.

Referenced by AttachSD::create().

{ return m_isCalo; }

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

protected

Definition at line 92 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);
}

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

protected

Definition at line 84 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); 
}

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

protected

Definition at line 119 of file SensitiveDetector.cc.

References edm::isNotFinite().

Referenced by ConvertToLocal3DPoint(), and CaloSD::ProcessHits().

{
  const G4Track* CurrentTrk = aStep->GetTrack();
  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();
    const G4String& NameOfVol = pCurrentVol->GetName();
    throw SimG4Exception("SimG4CoreSensitiveDetector: Corrupted Event - NaN detected in volume "
              + NameOfVol);
  }
}

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

overridepure virtual

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

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

pure virtual

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

Referenced by TimingSD::getStepInfo().

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

protected

Definition at line 113 of file SensitiveDetector.cc.

References m_namesOfSD.

Referenced by ConvertToLocal3DPoint(), and TkAccumulatingSensitiveDetector::TkAccumulatingSensitiveDetector().

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

Member Data Documentation

bool SensitiveDetector::m_isCalo

private

Definition at line 68 of file SensitiveDetector.h.

Referenced by isCaloSD().

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

private

Definition at line 67 of file SensitiveDetector.h.

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