#include <PrimaryParticleInformation.h>

Inheritance diagram for g4b::PrimaryParticleInformation:

Public Types
using	GeneratedParticleIndex_t = simb::GeneratedParticleIndex_t
	Type of the stored index of particle within the truth record. More...

Public Member Functions
void *	operator new (size_t)

void	operator delete (void *)

const simb::MCTruth *	GetMCTruth () const

size_t const &	MCTruthIndex () const

GeneratedParticleIndex_t	MCParticleIndex () const
	Returns the index of the corresponding particle in truth record. More...

simb::MCParticle const *	GetMCParticle () const

bool	IsInMCTruth () const

void	SetMCTruth (const simb::MCTruth *m, size_t idx=0, GeneratedParticleIndex_t indexInTruth=simb::NoGeneratedParticleIndex)

virtual void	Print () const override

Private Attributes
const simb::MCTruth *	fMCTruth = nullptr

size_t	fMCTIndex = 0

GeneratedParticleIndex_t	fMCParticleIndex = simb::NoGeneratedParticleIndex
	Index within the truth record. More...

Detailed Description

Definition at line 57 of file PrimaryParticleInformation.h.

Member Typedef Documentation

using g4b::PrimaryParticleInformation::GeneratedParticleIndex_t = simb::GeneratedParticleIndex_t

Type of the stored index of particle within the truth record.

Definition at line 62 of file PrimaryParticleInformation.h.

Member Function Documentation

simb::MCParticle const * g4b::PrimaryParticleInformation::GetMCParticle ( ) const

Returns the original particle in the truth record.

Returns: pointer to the original particle, or nullptr if not available

See also: MCParticleIndex(), GetMCTruth()

Definition at line 16 of file PrimaryParticleInformation.cxx.

   {
     if (!IsInMCTruth()) return nullptr;
     auto const* truth = GetMCTruth();
     if (!truth) return nullptr;
     auto const index = MCParticleIndex();
     if (index >= (std::size_t) truth->NParticles()) return nullptr; // or should we throw?
     return &(truth->GetParticle(index));
   } // PrimaryParticleInformation::GetMCParticle()

const simb::MCTruth* g4b::PrimaryParticleInformation::GetMCTruth ( ) const

inline

Definition at line 68 of file PrimaryParticleInformation.h.

68 { return fMCTruth; }

g4b::PrimaryParticleInformation::fMCTruth

const simb::MCTruth * fMCTruth

Definition: PrimaryParticleInformation.h:111

bool g4b::PrimaryParticleInformation::IsInMCTruth ( ) const

inline

Returns whether this particle has a corresponding truth record item.

See also: MCParticleIndex(), GetMCTruth()

Definition at line 123 of file PrimaryParticleInformation.h.

124 { return MCParticleIndex() != simb::NoGeneratedParticleIndex; }

simb::NoGeneratedParticleIndex

constexpr GeneratedParticleIndex_t NoGeneratedParticleIndex

Constant representing the absence of generator truth information.

Definition: simb.h:34

g4b::PrimaryParticleInformation::MCParticleIndex

GeneratedParticleIndex_t MCParticleIndex() const

Returns the index of the corresponding particle in truth record.

Definition: PrimaryParticleInformation.h:82

GeneratedParticleIndex_t g4b::PrimaryParticleInformation::MCParticleIndex ( ) const

inline

Returns the index of the corresponding particle in truth record.

Returns: an index within truth record, NotInMCTruth otherwise

See also: IsInMCTruth(), GetMCTruth()

This method returns the index in the truth record pointed by GetMCTruth() of the particle (simb::MCParticle) corresponding to this object. If this information is not set, or if there is no such a particle at all, the special value NotInMCTruth is returned. This can be checked with the IsInMCTruth() method. T

Definition at line 82 of file PrimaryParticleInformation.h.

83 { return fMCParticleIndex; }

g4b::PrimaryParticleInformation::fMCParticleIndex

GeneratedParticleIndex_t fMCParticleIndex

Index within the truth record.

Definition: PrimaryParticleInformation.h:114

size_t const& g4b::PrimaryParticleInformation::MCTruthIndex ( ) const

inline

Definition at line 69 of file PrimaryParticleInformation.h.

69 { return fMCTIndex; }

g4b::PrimaryParticleInformation::fMCTIndex

size_t fMCTIndex

Definition: PrimaryParticleInformation.h:112

void g4b::PrimaryParticleInformation::operator delete ( void * aPrimaryParticleInformation )

inline

Definition at line 145 of file PrimaryParticleInformation.h.

   {
     PrimaryParticleInformationAllocator.FreeSingle((PrimaryParticleInformation*) aPrimaryParticleInformation);
   }

void * g4b::PrimaryParticleInformation::operator new ( size_t )

inline

Definition at line 138 of file PrimaryParticleInformation.h.

   {
     void *aPrimaryParticleInformation;
     aPrimaryParticleInformation = (void *) PrimaryParticleInformationAllocator.MallocSingle();
     return aPrimaryParticleInformation;
   }

void g4b::PrimaryParticleInformation::Print ( ) const

overridevirtual

Definition at line 28 of file PrimaryParticleInformation.cxx.

   {
     if ( fMCTruth )
       std::cout << *fMCTruth;
   }

void g4b::PrimaryParticleInformation::SetMCTruth	(	const simb::MCTruth *	m,
		size_t	idx = `0`,
		GeneratedParticleIndex_t	indexInTruth = `simb::NoGeneratedParticleIndex`
	)

inline

Definition at line 127 of file PrimaryParticleInformation.h.

   { 
     fMCTruth = m;
     fMCTIndex = idx;
     fMCParticleIndex = indexInTruth;
   }

Member Data Documentation

GeneratedParticleIndex_t g4b::PrimaryParticleInformation::fMCParticleIndex = simb::NoGeneratedParticleIndex

private

Index within the truth record.

Definition at line 114 of file PrimaryParticleInformation.h.

size_t g4b::PrimaryParticleInformation::fMCTIndex = 0

private

Definition at line 112 of file PrimaryParticleInformation.h.

const simb::MCTruth* g4b::PrimaryParticleInformation::fMCTruth = nullptr

private

Definition at line 111 of file PrimaryParticleInformation.h.

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

nutools/old/G4Base/PrimaryParticleInformation.h
nutools/old/G4Base/PrimaryParticleInformation.cxx

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation