simcore::ScoringPlaneSD Class Reference

Class defining a basic sensitive detector for scoring planes. More...

#include <ScoringPlaneSD.h>

Public Member Functions
	ScoringPlaneSD (const std::string &name, simcore::ConditionsInterface &ci, const framework::config::Parameters &params)
	Constructor.
virtual	~ScoringPlaneSD ()=default
	Destructor.
bool	isSensDet (G4LogicalVolume *volume) const override
	Check if the input logical volume is a scoring plane we should include.
virtual G4bool	ProcessHits (G4Step *step, G4TouchableHistory *hist) override
	This is Geant4's handle to tell us that a particle has stepped through our sensitive detector and we should process its interaction with us.
virtual void	saveHits (framework::Event &event) override
	We are given the event bus here and we must decide now what to persist into the event.
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.
	DECLARE_FACTORY_WITH_WAREHOUSE (SensitiveDetector, SensitiveDetector *, const std::string &, simcore::ConditionsInterface &, const framework::config::Parameters &)
	The SD Factory.
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	match_substr_
	Substring to match to logical volumes.
std::string	collection_name_
	Name of output collection to add.
std::vector< ldmx::SimTrackerHit >	hits_
	The actual output collection.

Additional Inherited Members
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.
	enableLogging ("SensitiveDetector")
	Enable logging for this class.

Detailed Description

Class defining a basic sensitive detector for scoring planes.

Definition at line 13 of file ScoringPlaneSD.h.

Constructor & Destructor Documentation

ScoringPlaneSD()

simcore::ScoringPlaneSD::ScoringPlaneSD	(	const std::string &	name,
		simcore::ConditionsInterface &	ci,
		const framework::config::Parameters &	params )

Constructor.

Parameters

name	The name of the sensitive detector.
ci	Conditions interface handle
params	python configuration parameters

Definition at line 22 of file ScoringPlaneSD.cxx.

    : SensitiveDetector(name, ci, params) {
  collection_name_ = params.get<std::string>("collection_name");
  match_substr_ = params.get<std::string>("match_substr");
}

References collection_name_, framework::config::Parameters::get(), and match_substr_.

Member Function Documentation

isSensDet()

bool simcore::ScoringPlaneSD::isSensDet ( G4LogicalVolume * volume ) const

inlineoverridevirtual

Check if the input logical volume is a scoring plane we should include.

Implements simcore::SensitiveDetector.

Definition at line 31 of file ScoringPlaneSD.h.

                                                         {
    return volume->GetName().contains(match_substr_);
  }

References match_substr_.

onFinishedEvent()

virtual void simcore::ScoringPlaneSD::onFinishedEvent ( )

inlineoverridevirtual

Cleanup SD and prepare a new-event state.

Implements simcore::SensitiveDetector.

Definition at line 53 of file ScoringPlaneSD.h.

{ hits_.clear(); }

References hits_.

ProcessHits()

G4bool simcore::ScoringPlaneSD::ProcessHits ( G4Step * step, G4TouchableHistory * hist )

overridevirtual

This is Geant4's handle to tell us that a particle has stepped through our sensitive detector and we should process its interaction with us.

Parameters

[in]	step	the step that happened within one of our logical volumes
[in]	hist	the touchable history of the step

Implements simcore::SensitiveDetector.

Definition at line 30 of file ScoringPlaneSD.cxx.

                                                                            {
  // Get the edep from the step.
  G4double edep = step->GetTotalEnergyDeposit();
 
  // Create a new hit object.
  ldmx::SimTrackerHit& hit{hits_.emplace_back()};
 
  // Assign track ID for finding the SimParticle in post event processing.
  hit.setTrackID(step->GetTrack()->GetTrackID());
  hit.setPdgID(step->GetTrack()->GetDynamicParticle()->GetPDGcode());
 
  // Set the edep.
  hit.setEdep(edep);
 
  // Set the start position.
  G4StepPoint* pre_point = step->GetPreStepPoint();
 
  // Set the end position.
  G4StepPoint* post_point = step->GetPostStepPoint();
 
  G4ThreeVector start = pre_point->GetPosition();
  G4ThreeVector end = post_point->GetPosition();
 
  // Set the mid position.
  G4ThreeVector mid = 0.5 * (start + end);
  hit.setPosition(mid.x(), mid.y(), mid.z());
 
  // Compute path length.
  G4double path_length =
      sqrt(pow(start.x() - end.x(), 2) + pow(start.y() - end.y(), 2) +
           pow(start.z() - end.z(), 2));
  hit.setPathLength(path_length);
 
  // Set the global time.
  hit.setTime(step->GetTrack()->GetGlobalTime());
 
  // Set the momentum
  G4ThreeVector p = post_point->GetMomentum();
  hit.setMomentum(p.x(), p.y(), p.z());
  hit.setEnergy(post_point->GetTotalEnergy());
 
  /*
   * Set the 32-bit ID on the hit.
   */
  int cp_number = pre_point->GetTouchableHandle()->GetCopyNumber();
  ldmx::SimSpecialID id = ldmx::SimSpecialID::scoringPlaneId(cp_number);
  hit.setID(id.raw());
 
  return true;
}

References hits_, ldmx::SimSpecialID::scoringPlaneId(), and ldmx::SimTrackerHit::setTrackID().

saveHits()

void simcore::ScoringPlaneSD::saveHits ( framework::Event & event )

overridevirtual

We are given the event bus here and we must decide now what to persist into the event.

Parameters

[in,out]

event

event bus to add thing(s) to

Implements simcore::SensitiveDetector.

Definition at line 81 of file ScoringPlaneSD.cxx.

                                                   {
  event.add(collection_name_, hits_);
}

References collection_name_, and hits_.

Member Data Documentation

collection_name_

std::string simcore::ScoringPlaneSD::collection_name_

private

Name of output collection to add.

Definition at line 60 of file ScoringPlaneSD.h.

Referenced by saveHits(), and ScoringPlaneSD().

hits_

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

private

The actual output collection.

Definition at line 63 of file ScoringPlaneSD.h.

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

match_substr_

std::string simcore::ScoringPlaneSD::match_substr_

private

Substring to match to logical volumes.

Definition at line 57 of file ScoringPlaneSD.h.

Referenced by isSensDet(), and ScoringPlaneSD().

---

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

• SimCore/include/SimCore/SDs/ScoringPlaneSD.h
• SimCore/src/SimCore/SDs/ScoringPlaneSD.cxx