sim::GeneratedParticleInfo Class Reference

Contains information about a generated particle. More...

#include <GeneratedParticleInfo.h>

Public Member Functions
	GeneratedParticleInfo ()=default
	Default constructor (for ROOT I/O only). More...
	GeneratedParticleInfo (GeneratedParticleIndex_t index)
	Constructor: assigns all the values. More...

Private Attributes
GeneratedParticleIndex_t	fGeneratedParticleIndex = NoGeneratedParticleIndex
	Index of the generated particle in its simb::MCTruth record. More...

Generated particle index
using	GeneratedParticleIndex_t = simb::GeneratedParticleIndex_t
	Type of particle index in the generator truth record (simb::MCTruth). More...
static constexpr GeneratedParticleIndex_t	NoGeneratedParticleIndex = simb::NoGeneratedParticleIndex
	Constant representing the absence of generator truth information. More...
GeneratedParticleIndex_t	generatedParticleIndex () const
	Returns the generated particle index. More...
bool	hasGeneratedParticleIndex () const
	Returns whether the specified one is an acceptable generator index. More...

Detailed Description

Contains information about a generated particle.

This information is designed to be added as metadata to an association between a simb::MCParticle produced by the simulation of particle propagation through the detector (e.g. LArG4) with the generator truth record that particle derives from:

art::Assns<simb::MCParticle, simb::MCTruth, sim::GeneratedParticleInfo>

The associated simb::MCParticle is expected to be the generated particle of the generator truth record, as processed by the simulation. The provided information is currently:

• index of the generated particle within the generator record; the particle itself can be obtained as:

  mctruthPtr->GetParticle(genParticleInfo.generatedParticleIndex());

Definition at line 39 of file GeneratedParticleInfo.h.

Member Typedef Documentation

using sim::GeneratedParticleInfo::GeneratedParticleIndex_t = simb::GeneratedParticleIndex_t

Type of particle index in the generator truth record (simb::MCTruth).

Definition at line 48 of file GeneratedParticleInfo.h.

Constructor & Destructor Documentation

sim::GeneratedParticleInfo::GeneratedParticleInfo ( )

default

Default constructor (for ROOT I/O only).

sim::GeneratedParticleInfo::GeneratedParticleInfo ( GeneratedParticleIndex_t  index )

inline

Constructor: assigns all the values.

Parameters

index

generated particle index (NoGeneratedParticleIndex if none)

Definition at line 77 of file GeneratedParticleInfo.h.

      : fGeneratedParticleIndex(index)
      {}

Member Function Documentation

GeneratedParticleIndex_t sim::GeneratedParticleInfo::generatedParticleIndex ( ) const

inline

Returns the generated particle index.

Returns

generated particle index (NoGeneratedParticleIndex if none)

Definition at line 58 of file GeneratedParticleInfo.h.

      { return fGeneratedParticleIndex; }

bool sim::GeneratedParticleInfo::hasGeneratedParticleIndex ( ) const

inline

Returns whether the specified one is an acceptable generator index.

Definition at line 62 of file GeneratedParticleInfo.h.

      { return simb::isGeneratedParticleIndex(fGeneratedParticleIndex); }

Member Data Documentation

GeneratedParticleIndex_t sim::GeneratedParticleInfo::fGeneratedParticleIndex = NoGeneratedParticleIndex

private

Index of the generated particle in its simb::MCTruth record.

Definition at line 86 of file GeneratedParticleInfo.h.

constexpr GeneratedParticleIndex_t sim::GeneratedParticleInfo::NoGeneratedParticleIndex = simb::NoGeneratedParticleIndex

static

Constant representing the absence of generator truth information.

Definition at line 52 of file GeneratedParticleInfo.h.

---

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

• GeneratedParticleInfo.h