simb::MCTruth Class Reference

Event generator information. More...

#include "MCTruth.h"

Public Member Functions
	MCTruth ()
const simb::MCGeneratorInfo &	GeneratorInfo () const
simb::Origin_t	Origin () const
int	NParticles () const
const simb::MCParticle &	GetParticle (int i) const
const simb::MCNeutrino &	GetNeutrino () const
bool	NeutrinoSet () const
void	Add (simb::MCParticle const &part)
void	Add (simb::MCParticle &&part)
void	SetGeneratorInfo (simb::Generator_t generator, const std::string &genVersion, const std::unordered_map< std::string, std::string > &genConfig)
void	SetOrigin (simb::Origin_t origin)
void	SetNeutrino (int CCNC, int mode, int interactionType, int target, int nucleon, int quark, double w, double x, double y, double qsqr)

Private Attributes
std::vector< simb::MCParticle >	fPartList
	list of particles in this event More...
simb::MCNeutrino	fMCNeutrino
	reference to neutrino info - null if not a neutrino More...
simb::Origin_t	fOrigin
	origin for this event More...
simb::MCGeneratorInfo	fGenInfo
	information about the generator that produced this event More...
bool	fNeutrinoSet
	flag for whether the neutrino information has been set More...

Friends
std::ostream &	operator<< (std::ostream &o, simb::MCTruth const &a)

Detailed Description

Event generator information.

Definition at line 32 of file MCTruth.h.

Constructor & Destructor Documentation

simb::MCTruth::MCTruth

(

)

Definition at line 21 of file MCTruth.cxx.

    : fPartList()
    , fMCNeutrino()
    , fOrigin(simb::kUnknown)
    , fNeutrinoSet(false)
  { 
  }

Member Function Documentation

void simb::MCTruth::Add ( simb::MCParticle const &  part )

inline

Definition at line 80 of file MCTruth.h.

References fPartList.

Referenced by evgen::MARLEYHelper::add_marley_particles(), evgb::FillMCTruth(), simfilter::FilterGenInTime::filter(), evgen::CORSIKAGen::GetSample(), evgen::NueAr40CCGenerator::ProcessOneNeutrino(), evgen::CosmicsGen::produce(), evgen::NDKGen::produce(), evgen::NucleonDecay::produce(), evgen::NeutronOsc::produce(), evgen::CORSIKAGen::produce(), evgen::SpectrumVolumeGen::produce_radio(), evgen::Decay0Gen::produce_radio(), evgen::FileMuons::ReadEvents(), fluxr::PPFXFluxReader::readNext(), evgen::TextFileGen::readNextHepEvt(), evgb::CRYHelper::Sample(), evgen::PhotonGen::Sample(), evgen::LightSource::Sample(), evgen::larg4SingleGen::SampleMany(), evgen::SingleGen::SampleMany(), evgen::GaisserParam::SampleOne(), evgen::larg4SingleGen::SampleOne(), evgen::SingleGen::SampleOne(), evgen::MUSUN::SampleOne(), and evgen::RadioGen::SampleOne().

{ fPartList.push_back(part); }

void simb::MCTruth::Add ( simb::MCParticle &&  part )

inline

Definition at line 81 of file MCTruth.h.

References fPartList, and part.

{ fPartList.push_back(std::move(part)); }

const simb::MCGeneratorInfo & simb::MCTruth::GeneratorInfo ( ) const

inline

Definition at line 73 of file MCTruth.h.

References fGenInfo.

Referenced by sim::dump::DumpMCTruth().

{ return fGenInfo;              }

const simb::MCNeutrino & simb::MCTruth::GetNeutrino ( ) const

inline

Definition at line 77 of file MCTruth.h.

References fMCNeutrino.

Referenced by shower::TCShowerAnalysis::analyze(), lar_pandora::PFParticleMonitoring::analyze(), shower::TCShowerElectronLikelihood::analyze(), shower::TCShowerTemplateMaker::analyze(), pfpf::PFPAna::analyze(), cluster::ClusterAna::analyze(), rwgt::ReweightAna::analyze(), NuShowerEff::analyze(), lcvn::LArNuCVNZlibMaker::analyze(), lar_pandora::LArPandoraInput::CreatePandoraMCParticles(), sim::dump::DumpMCTruth(), evgen::NDKGen::FillHistograms(), evgen::GENIEGen::FillHistograms(), lar_pandora::LArPandoraSliceIdHelper::GetBeamNeutrinoMCTruth(), lcvn::AssignLabels::GetTopology(), simb::operator<<(), print_weights(), DUNE::NeutrinoShowerEff::processEff(), DUNE::NeutrinoTrackingEff::processEff(), wc::CellTree::processMC(), evgen::GENIEGen::produce(), evgb::RetrieveGHEP(), and evgb::GENIEHelper::Sample().

{ return fMCNeutrino;           }

const simb::MCParticle & simb::MCTruth::GetParticle ( int  i ) const

inline

Definition at line 76 of file MCTruth.h.

References fPartList.

Referenced by cluster::DBclusterAna::analyze(), lar_pandora::LArPandoraHelper::CollectGeneratorMCParticles(), sim::dump::DumpMCTruth(), evgen::NDKGen::FillHistograms(), evgen::GENIEGen::FillHistograms(), filt::FinalStateParticleFilter::filter(), simfilter::FilterGenInTime::filter(), larg4::MCTruthEventActionService::generatePrimaries(), lcvn::AssignLabels::GetTopology(), simb::operator<<(), evgen::CosmicsGen::produce(), trkf::Track3DKalman::produce(), trkf::Track3DKalmanSPS::produce(), evgen::CORSIKAGen::produce(), and evgb::RetrieveGHEP().

{ return fPartList[i];          }

bool simb::MCTruth::NeutrinoSet ( ) const

inline

Definition at line 78 of file MCTruth.h.

References fNeutrinoSet.

Referenced by shower::TCShowerAnalysis::analyze(), lar_pandora::PFParticleMonitoring::analyze(), shower::TCShowerElectronLikelihood::analyze(), shower::TCShowerTemplateMaker::analyze(), NuShowerEff::analyze(), lar_pandora::LArPandoraInput::CreatePandoraMCParticles(), sim::dump::DumpMCTruth(), lar_pandora::PFParticleCosmicAna::FillTrueTree(), lar_pandora::PFParticleValidation::GetMCTruth(), DUNE::NeutrinoShowerEff::processEff(), DUNE::NeutrinoTrackingEff::processEff(), wc::CellTree::processMC(), and evgen::GENIEGen::produce().

{ return fNeutrinoSet;          }

int simb::MCTruth::NParticles ( ) const

inline

Definition at line 75 of file MCTruth.h.

References fPartList.

Referenced by evgen::MARLEYHelper::add_marley_particles(), cluster::DBclusterAna::analyze(), lar_pandora::LArPandoraHelper::CollectGeneratorMCParticles(), sim::dump::DumpMCTruth(), larg4::ParticleListActionService::endOfEventAction(), evgen::NDKGen::FillHistograms(), evgen::GENIEGen::FillHistograms(), filt::FinalStateParticleFilter::filter(), simfilter::FilterGenInTime::filter(), evgen::NueAr40CCGenerator::Generate(), larg4::MCTruthEventActionService::generatePrimaries(), lcvn::AssignLabels::GetTopology(), simb::operator<<(), wc::CellTree::processMC(), evgen::NueAr40CCGenerator::ProcessOneNeutrino(), evgen::CosmicsGen::produce(), evgen::NDKGen::produce(), trkf::Track3DKalman::produce(), trkf::Track3DKalmanSPS::produce(), evgen::CORSIKAGen::produce(), evgb::RetrieveGHEP(), and evgen::LightSource::Sample().

{ return (int)fPartList.size(); }

simb::Origin_t simb::MCTruth::Origin ( ) const

inline

Definition at line 74 of file MCTruth.h.

References fOrigin.

Referenced by pfpf::PFPAna::analyze(), cluster::ClusterAna::analyze(), cluster::ClusterTrackAna::analyze(), lar_pandora::LArPandoraInput::CreatePandoraMCParticles(), sim::dump::DumpMCTruth(), lar_pandora::LArPandoraSliceIdHelper::GetBeamNeutrinoMCTruth(), tca::GetOrigin(), lar_pandora::PFParticleValidation::IsNeutrinoInduced(), evd::SimulationDrawer::MCTruthVectors2D(), simb::operator<<(), wc::CellTree::processMC(), MCReco::produce(), and larg4::LArG4::produce().

{ return fOrigin;               }

void simb::MCTruth::SetGeneratorInfo ( simb::Generator_t  generator, const std::string &  genVersion, const std::unordered_map< std::string, std::string > &  genConfig  )

inline

Definition at line 84 of file MCTruth.h.

References fGenInfo.

Referenced by evgb::FillMCTruth().

{
  fGenInfo = simb::MCGeneratorInfo(generator, genVersion, genConfig);
}

void simb::MCTruth::SetNeutrino	(	int	CCNC,
		int	mode,
		int	interactionType,
		int	target,
		int	nucleon,
		int	quark,
		double	w,
		double	x,
		double	y,
		double	qsqr
	)

Definition at line 30 of file MCTruth.cxx.

References util::abs(), fMCNeutrino, fNeutrinoSet, fPartList, art::errors::LogicError, simb::MCParticle::PdgCode(), and simb::MCParticle::TrackId().

Referenced by evgen::MARLEYHelper::create_MCTruth(), evgb::FillMCTruth(), evgen::NueAr40CCGenerator::ProcessOneNeutrino(), and fluxr::PPFXFluxReader::readNext().

  {
    if( !fNeutrinoSet ){
      fNeutrinoSet = true;
      // loop over the MCParticle list and get the outgoing lepton
      // assume this is a neutral current interaction to begin with
      // which means the outgoing lepton is the incoming neutrino
      MCParticle nu  = fPartList[0];
      MCParticle lep = fPartList[0];

      // start at i = 1 because i = 0 is the incoming neutrino
      for(unsigned int i = 1; i < fPartList.size(); ++i){
        if(fPartList[i].Mother() == nu.TrackId() &&
           (fPartList[i].PdgCode()  == nu.PdgCode() ||
            abs(fPartList[i].PdgCode()) == abs(nu.PdgCode())-1) ){
             lep = fPartList[i];
             break;
           }
      }//done looping over particles
    
      fMCNeutrino = simb::MCNeutrino(nu, lep, 
                                     CCNC, mode, interactionType,
                                     target, nucleon, quark,
                                     w, x, y, qsqr);
    } // end if MCNeutrino is not already set
    else
      throw art::Exception(art::errors::LogicError) <<  "MCTruth - attempt to set neutrino when already set";
    return;
  }

void simb::MCTruth::SetOrigin ( simb::Origin_t  origin )

inline

Definition at line 82 of file MCTruth.h.

References fOrigin, and geo::origin().

Referenced by evgen::MARLEYHelper::create_MCTruth(), evgb::FillMCTruth(), evgen::NueAr40CCGenerator::Generate(), evgen::CosmicsGen::produce(), evgen::FileMuons::produce(), evgen::PhotonGen::produce(), evgen::NDKGen::produce(), evgen::NucleonDecay::produce(), evgen::GaisserParam::produce(), evgen::NeutronOsc::produce(), evgen::larg4SingleGen::produce(), evgen::SingleGen::produce(), evgen::MUSUN::produce(), evgen::RadioGen::produce(), evgen::CORSIKAGen::produce(), evgen::SpectrumVolumeGen::produce_radio(), evgen::Decay0Gen::produce_radio(), evgb::CRYHelper::Sample(), and evgen::LightSource::Sample().

{ fOrigin = origin;             }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o, simb::MCTruth const &  a  )

friend

Definition at line 70 of file MCTruth.cxx.

  {
    if(a.Origin() == kCosmicRay) 
      o << "This is a cosmic ray event" << std::endl;
    else if(a.Origin() == kBeamNeutrino){
      o << "This is a beam neutrino event" << std::endl;
      o << a.GetNeutrino();
    }
    else if(a.Origin() == kSuperNovaNeutrino){ 
      o << "This is a supernova neutrino event" << std::endl;
      o << a.GetNeutrino();
    }  

    for (int i = 0; i < a.NParticles(); ++i)
      o << i << " " << a.GetParticle(i) << std::endl;

    return o;
  }

Member Data Documentation

simb::MCGeneratorInfo simb::MCTruth::fGenInfo

private

information about the generator that produced this event

Definition at line 41 of file MCTruth.h.

Referenced by GeneratorInfo(), and SetGeneratorInfo().

simb::MCNeutrino simb::MCTruth::fMCNeutrino

private

reference to neutrino info - null if not a neutrino

Definition at line 39 of file MCTruth.h.

Referenced by GetNeutrino(), and SetNeutrino().

bool simb::MCTruth::fNeutrinoSet

private

flag for whether the neutrino information has been set

Definition at line 42 of file MCTruth.h.

Referenced by NeutrinoSet(), and SetNeutrino().

simb::Origin_t simb::MCTruth::fOrigin

private

origin for this event

Definition at line 40 of file MCTruth.h.

Referenced by Origin(), and SetOrigin().

std::vector<simb::MCParticle> simb::MCTruth::fPartList

private

list of particles in this event

Definition at line 38 of file MCTruth.h.

Referenced by Add(), GetParticle(), NParticles(), and SetNeutrino().

---

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

• nusimdata/SimulationBase/MCTruth.h
• nusimdata/SimulationBase/MCTruth.cxx