MCParticleMonitoringAlgorithm class. More...

#include "MCParticleMonitoringAlgorithm.h"

Inheritance diagram for lar_content::MCParticleMonitoringAlgorithm:

Public Member Functions
	MCParticleMonitoringAlgorithm ()
	Default constructor. More...

Private Member Functions
pandora::StatusCode	Run ()

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

void	PrintPrimaryMCParticles (const LArMCParticleHelper::MCContributionMap &mcContributionMap) const
	Extract details of each mc primary in a given mc contribution map. More...

void	PrintMCParticle (const pandora::MCParticle *const pMCParticle, const LArMCParticleHelper::MCContributionMap &mcToTrueHitListMap, const int depth) const
	Print information for a given mc particle to screen. More...

Private Attributes
std::string	m_caloHitListName
	Name of input calo hit list. More...

std::string	m_mcParticleListName
	Name of input MC particle list. More...

bool	m_useTrueNeutrinosOnly
	Whether to consider only mc particles that were neutrino induced. More...

unsigned int	m_minHitsForDisplay
	Min hits associated with mc particle to warrant display to terminal. More...

Detailed Description

MCParticleMonitoringAlgorithm class.

Definition at line 21 of file MCParticleMonitoringAlgorithm.h.

Constructor & Destructor Documentation

lar_content::MCParticleMonitoringAlgorithm::MCParticleMonitoringAlgorithm ( )

Default constructor.

Definition at line 26 of file MCParticleMonitoringAlgorithm.cc.

                                                              :
     m_useTrueNeutrinosOnly(false),
     m_minHitsForDisplay(1)
 {
 }

Member Function Documentation

void lar_content::MCParticleMonitoringAlgorithm::PrintMCParticle	(	const pandora::MCParticle *const	pMCParticle,
		const LArMCParticleHelper::MCContributionMap &	mcToTrueHitListMap,
		const int	depth
	)		const

private

Print information for a given mc particle to screen.

Parameters

pMCParticle	the address of the mc particle
mcToTrueHitListMap	the mc to true hit list map
depth	the depth in the mc particle decay hierarchy

Definition at line 114 of file MCParticleMonitoringAlgorithm.cc.

References lar_content::LArMonitoringHelper::CountHitsByType(), and m_minHitsForDisplay.

Referenced by PrintPrimaryMCParticles().

 {
     const CaloHitList &caloHitList(mcToTrueHitListMap.count(pMCParticle) ? mcToTrueHitListMap.at(pMCParticle) : CaloHitList());
 
     if (caloHitList.size() >= m_minHitsForDisplay)
     {
         if (depth > 1)
         {
             for (int iDepth = 1; iDepth < depth - 1; ++iDepth) std::cout << "   ";
             std::cout << "\\_ ";
         }
 
         std::cout << "MCPDG " << pMCParticle->GetParticleId() << ", Energy " << pMCParticle->GetEnergy()
                   << ", Dist. " << (pMCParticle->GetEndpoint() - pMCParticle->GetVertex()).GetMagnitude() << ", nMCHits " << caloHitList.size()
                   << " (" << LArMonitoringHelper::CountHitsByType(TPC_VIEW_U, caloHitList)
                   << ", " << LArMonitoringHelper::CountHitsByType(TPC_VIEW_V, caloHitList)
                   << ", " << LArMonitoringHelper::CountHitsByType(TPC_VIEW_W, caloHitList) << ")" << std::endl;
     }
 
     for (const MCParticle *const pDaughterParticle : pMCParticle->GetDaughterList())
         this->PrintMCParticle(pDaughterParticle, mcToTrueHitListMap, depth + 1);
 }

void lar_content::MCParticleMonitoringAlgorithm::PrintPrimaryMCParticles ( const LArMCParticleHelper::MCContributionMap & mcContributionMap ) const

private

Extract details of each mc primary in a given mc contribution map.

Parameters

mcContributionMap the mc contribution map

Definition at line 82 of file MCParticleMonitoringAlgorithm.cc.

References lar_content::LArMonitoringHelper::CountHitsByType(), lar_content::LArMCParticleHelper::GetMCParticleToCaloHitMatches(), lar_content::LArMonitoringHelper::GetOrderedMCParticleVector(), m_minHitsForDisplay, and PrintMCParticle().

Referenced by Run().

 {
     MCParticleVector mcPrimaryVector;
     LArMonitoringHelper::GetOrderedMCParticleVector({mcContributionMap}, mcPrimaryVector);
 
     unsigned int index(0);
 
     for (const MCParticle *const pMCPrimary : mcPrimaryVector)
     {
         const CaloHitList &caloHitList(mcContributionMap.at(pMCPrimary));
 
         if (caloHitList.size() >= m_minHitsForDisplay)
         {
             std::cout << std::endl << "--Primary " << index << ", MCPDG " << pMCPrimary->GetParticleId() << ", Energy " << pMCPrimary->GetEnergy()
                       << ", Dist. " << (pMCPrimary->GetEndpoint() - pMCPrimary->GetVertex()).GetMagnitude() << ", nMCHits " << caloHitList.size()
                       << " (" << LArMonitoringHelper::CountHitsByType(TPC_VIEW_U, caloHitList)
                       << ", " << LArMonitoringHelper::CountHitsByType(TPC_VIEW_V, caloHitList)
                       << ", " << LArMonitoringHelper::CountHitsByType(TPC_VIEW_W, caloHitList) << ")" << std::endl;
 
             LArMCParticleHelper::MCRelationMap mcToPrimaryMCMap;
             LArMCParticleHelper::CaloHitToMCMap caloHitToPrimaryMCMap;
             LArMCParticleHelper::MCContributionMap mcToTrueHitListMap;
             LArMCParticleHelper::GetMCParticleToCaloHitMatches(&caloHitList, mcToPrimaryMCMap, caloHitToPrimaryMCMap, mcToTrueHitListMap);
             this->PrintMCParticle(pMCPrimary, mcToTrueHitListMap, 1);
         }
 
         ++index;
     }
 }

StatusCode lar_content::MCParticleMonitoringAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

private

Definition at line 140 of file MCParticleMonitoringAlgorithm.cc.

References m_caloHitListName, m_mcParticleListName, m_minHitsForDisplay, and m_useTrueNeutrinosOnly.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "CaloHitListName", m_caloHitListName));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MCParticleListName", m_mcParticleListName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "UseTrueNeutrinosOnly", m_useTrueNeutrinosOnly));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinHitsForDisplay", m_minHitsForDisplay));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::MCParticleMonitoringAlgorithm::Run ( )

private

Definition at line 34 of file MCParticleMonitoringAlgorithm.cc.

References lar_content::LArMCParticleHelper::IsBeamNeutrinoFinalState(), lar_content::LArMCParticleHelper::IsBeamParticle(), lar_content::LArMCParticleHelper::IsCosmicRay(), m_caloHitListName, m_mcParticleListName, lar_content::LArMCParticleHelper::PrimaryParameters::m_minHitSharingFraction, m_useTrueNeutrinosOnly, PrintPrimaryMCParticles(), and lar_content::LArMCParticleHelper::SelectReconstructableMCParticles().

 {
     std::cout << "---MC-PARTICLE-MONITORING-----------------------------------------------------------------------" << std::endl;
     const MCParticleList *pMCParticleList = nullptr;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_mcParticleListName, pMCParticleList));
 
     const CaloHitList *pCaloHitList = nullptr;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_caloHitListName, pCaloHitList));
 
     LArMCParticleHelper::PrimaryParameters parameters;
     parameters.m_minHitSharingFraction = 0.f;
 
     LArMCParticleHelper::MCContributionMap nuMCParticlesToGoodHitsMap;
     LArMCParticleHelper::MCContributionMap beamMCParticlesToGoodHitsMap;
     LArMCParticleHelper::MCContributionMap crMCParticlesToGoodHitsMap;
     LArMCParticleHelper::SelectReconstructableMCParticles(pMCParticleList, pCaloHitList, parameters, LArMCParticleHelper::IsBeamNeutrinoFinalState, nuMCParticlesToGoodHitsMap);
 
     if (!m_useTrueNeutrinosOnly)
     {
         LArMCParticleHelper::SelectReconstructableMCParticles(pMCParticleList, pCaloHitList, parameters, LArMCParticleHelper::IsBeamParticle, beamMCParticlesToGoodHitsMap);
         LArMCParticleHelper::SelectReconstructableMCParticles(pMCParticleList, pCaloHitList, parameters, LArMCParticleHelper::IsCosmicRay, crMCParticlesToGoodHitsMap);
     }
 
     if (!nuMCParticlesToGoodHitsMap.empty())
     {
         std::cout << std::endl << "BeamNeutrinos: " << std::endl;
         this->PrintPrimaryMCParticles(nuMCParticlesToGoodHitsMap);
     }
 
     if (!beamMCParticlesToGoodHitsMap.empty())
     {
         std::cout << std::endl << "BeamParticles: " << std::endl;
         this->PrintPrimaryMCParticles(beamMCParticlesToGoodHitsMap);
     }
 
     if (!crMCParticlesToGoodHitsMap.empty())
     {
         std::cout << std::endl << "CosmicRays: " << std::endl;
         this->PrintPrimaryMCParticles(crMCParticlesToGoodHitsMap);
     }
 
     std::cout << "------------------------------------------------------------------------------------------------" << std::endl;
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

std::string lar_content::MCParticleMonitoringAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 50 of file MCParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::MCParticleMonitoringAlgorithm::m_mcParticleListName

private

Name of input MC particle list.

Definition at line 51 of file MCParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

unsigned int lar_content::MCParticleMonitoringAlgorithm::m_minHitsForDisplay

private

Min hits associated with mc particle to warrant display to terminal.

Definition at line 54 of file MCParticleMonitoringAlgorithm.h.

Referenced by PrintMCParticle(), PrintPrimaryMCParticles(), and ReadSettings().

bool lar_content::MCParticleMonitoringAlgorithm::m_useTrueNeutrinosOnly

private

Whether to consider only mc particles that were neutrino induced.

Definition at line 53 of file MCParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArMonitoring/MCParticleMonitoringAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArMonitoring/MCParticleMonitoringAlgorithm.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation