g4b::PrimaryParticleInformation Class Reference

#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.

References GetMCTruth(), IsInMCTruth(), and MCParticleIndex().

Referenced by larg4::ParticleListActionService::preUserTrackingAction().

  {
    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.

Referenced by GetMCParticle().

{ return fMCTruth; }

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.

References simb::NoGeneratedParticleIndex.

Referenced by GetMCParticle().

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

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.

References simb::NoGeneratedParticleIndex, and pyG4Element::Print().

Referenced by GetMCParticle(), larg4::ParticleListAction::PreTrackingAction(), and larg4::ParticleListActionService::preUserTrackingAction().

      { return fMCParticleIndex; }

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

inline

Definition at line 69 of file PrimaryParticleInformation.h.

Referenced by larg4::ParticleListActionService::preUserTrackingAction().

{ return fMCTIndex; }

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.

References fMCTruth.

  {
    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.

Referenced by larg4::MCTruthEventActionService::generatePrimaries(), and g4b::ConvertMCTruthToG4::GeneratePrimaries().

  { 
    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.

Referenced by Print().

---

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

• nug4/G4Base/PrimaryParticleInformation.h
• nug4/G4Base/PrimaryParticleInformation.cxx