CheatingBeamParticleIdTool class. More...

#include "CheatingBeamParticleIdTool.h"

Inheritance diagram for lar_content::CheatingBeamParticleIdTool:

Public Member Functions
	CheatingBeamParticleIdTool ()
	Constructor. More...

void	SelectOutputPfos (const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &nuSliceHypotheses, const SliceHypotheses &crSliceHypotheses, pandora::PfoList &selectedPfos)
	Select which reconstruction hypotheses to use; neutrino outcomes or cosmic-ray muon outcomes for each slice. More...

Static Public Member Functions
static void	GetTargetParticleWeight (const pandora::PfoList const pPfoList, float &targetParticleWeight, float &totalWeight, std::function< bool(const pandora::MCParticle const)> fCriteria)
	Get the target particle weight in a list of pfos. More...

static void	GetTargetParticleWeight (const pandora::CaloHit const pCaloHit, float &targetParticleWeight, float &totalWeight, std::function< bool(const pandora::MCParticle const)> fCriteria)
	Get the target particle weight for a calo hit. More...

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
float	m_minWeightFraction
	The minimum weight fraction for identifying a slice as a beam particle. More...

Detailed Description

CheatingBeamParticleIdTool class.

Definition at line 20 of file CheatingBeamParticleIdTool.h.

Constructor & Destructor Documentation

lar_content::CheatingBeamParticleIdTool::CheatingBeamParticleIdTool ( )

Constructor.

Definition at line 21 of file CheatingBeamParticleIdTool.cc.

                                                        :
     m_minWeightFraction(0.5f)
 {
 }

Member Function Documentation

static void lar_content::CheatingSliceIdBaseTool::GetTargetParticleWeight	(	const pandora::PfoList *const	pPfoList,
		float &	targetParticleWeight,
		float &	totalWeight,
		std::function< bool(const pandora::MCParticle *const)>	fCriteria
	)

staticinherited

Get the target particle weight in a list of pfos.

Parameters

pPfoList	address of the pfo list
targetParticleWeight	the target particle weight
totalWeight	the total weight
fCriteria	a function which returns a bool (= shouldSelect) for a given input MCParticle

Referenced by lar_content::CheatingCosmicRayTaggingTool::FindAmbiguousPfos(), lar_content::CheatingCosmicRayIdentificationAlg::Run(), and SelectOutputPfos().

static void lar_content::CheatingSliceIdBaseTool::GetTargetParticleWeight	(	const pandora::CaloHit *const	pCaloHit,
		float &	targetParticleWeight,
		float &	totalWeight,
		std::function< bool(const pandora::MCParticle *const)>	fCriteria
	)

staticinherited

Get the target particle weight for a calo hit.

Parameters

pCaloHit	address of the calo hit
targetParticleWeight	the target particle weight
totalWeight	the total weight
fCriteria	a function which returns a bool (= shouldSelect) for a given input MCParticle

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

private

Definition at line 71 of file CheatingBeamParticleIdTool.cc.

References m_minWeightFraction.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MinimumWeightFraction", m_minWeightFraction));
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::CheatingBeamParticleIdTool::SelectOutputPfos	(	const pandora::Algorithm *const	pAlgorithm,
		const SliceHypotheses &	nuSliceHypotheses,
		const SliceHypotheses &	crSliceHypotheses,
		pandora::PfoList &	selectedPfos
	)

virtual

Select which reconstruction hypotheses to use; neutrino outcomes or cosmic-ray muon outcomes for each slice.

Parameters

pAlgorithm	the address of the master instance, used to access MCParticles when in training mode
nuSliceHypotheses	the parent pfos representing the neutrino outcome for each slice
crSliceHypotheses	the parent pfos representing the cosmic-ray muon outcome for each slice
sliceNuPfos	to receive the list of selected pfos

Implements lar_content::CheatingSliceIdBaseTool.

Definition at line 28 of file CheatingBeamParticleIdTool.cc.

References f, lar_content::LArPfoHelper::GetAllDownstreamPfos(), lar_content::CheatingSliceIdBaseTool::GetTargetParticleWeight(), lar_content::LArMCParticleHelper::IsBeamParticle(), lar_content::LArPfoHelper::IsTestBeam(), and m_minWeightFraction.

 {
     if (testBeamSliceHypotheses.size() != crSliceHypotheses.size())
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     for (unsigned int sliceIndex = 0, nSlices = testBeamSliceHypotheses.size(); sliceIndex < nSlices; ++sliceIndex)
     {
         float beamParticleWeight(0.f), totalWeight(0.f);
         const PfoList &testBeamPfoList(testBeamSliceHypotheses.at(sliceIndex));
 
         for (const Pfo *const pTestBeamPfo : testBeamPfoList)
         {
             if (!LArPfoHelper::IsTestBeam(pTestBeamPfo))
                 throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
             PfoList downstreamPfos;
             LArPfoHelper::GetAllDownstreamPfos(pTestBeamPfo, downstreamPfos);
 
             float thisBeamParticleWeight(0.f), thisTotalWeight(0.f);
             CheatingSliceIdBaseTool::GetTargetParticleWeight(&downstreamPfos, thisBeamParticleWeight, thisTotalWeight, LArMCParticleHelper::IsBeamParticle);
 
             beamParticleWeight += thisBeamParticleWeight;
             totalWeight += thisTotalWeight;
         }
 
         const float beamWeightFraction(totalWeight < std::numeric_limits<float>::epsilon() ? 0.f : beamParticleWeight / totalWeight);
 
         if (beamWeightFraction > m_minWeightFraction)
         {
             const PfoList &sliceOutput(testBeamSliceHypotheses.at(sliceIndex));
             selectedPfos.insert(selectedPfos.end(), sliceOutput.begin(), sliceOutput.end());
         }
         else
         {
             const PfoList &sliceOutput(crSliceHypotheses.at(sliceIndex));
             selectedPfos.insert(selectedPfos.end(), sliceOutput.begin(), sliceOutput.end());
         }
     }
 }

Member Data Documentation

float lar_content::CheatingBeamParticleIdTool::m_minWeightFraction

private

The minimum weight fraction for identifying a slice as a beam particle.

Definition at line 34 of file CheatingBeamParticleIdTool.h.

Referenced by ReadSettings(), and SelectOutputPfos().

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

larpandoracontent/v04_15_01/source/larpandoracontent/LArCheating/CheatingBeamParticleIdTool.h
larpandoracontent/v04_15_01/source/larpandoracontent/LArCheating/CheatingBeamParticleIdTool.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation