Basic sensitive detector for trackers. More...

#include <TrackerSD.h>

Public Member Functions
	TrackerSD (const std::string &name, simcore::ConditionsInterface &ci, const framework::config::Parameters &p)
	Class constructor.

virtual	~TrackerSD ()=default
	Destructor.

virtual bool	isSensDet (G4LogicalVolume *volume) const override
	Should the input logical volume be attached to this sensitive detector?

G4bool	ProcessHits (G4Step step, G4TouchableHistory history) override
	Process a step by creating a hit.

virtual void	saveHits (framework::Event &event) override
	Add the hits to the event and then reset the container.

virtual void	OnFinishedEvent () override
	Cleanup SD and prepare a new-event state.

Public Member Functions inherited from simcore::SensitiveDetector
	SensitiveDetector (const std::string &name, simcore::ConditionsInterface &ci, const framework::config::Parameters &parameters)
	Constructor.

virtual	~SensitiveDetector ()=default
	Destructor.

virtual void	EndOfEvent (G4HCofThisEvent *) override
	This is Geant4's handle to tell us the event is ending.

Private Attributes
std::string	subsystem_
	The name of the subsystem we are apart of.

std::string	collection_name_
	The name of the output collection.

std::vector< ldmx::SimTrackerHit >	hits_
	The collection of hits.

ldmx::SubdetectorIDType	subDetID_
	The detector ID.

Additional Inherited Members
Public Types inherited from simcore::SensitiveDetector
using	Factory = ::simcore::Factory< SensitiveDetector, SensitiveDetector *, const std::string &, simcore::ConditionsInterface &, const framework::config::Parameters & >
	The SD Factory.

Protected Member Functions inherited from simcore::SensitiveDetector
template<class T >
const T &	getCondition (const std::string &condition_name)
	Record the configuration of this detector into the run header.

bool	isGeantino (const G4Step *step) const
	Check if the passed step is a step of a geantino.

const TrackMap &	getTrackMap () const
	Get a handle to the current track map.

Detailed Description

Basic sensitive detector for trackers.

Definition at line 14 of file TrackerSD.h.

Constructor & Destructor Documentation

◆ TrackerSD()

simcore::TrackerSD::TrackerSD	(	const std::string &	name,
		simcore::ConditionsInterface &	ci,
		const framework::config::Parameters &	p
	)

Class constructor.

Parameters

[in]	name	The name of the sensitive detector.
[in]	ci	conditions interface handle
[in]	p	parameters to configure sensitive detector

Definition at line 11 of file TrackerSD.cxx.

    : SensitiveDetector(name, ci, p) {
  subsystem_ = p.getParameter<std::string>("subsystem");
  collection_name_ = p.getParameter<std::string>("collection_name");
 
  subDetID_ = ldmx::SubdetectorIDType(p.getParameter<int>("subdet_id"));
}

References collection_name_, framework::config::Parameters::getParameter(), subDetID_, and subsystem_.

Member Function Documentation

◆ isSensDet()

virtual bool simcore::TrackerSD::isSensDet ( G4LogicalVolume * volume ) const

inlineoverridevirtual

Should the input logical volume be attached to this sensitive detector?

Note: This is dependent on the naming convention in the GDML!

Implements simcore::SensitiveDetector.

Definition at line 34 of file TrackerSD.h.

                                                                 {
    return (volume->GetName().contains("Sensor") and
            volume->GetName().contains(subsystem_));
  }

References subsystem_.

◆ OnFinishedEvent()

virtual void simcore::TrackerSD::OnFinishedEvent ( )

inlineoverridevirtual

Cleanup SD and prepare a new-event state.

Implements simcore::SensitiveDetector.

Definition at line 54 of file TrackerSD.h.

54{ hits_.clear(); }

simcore::TrackerSD::hits_

std::vector< ldmx::SimTrackerHit > hits_

The collection of hits.

Definition TrackerSD.h:64

References hits_.

◆ ProcessHits()

G4bool simcore::TrackerSD::ProcessHits	(	G4Step *	step,
		G4TouchableHistory *	history
	)

overridevirtual

Process a step by creating a hit.

Parameters

step	The step information
history	The readout history.

Implements simcore::SensitiveDetector.

Definition at line 20 of file TrackerSD.cxx.

                                                                {
  // Get the edep from the step.
  G4double edep = aStep->GetTotalEnergyDeposit();
 
  // Skip steps with no energy dep which come from non-Geantino particles.
  if (edep == 0.0 and not isGeantino(aStep)) {
    if (verboseLevel > 2) {
      std::cout << "TrackerSD skipping step with zero edep" << std::endl
                << std::endl;
    }
    return false;
  }
 
  // Create a new hit object.
  ldmx::SimTrackerHit& hit{hits_.emplace_back()};
 
  // Assign track ID for finding the SimParticle in post event processing.
  hit.setTrackID(aStep->GetTrack()->GetTrackID());
 
  // Set the edep.
  hit.setEdep(edep);
 
  // Set the start position.
  G4StepPoint* prePoint = aStep->GetPreStepPoint();
  // hit->setStartPosition(prePoint->GetPosition());
 
  // Set the end position.
  G4StepPoint* postPoint = aStep->GetPostStepPoint();
  // hit->setEndPosition(postPoint->GetPosition());
 
  G4ThreeVector start = prePoint->GetPosition();
  G4ThreeVector end = postPoint->GetPosition();
 
  // Set the mid position.
  G4ThreeVector mid = 0.5 * (start + end);
  hit.setPosition(mid.x(), mid.y(), mid.z());
 
  // Compute path length.
  G4double pathLength =
      sqrt(pow(start.x() - end.x(), 2) + pow(start.y() - end.y(), 2) +
           pow(start.z() - end.z(), 2));
  hit.setPathLength(pathLength);
 
  // Set the global time.
  hit.setTime(aStep->GetTrack()->GetGlobalTime());
 
  /*
   * Compute and set the momentum.
   */
  G4ThreeVector p = postPoint->GetMomentum();
  hit.setMomentum(p.x(), p.y(), p.z());
 
  /*
   * Set the 32-bit ID on the hit.
   */
  int copyNum =
      prePoint->GetTouchableHandle()->GetHistory()->GetVolume(2)->GetCopyNo();
  int layer = copyNum / 10;
  int module = copyNum % 10;
  ldmx::TrackerID id(subDetID_, layer, module);
  hit.setID(id.raw());
  hit.setLayerID(layer);
  hit.setModuleID(module);
 
  // Set energy and pdg code of SimParticle (common things requested)
  hit.setEnergy(postPoint->GetTotalEnergy());
  hit.setPdgID(aStep->GetTrack()->GetDynamicParticle()->GetPDGcode());
 
  return true;
}

References hits_, simcore::SensitiveDetector::isGeantino(), ldmx::SimTrackerHit::setTrackID(), and subDetID_.

◆ saveHits()

virtual void simcore::TrackerSD::saveHits ( framework::Event & event )

inlineoverridevirtual

Add the hits to the event and then reset the container.

Implements simcore::SensitiveDetector.

Definition at line 50 of file TrackerSD.h.

                                                        {
    event.add(collection_name_, hits_);
  }

References collection_name_, and hits_.

Member Data Documentation

◆ collection_name_

std::string simcore::TrackerSD::collection_name_

private

The name of the output collection.

Definition at line 61 of file TrackerSD.h.

Referenced by saveHits(), and TrackerSD().

◆ hits_

std::vector<ldmx::SimTrackerHit> simcore::TrackerSD::hits_

private

The collection of hits.

Definition at line 64 of file TrackerSD.h.

Referenced by OnFinishedEvent(), ProcessHits(), and saveHits().

◆ subDetID_

ldmx::SubdetectorIDType simcore::TrackerSD::subDetID_

private

The detector ID.

Definition at line 67 of file TrackerSD.h.

Referenced by ProcessHits(), and TrackerSD().

◆ subsystem_

std::string simcore::TrackerSD::subsystem_

private

The name of the subsystem we are apart of.

Definition at line 58 of file TrackerSD.h.

Referenced by isSensDet(), and TrackerSD().

The documentation for this class was generated from the following files:

SimCore/include/SimCore/SDs/TrackerSD.h
SimCore/src/SimCore/SDs/TrackerSD.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrackerSD()

Member Function Documentation

◆ isSensDet()

◆ OnFinishedEvent()

◆ ProcessHits()

◆ saveHits()

Member Data Documentation

◆ collection_name_

◆ hits_

◆ subDetID_

◆ subsystem_