Copy particles from a particular scoring plane in as primaries of a new simulation. More...

#include <FromScoringPlane.h>

Public Member Functions
	FromScoringPlane (const std::string &name, const framework::config::Parameters &parameters)
	Class constructor.

virtual	~FromScoringPlane ()=default
	Class destructor.

void	prepEvent (const framework::Event &event) override
	Retrieve the collection of scoring plane hits and copy the selected hits into our copies of primary particles.

void	GeneratePrimaryVertex (G4Event *anEvent) override
	Generate vertices in the Geant4 event.

void	RecordConfig (const std::string &id, ldmx::RunHeader &rh) override
	Record configuration information.

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

	DECLARE_FACTORY_WITH_WAREHOUSE (PrimaryGenerator, std::shared_ptr< PrimaryGenerator >, const std::string &, const framework::config::Parameters &)

virtual	~PrimaryGenerator ()=default
	Destructor.

std::string	name ()

void	smearBeamspot (G4PrimaryVertex *primary_vertex)
	Apply beam spot smearing to a primary vertex.

bool	useBeamspot () const
	Check if beam spot smearing is enabled for this generator.

Private Attributes
std::string	coll_name_
	name of scoring plane collection we should use

std::string	pass_name_
	name of pass for scoring plane collection we should use

std::vector< int >	select_planes_
	list of plane ID numbers to select for (use all hits if empty)

std::vector< G4PrimaryVertex * >	primary_vertices_
	list of primary vertices we will give over to the G4Event

Additional Inherited Members
Protected Attributes inherited from simcore::PrimaryGenerator
std::string	name_ {""}
	Name of the PrimaryGenerator.

bool	use_beamspot_ {false}
	Flag denoting whether beam spot smearing is enabled for this generator.

double	beamspot_x_size_ {0}
	Extent of the beamspot in x [mm].

double	beamspot_y_size_ {0}
	Extent of the beamspot in y [mm].

double	beamspot_z_size_ {0}
	Extent of the beamspot in z [mm].

Detailed Description

Copy particles from a particular scoring plane in as primaries of a new simulation.

Definition at line 28 of file FromScoringPlane.h.

Constructor & Destructor Documentation

◆ FromScoringPlane()

simcore::generators::FromScoringPlane::FromScoringPlane	(	const std::string &	name,
		const framework::config::Parameters &	parameters )

Class constructor.

Parameters

name	The name of the generator.
parameters	Configuration parameters.

Definition at line 13 of file FromScoringPlane.cxx.

    : PrimaryGenerator(name, parameters),
      coll_name_{parameters.get<std::string>("coll_name")},
      pass_name_{parameters.get<std::string>("pass_name")},
      select_planes_{parameters.get<std::vector<int>>("select_planes")} {}

Member Function Documentation

◆ GeneratePrimaryVertex()

void simcore::generators::FromScoringPlane::GeneratePrimaryVertex ( G4Event * anEvent )

overridevirtual

Generate vertices in the Geant4 event.

Parameters

anEvent The Geant4 event.

Implements simcore::PrimaryGenerator.

Definition at line 78 of file FromScoringPlane.cxx.

                                                             {
  ldmx_log(debug) << "generating primary vertex";
  for (auto* primary_vertex : primary_vertices_) {
    anEvent->AddPrimaryVertex(primary_vertex);
  }
}

References primary_vertices_.

◆ prepEvent()

void simcore::generators::FromScoringPlane::prepEvent ( const framework::Event & event )

overridevirtual

Retrieve the collection of scoring plane hits and copy the selected hits into our copies of primary particles.

The particles are copied into the G4Event in GeneratePrimaryVertex

Exceptions

framework::Exception if the requested scoring plane hits are not available, most often because the input file containing them was not requested

Parameters

[in] event framework::Event containing necessary scoring plane hits

Reimplemented from simcore::PrimaryGenerator.

Definition at line 20 of file FromScoringPlane.cxx.

                                                            {
  ldmx_log(debug) << "preparing event";
  const auto& scoring_plane_hits{
      event.getCollection<ldmx::SimTrackerHit>(coll_name_, pass_name_)};
  std::unordered_map<int, std::vector<const ldmx::SimTrackerHit*>>
      hits_by_track_id;
  for (const auto& hit : scoring_plane_hits) {
    ldmx::SimSpecialID id(hit.getID());
    bool keep{select_planes_.empty() or
              std::find(select_planes_.begin(), select_planes_.end(),
                        id.plane()) != select_planes_.end()};
    // do filtering by layer here
    ldmx_log(trace) << "hit with plane = " << id.plane() << " is "
                    << (keep ? "used" : "ignored");
    if (keep) {
      // sort hits that we are keeping by track ID
      hits_by_track_id[hit.getTrackID()].push_back(&hit);
    }
  }
 
  // copy earliest hit by track Id in as primary
  primary_vertices_.clear();
  for (auto& [track_id, hits] : hits_by_track_id) {
    auto earliest_hit_it = std::min_element(
        hits.begin(), hits.end(), [](const auto& hit_lhs, const auto& hit_rhs) {
          return hit_lhs->getTime() < hit_rhs->getTime();
        });
    const auto* earliest_hit = (*earliest_hit_it);
 
    G4PrimaryParticle* particle = new G4PrimaryParticle;
    // proper PDG also copies in mass and charge
    particle->SetPDGcode(earliest_hit->getPdgID());
 
    auto momentum{earliest_hit->getMomentum()};
    auto energy{earliest_hit->getEnergy()};
    particle->Set4Momentum(momentum[0], momentum[1], momentum[2], energy);
    // probably not correct from a relativistic perspective
    particle->SetProperTime(earliest_hit->getTime());
    // label this particle as a primary for purposes of serialization
    UserPrimaryParticleInformation* uppi = new UserPrimaryParticleInformation;
    uppi->setHepEvtStatus(1);
    particle->SetUserInformation(uppi);
    // NOT copying over the TrackID into the primary because
    // (as of Geant4.10.2.3) the track IDs of particles created
    // in this simulation do not start at the primary's number and
    // count up which is what I would want to make this understandable
    // particle->SetTrackID(track_id);
 
    auto pos{earliest_hit->getPosition()};
    G4PrimaryVertex* vertex = new G4PrimaryVertex;
    vertex->SetPosition(pos[0], pos[1], pos[2]);
    // not setting a weight
    vertex->SetPrimary(particle);
 
    primary_vertices_.push_back(vertex);
  }
}

References coll_name_, pass_name_, primary_vertices_, select_planes_, and simcore::UserPrimaryParticleInformation::setHepEvtStatus().

◆ RecordConfig()

void simcore::generators::FromScoringPlane::RecordConfig	(	const std::string &	id,
		ldmx::RunHeader &	rh )

overridevirtual

Record configuration information.

Parameters

id	The configuration ID.
rh	The run header.

Implements simcore::PrimaryGenerator.

Definition at line 85 of file FromScoringPlane.cxx.

                                                       {
  rh.setStringParameter(id + " Class", "simcore::generators::FromScoringPlane");
  rh.setStringParameter(id + " Coll Name", coll_name_);
  rh.setStringParameter(id + " Pass Name", pass_name_);
}

References coll_name_, pass_name_, and ldmx::RunHeader::setStringParameter().

Member Data Documentation

◆ coll_name_

std::string simcore::generators::FromScoringPlane::coll_name_

private

name of scoring plane collection we should use

Definition at line 71 of file FromScoringPlane.h.

Referenced by prepEvent(), and RecordConfig().

◆ pass_name_

std::string simcore::generators::FromScoringPlane::pass_name_

private

name of pass for scoring plane collection we should use

Definition at line 73 of file FromScoringPlane.h.

Referenced by prepEvent(), and RecordConfig().

◆ primary_vertices_

std::vector<G4PrimaryVertex*> simcore::generators::FromScoringPlane::primary_vertices_

private

list of primary vertices we will give over to the G4Event

Definition at line 77 of file FromScoringPlane.h.

Referenced by GeneratePrimaryVertex(), and prepEvent().

◆ select_planes_

std::vector<int> simcore::generators::FromScoringPlane::select_planes_

private

list of plane ID numbers to select for (use all hits if empty)

Definition at line 75 of file FromScoringPlane.h.

Referenced by prepEvent().

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

SimCore/include/SimCore/Generators/FromScoringPlane.h
SimCore/src/SimCore/Generators/FromScoringPlane.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FromScoringPlane()

Member Function Documentation

◆ GeneratePrimaryVertex()

◆ prepEvent()

◆ RecordConfig()

Member Data Documentation

◆ coll_name_

◆ pass_name_

◆ primary_vertices_

◆ select_planes_