simcore::EcalSD Class Reference

ECal sensitive detector that uses an EcalHexReadout to create the hits_. More...

#include <EcalSD.h>

Public Member Functions
	EcalSD (const std::string &name, simcore::ConditionsInterface &ci, const framework::config::Parameters &p)
	Class constructor.
virtual	~EcalSD ()=default
	Class destructor.
virtual bool	isSensDet (G4LogicalVolume *vol) const override
	Should the input volume be consider apart of this sensitive detector?
G4bool	ProcessHits (G4Step *aStep, G4TouchableHistory *ROhist) override
	Process steps to create hits_.
virtual void	saveHits (framework::Event &event) override
	Add our hits to the event bus.
virtual void	onFinishedEvent () override
	Clear the map of hits we have accumulated.
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.

Static Public Attributes
static const std::string	COLLECTION_NAME = "EcalSimHits"
	Name of output collection of hits_.

Private Attributes
std::map< ldmx::EcalID, ldmx::SimCalorimeterHit >	hits_
	map of hits to add to the event (will be squashed)
bool	enable_hit_contribs_
	enable hit contribs
bool	compress_hit_contribs_
	compress hit contribs
int	max_origin_track_id_
	maximum track ID to be considered an "origin"

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

ECal sensitive detector that uses an EcalHexReadout to create the hits_.

Definition at line 37 of file EcalSD.h.

Constructor & Destructor Documentation

EcalSD()

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

Class constructor.

Parameters

name	The name of the sensitive detector.
theCollectionName	The name of the hits collection.
subDetID	The subdetector ID.

Definition at line 7 of file EcalSD.cxx.

    : SensitiveDetector(name, ci, p) {
  enable_hit_contribs_ = p.get<bool>("enableHitContribs");
  compress_hit_contribs_ = p.get<bool>("compressHitContribs");
  max_origin_track_id_ = p.get<int>("max_origin_track_id");
}

References compress_hit_contribs_, enable_hit_contribs_, framework::config::Parameters::get(), and max_origin_track_id_.

Member Function Documentation

isSensDet()

virtual bool simcore::EcalSD::isSensDet ( G4LogicalVolume * vol ) const

inlineoverridevirtual

Should the input volume be consider apart of this sensitive detector?

Note

Dependent on names defined in GDML!

Implements simcore::SensitiveDetector.

Definition at line 61 of file EcalSD.h.

                                                              {
    auto region = vol->GetRegion();
    if (region and region->GetName().contains("CalorimeterRegion")) {
      return vol->GetName().contains("Si");
    }
    return false;
  }

onFinishedEvent()

virtual void simcore::EcalSD::onFinishedEvent ( )

inlineoverridevirtual

Clear the map of hits we have accumulated.

Implements simcore::SensitiveDetector.

Definition at line 84 of file EcalSD.h.

{ hits_.clear(); }

References hits_.

ProcessHits()

G4bool simcore::EcalSD::ProcessHits ( G4Step * aStep, G4TouchableHistory * ROhist )

overridevirtual

Process steps to create hits_.

Parameters

aStep	The step information.
ROhist	The readout history.

DEBUG this printout is helpful when developing the GDML and/or EcalGeometry since Geant4 will probe where exactly the GDML sensitive volumes are std::cout << "(" << position[0] << ", " << position[1] << ", " << position[2] << ") " << cpynum << " -> layer " << layerNumber << " module " << module_position << std::endl;

Implements simcore::SensitiveDetector.

Definition at line 15 of file EcalSD.cxx.

                                                             {
  static const int layer_depth = 2;  // index depends on GDML implementation
  const auto& geometry = getCondition<ldmx::EcalGeometry>(
      ldmx::EcalGeometry::CONDITIONS_OBJECT_NAME);
 
  // 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)) {
    ldmx_log(trace) << "CalorimeterSD skipping step with zero edep.";
    return false;
  }
 
  // Compute the hit position
  G4StepPoint* pre_point = aStep->GetPreStepPoint();
  G4StepPoint* post_point = aStep->GetPostStepPoint();
  G4ThreeVector position =
      0.5 * (pre_point->GetPosition() + post_point->GetPosition());
 
  // Create the ID for the hit.
  int cpynum{0};  // Initialize cpynum to 0
 
  auto pre_step_point = aStep->GetPreStepPoint();
  if (pre_step_point) {
    const auto& touchable_handle = pre_step_point->GetTouchableHandle();
    if (touchable_handle) {
      auto history = touchable_handle->GetHistory();
      if (history) {
        auto volume = history->GetVolume(layer_depth);
        if (volume) {
          cpynum = volume->GetCopyNo();
        }
      }
    }
  }
  int layer_number;
  layer_number = cpynum / 7;
  int module_position = cpynum % 7;
  // fastest, but need to trust module number between GDML and EcalGeometry
  // match
  ldmx::EcalID id =
      geometry.getID(position.x(), position.y(), layer_number, module_position);
 
  // medium, only need to trust z-layer positions in GDML and EcalGeometry match
  //    helpful for debugging any issues where transverse position is not
  //    matching between the GDML and EcalGeometry
  // ldmx::EcalID id = geometry.getID(position[0], position[1], layerNumber);
 
  // slowest, completely rely on EcalGeometry
  //    this is helpful for validating the EcalGeometry implementation and
  //    configuration since this will be called with any hit position that
  //    is inside of the configured SD volumes from Geant4's point of view
  // ldmx::EcalID id = geometry.getID(position[0], position[1], position[2]);
 
  if (hits_.find(id) == hits_.end()) {
    // hit in empty cell
    auto& hit = hits_[id];
    hit.setID(id.raw());
    hit.setPosition(position.x(), position.y(), position.z());
  }
 
  auto& hit = hits_[id];
 
  // hit variables
  auto track = aStep->GetTrack();
  auto time = track->GetGlobalTime();
  auto track_id = track->GetTrackID();
  auto pdg = track->GetParticleDefinition()->GetPDGEncoding();
 
  if (enable_hit_contribs_) {
    int contrib_i = hit.findContribIndex(track_id, pdg);
    if (compress_hit_contribs_ and contrib_i != -1) {
      hit.updateContrib(contrib_i, edep, time);
    } else {
      auto map{getTrackMap()};
      auto incident{map.findIncident(track_id)};
      // default "origin" is just the same as incident
      // "origin" checks if a hit "originates" from one of the earliest
      // track IDs (i.e. probably one of the primaries)
      int origin{incident};
      for (int i{1}; i < max_origin_track_id_; ++i) {
        if (map.isDescendant(track_id, i, 100)) {
          origin = i;
          break;
        }
      }
      hit.addContrib(incident, track_id, pdg, edep, time, origin);
    }
  } else {
    // no hit contribs and hit already exists
    hit.setEdep(hit.getEdep() + edep);
    if (time < hit.getTime() or hit.getTime() == 0) {
      hit.setTime(time);
    }
  }
 
  return true;
}

References compress_hit_contribs_, enable_hit_contribs_, simcore::SensitiveDetector::getCondition(), simcore::SensitiveDetector::getTrackMap(), hits_, simcore::SensitiveDetector::isGeantino(), and max_origin_track_id_.

saveHits()

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

overridevirtual

Add our hits to the event bus.

Implements simcore::SensitiveDetector.

Definition at line 126 of file EcalSD.cxx.

                                           {
  // squash hits into list
  std::vector<ldmx::SimCalorimeterHit> hits;
  hits.reserve(hits_.size());
  for (const auto& [id, hit] : hits_) hits.push_back(hit);
  event.add(COLLECTION_NAME, hits);
}

References COLLECTION_NAME, and hits_.

Member Data Documentation

COLLECTION_NAME

const std::string simcore::EcalSD::COLLECTION_NAME = "EcalSimHits"

static

Name of output collection of hits_.

Definition at line 40 of file EcalSD.h.

Referenced by saveHits().

compress_hit_contribs_

bool simcore::EcalSD::compress_hit_contribs_

private

compress hit contribs

Definition at line 92 of file EcalSD.h.

Referenced by EcalSD(), and ProcessHits().

enable_hit_contribs_

bool simcore::EcalSD::enable_hit_contribs_

private

enable hit contribs

Definition at line 90 of file EcalSD.h.

Referenced by EcalSD(), and ProcessHits().

hits_

std::map<ldmx::EcalID, ldmx::SimCalorimeterHit> simcore::EcalSD::hits_

private

map of hits to add to the event (will be squashed)

Definition at line 88 of file EcalSD.h.

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

max_origin_track_id_

int simcore::EcalSD::max_origin_track_id_

private

maximum track ID to be considered an "origin"

Definition at line 94 of file EcalSD.h.

Referenced by EcalSD(), and ProcessHits().

---

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

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