#include "BdtBeamParticleIdTool.h"

Inheritance diagram for lar_content::BdtBeamParticleIdTool:

Classes
class	Plane
	Plane class. More...

class	SliceFeatureParameters
	SliceFeatureParameters class. More...

class	SliceFeatures
	Slice features class. More...

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

	BdtBeamParticleIdTool (const BdtBeamParticleIdTool &)=default
	Copy constructor. More...

BdtBeamParticleIdTool &	operator= (const BdtBeamParticleIdTool &)=default
	Assignment operator. More...

	~BdtBeamParticleIdTool ()=default
	Destructor. More...

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

Private Types
typedef std::vector< Plane >	PlaneVector

typedef std::vector< SliceFeatures >	SliceFeaturesVector

typedef std::pair< unsigned int, float >	UintFloatPair

typedef std::unordered_map< const pandora::MCParticle *, int >	MCParticleToIntMap

Private Member Functions
pandora::StatusCode	Initialize ()

void	GetSliceFeatures (const SliceHypotheses &nuSliceHypotheses, const SliceHypotheses &crSliceHypotheses, SliceFeaturesVector &sliceFeaturesVector) const
	Get the features of each slice. More...

void	SelectAllPfos (const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &hypotheses, pandora::PfoList &selectedPfos) const
	Select all pfos under the same hypothesis. More...

void	SelectPfos (const pandora::PfoList &pfos, pandora::PfoList &selectedPfos) const
	Add the given pfos to the selected Pfo list. More...

void	GetBestMCSliceIndices (const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &nuSliceHypotheses, const SliceHypotheses &crSliceHypotheses, pandora::IntVector &bestSliceIndices) const
	Get the slice with the most neutrino induced hits using Monte-Carlo information. More...

void	PopulateMCParticleToHitsMap (MCParticleToIntMap &mcParticleToIntMap, const pandora::CaloHitList &caloHitList) const
	Fill mc particle to nHits map from calo hit list. More...

void	Collect2DHits (const pandora::PfoList &pfos, pandora::CaloHitList &caloHitList, const pandora::CaloHitSet &reconstructableCaloHitSet) const
	Collect all 2D hits in a supplied list of Pfos and push them on to an existing hit list, check so not to double count. More...

bool	PassesQualityCuts (const float purity, const float completeness) const
	Determine if the event passes the selection cuts for training. More...

void	SelectPfosByAdaBDTScore (const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &nuSliceHypotheses, const SliceHypotheses &crSliceHypotheses, const SliceFeaturesVector &sliceFeaturesVector, pandora::PfoList &selectedPfos) const
	Select pfos based on the AdaBDT score that the slice contains a beam particle interaction. More...

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

Private Attributes
bool	m_useTrainingMode
	Should use training mode. If true, training examples will be written to the output file. More...

std::string	m_trainingOutputFile
	Output file name for training examples. More...

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

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

float	m_minPurity
	Minimum purity of the best slice to use event for training. More...

float	m_minCompleteness
	Minimum completeness of the best slice to use event for training. More...

AdaBoostDecisionTree	m_adaBoostDecisionTree
	The adaptive boost decision tree. More...

std::string	m_filePathEnvironmentVariable
	The environment variable providing a list of paths to bdt files. More...

unsigned int	m_maxNeutrinos
	The maximum number of neutrinos to select in any one event. More...

float	m_minAdaBDTScore
	Minimum score required to classify a slice as a beam particle. More...

SliceFeatureParameters	m_sliceFeatureParameters
	Geometry information block. More...

Detailed Description

BdtBeamParticleIdTool class.

Definition at line 24 of file BdtBeamParticleIdTool.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::MCParticle *, int> lar_content::BdtBeamParticleIdTool::MCParticleToIntMap

private

Definition at line 305 of file BdtBeamParticleIdTool.h.

typedef std::vector<Plane> lar_content::BdtBeamParticleIdTool::PlaneVector

private

Definition at line 83 of file BdtBeamParticleIdTool.h.

typedef std::vector<SliceFeatures> lar_content::BdtBeamParticleIdTool::SliceFeaturesVector

private

Definition at line 303 of file BdtBeamParticleIdTool.h.

typedef std::pair<unsigned int, float> lar_content::BdtBeamParticleIdTool::UintFloatPair

private

Definition at line 304 of file BdtBeamParticleIdTool.h.

Constructor & Destructor Documentation

lar_content::BdtBeamParticleIdTool::BdtBeamParticleIdTool ( )

Constructor.

Definition at line 23 of file BdtBeamParticleIdTool.cc.

                                              :
     m_useTrainingMode(false),
     m_trainingOutputFile(""),
     m_minPurity(0.8f),
     m_minCompleteness(0.8f),
     m_adaBoostDecisionTree(AdaBoostDecisionTree()),
     m_filePathEnvironmentVariable("FW_SEARCH_PATH"),
     m_maxNeutrinos(std::numeric_limits<int>::max()),
     m_minAdaBDTScore(0.f),
     m_sliceFeatureParameters(SliceFeatureParameters())
 {
 }

lar_content::BdtBeamParticleIdTool::BdtBeamParticleIdTool ( const BdtBeamParticleIdTool & )

default

Copy constructor.

Parameters

BdtBeamParticleIdTool to copy

lar_content::BdtBeamParticleIdTool::~BdtBeamParticleIdTool ( )

default

Destructor.

Member Function Documentation

void lar_content::BdtBeamParticleIdTool::Collect2DHits	(	const pandora::PfoList &	pfos,
		pandora::CaloHitList &	caloHitList,
		const pandora::CaloHitSet &	reconstructableCaloHitSet
	)		const

private

Collect all 2D hits in a supplied list of Pfos and push them on to an existing hit list, check so not to double count.

Parameters

pfos	input list of pfos
caloHitList	output list of all 2d hits in the input pfos
reconstructableCaloHitSet	to check if part of before adding

Definition at line 266 of file BdtBeamParticleIdTool.cc.

References lar_content::LArPfoHelper::GetCaloHits().

Referenced by GetBestMCSliceIndices().

 {
     CaloHitList collectedHits;
     LArPfoHelper::GetCaloHits(pfos, TPC_VIEW_U, collectedHits);
     LArPfoHelper::GetCaloHits(pfos, TPC_VIEW_V, collectedHits);
     LArPfoHelper::GetCaloHits(pfos, TPC_VIEW_W, collectedHits);
 
     for (const CaloHit *const pCaloHit : collectedHits)
     {
         // ATTN hits collected from Pfos are copies of hits passed from master instance, we need to access their parent to use MC info
         const CaloHit *pParentCaloHit(static_cast<const CaloHit *>(pCaloHit->GetParentAddress()));
 
         if (!reconstructableCaloHitSet.count(pParentCaloHit))
             continue;
 
         // Ensure no hits have been double counted
         if (std::find(reconstructedCaloHitList.begin(), reconstructedCaloHitList.end(), pParentCaloHit) == reconstructedCaloHitList.end())
             reconstructedCaloHitList.push_back(pParentCaloHit);
     }
 }

void lar_content::BdtBeamParticleIdTool::GetBestMCSliceIndices	(	const pandora::Algorithm *const	pAlgorithm,
		const SliceHypotheses &	nuSliceHypotheses,
		const SliceHypotheses &	crSliceHypotheses,
		pandora::IntVector &	bestSliceIndices
	)		const

private

Get the slice with the most neutrino induced hits using Monte-Carlo information.

Parameters

pAlgorithm	address of the master algorithm
nuSliceHypotheses	the input neutrino slice hypotheses
crSliceHypotheses	the input cosmic slice hypotheses
bestSliceIndices	vector of slice indices passing quality cuts

Definition at line 163 of file BdtBeamParticleIdTool.cc.

References Collect2DHits(), f, lar_content::LArMCParticleHelper::GetMCPrimaryMap(), lar_content::LArMCParticleHelper::GetNuanceCode(), m_caloHitListName, lar_content::LArMCParticleHelper::PrimaryParameters::m_maxPhotonPropagation, m_mcParticleListName, lar_content::LArMCParticleHelper::PrimaryParameters::m_selectInputHits, PassesQualityCuts(), PopulateMCParticleToHitsMap(), and lar_content::LArMCParticleHelper::SelectCaloHits().

Referenced by SelectOutputPfos().

 {
     // Get all hits in all slices to find true number of mc hits
     const CaloHitList *pAllReconstructedCaloHitList(nullptr);
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*pAlgorithm, m_caloHitListName, pAllReconstructedCaloHitList));
 
     const MCParticleList *pMCParticleList(nullptr);
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*pAlgorithm, m_mcParticleListName, pMCParticleList));
 
     // Obtain map: [mc particle -> primary mc particle]
     LArMCParticleHelper::MCRelationMap mcToPrimaryMCMap;
     LArMCParticleHelper::GetMCPrimaryMap(pMCParticleList, mcToPrimaryMCMap);
 
     // Remove non-reconstructable hits, e.g. those downstream of a neutron
     CaloHitList reconstructableCaloHitList;
     LArMCParticleHelper::PrimaryParameters parameters;
     LArMCParticleHelper::SelectCaloHits(pAllReconstructedCaloHitList, mcToPrimaryMCMap, reconstructableCaloHitList,
         parameters.m_selectInputHits, parameters.m_maxPhotonPropagation);
 
     MCParticleToIntMap mcParticleToReconstructableHitsMap;
     this->PopulateMCParticleToHitsMap(mcParticleToReconstructableHitsMap, reconstructableCaloHitList);
 
     const CaloHitSet reconstructableCaloHitSet(reconstructableCaloHitList.begin(), reconstructableCaloHitList.end());
 
     for (unsigned int sliceIndex = 0, nSlices = nuSliceHypotheses.size(); sliceIndex < nSlices; ++sliceIndex)
     {
         // All hits in a slice - No double counting
         CaloHitList reconstructedCaloHitList;
         this->Collect2DHits(crSliceHypotheses.at(sliceIndex), reconstructedCaloHitList, reconstructableCaloHitSet);
 
         if (nuSliceHypotheses.at(sliceIndex).size() == 1)
         {
             const PfoList &nuFinalStates(nuSliceHypotheses.at(sliceIndex).front()->GetDaughterPfoList());
             this->Collect2DHits(nuFinalStates, reconstructedCaloHitList, reconstructableCaloHitSet);
         }
 
         const unsigned int nRecoHits(reconstructedCaloHitList.size());
 
         // MCParticle to hits in slice map
         MCParticleToIntMap mcParticleToHitsInSliceMap;
         this->PopulateMCParticleToHitsMap(mcParticleToHitsInSliceMap, reconstructedCaloHitList);
 
         if (mcParticleToHitsInSliceMap.empty())
             continue;
 
         // Get best mc particle for slice
         const MCParticle *pBestMCParticle(nullptr);
         unsigned int nSharedHits(0);
 
         for (const auto &iter : mcParticleToHitsInSliceMap)
         {
             if (iter.second > static_cast<int>(nSharedHits))
             {
                 pBestMCParticle = iter.first;
                 nSharedHits = iter.second;
             }
         }
 
         // Only consider if target beam particles
         if (2001 != LArMCParticleHelper::GetNuanceCode(pBestMCParticle))
             continue;
 
         const unsigned int nMCHits(mcParticleToReconstructableHitsMap.at(pBestMCParticle));
         const float purity(nRecoHits > 0 ? static_cast<float>(nSharedHits) / static_cast<float>(nRecoHits) : 0.f);
         const float completeness(nMCHits > 0 ? static_cast<float>(nSharedHits) / static_cast<float>(nMCHits) : 0.f);
 
         if (this->PassesQualityCuts(purity, completeness))
             bestSliceIndices.push_back(sliceIndex);
     }
     return;
 }

void lar_content::BdtBeamParticleIdTool::GetSliceFeatures	(	const SliceHypotheses &	nuSliceHypotheses,
		const SliceHypotheses &	crSliceHypotheses,
		SliceFeaturesVector &	sliceFeaturesVector
	)		const

private

Get the features of each slice.

Parameters

nuSliceHypotheses	the input neutrino slice hypotheses
crSliceHypotheses	the input cosmic slice hypotheses
sliceFeaturesVector	vector to hold the slice features

Definition at line 130 of file BdtBeamParticleIdTool.cc.

References m_sliceFeatureParameters.

Referenced by SelectOutputPfos().

 {
     for (unsigned int sliceIndex = 0, nSlices = nuSliceHypotheses.size(); sliceIndex < nSlices; ++sliceIndex)
         sliceFeaturesVector.push_back(SliceFeatures(nuSliceHypotheses.at(sliceIndex), crSliceHypotheses.at(sliceIndex), m_sliceFeatureParameters));
 }

StatusCode lar_content::BdtBeamParticleIdTool::Initialize ( )

private

Definition at line 38 of file BdtBeamParticleIdTool.cc.

References lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::Initialize(), and m_sliceFeatureParameters.

 {
     // Get global LArTPC geometry information
     const LArTPCMap &larTPCMap(this->GetPandora().GetGeometry()->GetLArTPCMap());
     const LArTPC *const pFirstLArTPC(larTPCMap.begin()->second);
     float parentMinX(pFirstLArTPC->GetCenterX() - 0.5f * pFirstLArTPC->GetWidthX());
     float parentMaxX(pFirstLArTPC->GetCenterX() + 0.5f * pFirstLArTPC->GetWidthX());
     float parentMinY(pFirstLArTPC->GetCenterY() - 0.5f * pFirstLArTPC->GetWidthY());
     float parentMaxY(pFirstLArTPC->GetCenterY() + 0.5f * pFirstLArTPC->GetWidthY());
     float parentMinZ(pFirstLArTPC->GetCenterZ() - 0.5f * pFirstLArTPC->GetWidthZ());
     float parentMaxZ(pFirstLArTPC->GetCenterZ() + 0.5f * pFirstLArTPC->GetWidthZ());
 
     for (const LArTPCMap::value_type &mapEntry : larTPCMap)
     {
         const LArTPC *const pLArTPC(mapEntry.second);
         parentMinX = std::min(parentMinX, pLArTPC->GetCenterX() - 0.5f * pLArTPC->GetWidthX());
         parentMaxX = std::max(parentMaxX, pLArTPC->GetCenterX() + 0.5f * pLArTPC->GetWidthX());
         parentMinY = std::min(parentMinY, pLArTPC->GetCenterY() - 0.5f * pLArTPC->GetWidthY());
         parentMaxY = std::max(parentMaxY, pLArTPC->GetCenterY() + 0.5f * pLArTPC->GetWidthY());
         parentMinZ = std::min(parentMinZ, pLArTPC->GetCenterZ() - 0.5f * pLArTPC->GetWidthZ());
         parentMaxZ = std::max(parentMaxZ, pLArTPC->GetCenterZ() + 0.5f * pLArTPC->GetWidthZ());
     }
 
     try
     {
         m_sliceFeatureParameters.Initialize(parentMinX, parentMaxX, parentMinY, parentMaxY, parentMinZ, parentMaxZ);
     }
     catch (const StatusCodeException &statusCodeException)
     {
         std::cout << "BdtBeamParticleIdTool::Initialize - unable to initialize LArTPC geometry parameters" << std::endl;
         return STATUS_CODE_FAILURE;
     }
 
     return STATUS_CODE_SUCCESS;
 }

BdtBeamParticleIdTool& lar_content::BdtBeamParticleIdTool::operator= ( const BdtBeamParticleIdTool & )

default

Assignment operator.

Parameters

The	BdtBeamParticleIdTool to assign

bool lar_content::BdtBeamParticleIdTool::PassesQualityCuts	(	const float	purity,
		const float	completeness
	)		const

private

Determine if the event passes the selection cuts for training.

Parameters

purity	purity of best slice
completeness	completeness of best slice

Returns: does the evenr pass the quality cuts on purity and completeness

Definition at line 289 of file BdtBeamParticleIdTool.cc.

References m_minCompleteness, and m_minPurity.

Referenced by GetBestMCSliceIndices().

 {
     if ((purity < m_minPurity) || (completeness < m_minCompleteness))
         return false;
 
     return true;
 }

void lar_content::BdtBeamParticleIdTool::PopulateMCParticleToHitsMap	(	MCParticleToIntMap &	mcParticleToIntMap,
		const pandora::CaloHitList &	caloHitList
	)		const

private

Fill mc particle to nHits map from calo hit list.

Parameters

mcParticleToIntMap	map to fill
caloHitList	the input calo hits

Definition at line 238 of file BdtBeamParticleIdTool.cc.

References lar_content::LArMCParticleHelper::GetParentMCParticle().

Referenced by GetBestMCSliceIndices().

 {
     for (const CaloHit *const pCaloHit : caloHitList)
     {
         try
         {
             const MCParticle *pParentMCParticle(LArMCParticleHelper::GetParentMCParticle(MCParticleHelper::GetMainMCParticle(pCaloHit)));
             MCParticleToIntMap::iterator iter(mcParticleToIntMap.find(pParentMCParticle));
 
             if (iter != mcParticleToIntMap.end())
             {
                 (*iter).second += 1;
             }
             else
             {
                 mcParticleToIntMap.insert(MCParticleToIntMap::value_type(pParentMCParticle, 1));
             }
         }
         catch (const StatusCodeException &statusCodeException)
         {
             if (STATUS_CODE_NOT_INITIALIZED != statusCodeException.GetStatusCode())
                 throw statusCodeException;
         }
     }
 }

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

private

Definition at line 691 of file BdtBeamParticleIdTool.cc.

References f, lar_content::LArFileHelper::FindFileInPath(), lar_content::AdaBoostDecisionTree::Initialize(), m_adaBoostDecisionTree, m_caloHitListName, m_filePathEnvironmentVariable, m_maxNeutrinos, m_mcParticleListName, m_minAdaBDTScore, m_minCompleteness, m_minPurity, m_sliceFeatureParameters, m_trainingOutputFile, m_useTrainingMode, lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::SetBeamDirection(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::SetBeamLArTPCIntersection(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::SetContainmentLimit(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::SetNSelectedHits(), and lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::SetSelectedFraction().

 {
     // BDT Settings
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseTrainingMode", m_useTrainingMode));
 
     if (m_useTrainingMode)
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "TrainingOutputFileName", m_trainingOutputFile));
 
         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));
     }
     else
     {
         std::string bdtName;
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "BdtName", bdtName));
 
         std::string bdtFileName;
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "BdtFileName", bdtFileName));
 
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MinAdaBDTScore", m_minAdaBDTScore));
 
         const std::string fullBdtFileName(LArFileHelper::FindFileInPath(bdtFileName, m_filePathEnvironmentVariable));
         const StatusCode statusCode(m_adaBoostDecisionTree.Initialize(fullBdtFileName, bdtName));
 
         if (STATUS_CODE_SUCCESS != statusCode)
         {
             std::cout << "BdtBeamParticleIdTool::ReadSettings - unable to load bdt" << std::endl;
             return statusCode;
         }
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinimumPurity", m_minPurity));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinimumCompleteness", m_minCompleteness));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "FilePathEnvironmentVariable", m_filePathEnvironmentVariable));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaximumNeutrinos", m_maxNeutrinos));
 
     // Geometry Information for training
     FloatVector beamLArTPCIntersection;
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadVectorOfValues(xmlHandle, "BeamTPCIntersection", beamLArTPCIntersection));
 
     if (3 == beamLArTPCIntersection.size())
     {
         pandora::CartesianVector beamLArTPCIntersectionCartesianVector(
             beamLArTPCIntersection.at(0), beamLArTPCIntersection.at(1), beamLArTPCIntersection.at(2));
         m_sliceFeatureParameters.SetBeamLArTPCIntersection(beamLArTPCIntersectionCartesianVector);
     }
     else if (!beamLArTPCIntersection.empty())
     {
         std::cout << "BdtBeamParticleIdTool::ReadSettings - invalid BeamTPCIntersection specified " << std::endl;
         return STATUS_CODE_INVALID_PARAMETER;
     }
     else
     {
         // Default for protoDUNE.
         pandora::CartesianVector beamLArTPCIntersectionCartesianVector(-33.051f, 461.06f, 0.f);
         m_sliceFeatureParameters.SetBeamLArTPCIntersection(beamLArTPCIntersectionCartesianVector);
     }
 
     FloatVector beamDirection;
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "BeamDirection", beamDirection));
 
     if (3 == beamDirection.size())
     {
         CartesianVector beamDirectionCartesianVector(beamDirection.at(0), beamDirection.at(1), beamDirection.at(2));
         m_sliceFeatureParameters.SetBeamDirection(beamDirectionCartesianVector);
     }
     else if (!beamDirection.empty())
     {
         std::cout << "BdtBeamParticleIdTool::ReadSettings - invalid BeamDirection specified " << std::endl;
         return STATUS_CODE_INVALID_PARAMETER;
     }
     else
     {
         // Default for protoDUNE.
         const float thetaXZ0(-11.844f * M_PI / 180.f);
         CartesianVector beamDirectionCartesianVector(std::sin(thetaXZ0), 0.f, std::cos(thetaXZ0));
         m_sliceFeatureParameters.SetBeamDirection(beamDirectionCartesianVector);
     }
 
     float selectedFraction(0.f);
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SelectedFraction", selectedFraction));
 
     if (selectedFraction > std::numeric_limits<float>::epsilon())
         m_sliceFeatureParameters.SetSelectedFraction(selectedFraction);
 
     unsigned int nSelectedHits(0);
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NSelectedHits", nSelectedHits));
 
     if (nSelectedHits > 0)
         m_sliceFeatureParameters.SetNSelectedHits(nSelectedHits);
 
     float containmentLimit(0.f);
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ContainmentLimit", containmentLimit));
 
     if (containmentLimit < 0.f)
     {
         std::cout << "BdtBeamParticleIdTool::ReadSettings - invalid ContainmentLimit specified " << std::endl;
         return STATUS_CODE_INVALID_PARAMETER;
     }
     else if (containmentLimit > 0.f)
     {
         m_sliceFeatureParameters.SetContainmentLimit(containmentLimit);
     }
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::BdtBeamParticleIdTool::SelectAllPfos	(	const pandora::Algorithm *const	pAlgorithm,
		const SliceHypotheses &	hypotheses,
		pandora::PfoList &	selectedPfos
	)		const

private

Select all pfos under the same hypothesis.

Parameters

pAlgorithm	address of the master algorithm
hypotheses	the lists of slices under a certain hypothesis
selectedPfos	the list of pfos to populate

Definition at line 139 of file BdtBeamParticleIdTool.cc.

References SelectPfos().

Referenced by SelectOutputPfos().

 {
     for (const PfoList &pfos : hypotheses)
     {
         for (const ParticleFlowObject *const pPfo : pfos)
         {
             object_creation::ParticleFlowObject::Metadata metadata;
             metadata.m_propertiesToAdd["TestBeamScore"] = -1.f;
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*pAlgorithm, pPfo, metadata));
         }
 
         this->SelectPfos(pfos, selectedPfos);
     }
 }

void lar_content::BdtBeamParticleIdTool::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::SliceIdBaseTool.

Definition at line 76 of file BdtBeamParticleIdTool.cc.

References lar_content::BdtBeamParticleIdTool::SliceFeatures::FillFeatureVector(), GetBestMCSliceIndices(), GetSliceFeatures(), m_trainingOutputFile, m_useTrainingMode, lar_content::LArMvaHelper::ProduceTrainingExample(), SelectAllPfos(), and SelectPfosByAdaBDTScore().

 {
     if (nuSliceHypotheses.size() != crSliceHypotheses.size())
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     const unsigned int nSlices(nuSliceHypotheses.size());
     if (nSlices == 0)
         return;
 
     SliceFeaturesVector sliceFeaturesVector;
     this->GetSliceFeatures(nuSliceHypotheses, crSliceHypotheses, sliceFeaturesVector);
 
     if (m_useTrainingMode)
     {
         // ATTN in training mode, just return everything as a cosmic-ray
         this->SelectAllPfos(pAlgorithm, crSliceHypotheses, selectedPfos);
 
         pandora::IntVector bestSliceIndices;
         this->GetBestMCSliceIndices(pAlgorithm, nuSliceHypotheses, crSliceHypotheses, bestSliceIndices);
 
         for (unsigned int sliceIndex = 0; sliceIndex < nSlices; ++sliceIndex)
         {
             const SliceFeatures &features(sliceFeaturesVector.at(sliceIndex));
             if (!features.IsFeatureVectorAvailable())
                 continue;
 
             LArMvaHelper::MvaFeatureVector featureVector;
 
             try
             {
                 features.FillFeatureVector(featureVector);
             }
             catch (const StatusCodeException &statusCodeException)
             {
                 std::cout << "BdtBeamParticleIdTool::SelectOutputPfos - unable to fill feature vector" << std::endl;
                 continue;
             }
 
             bool isGoodTrainingSlice(false);
             if (std::find(bestSliceIndices.begin(), bestSliceIndices.end(), sliceIndex) != bestSliceIndices.end())
                 isGoodTrainingSlice = true;
 
             LArMvaHelper::ProduceTrainingExample(m_trainingOutputFile, isGoodTrainingSlice, featureVector);
         }
 
         return;
     }
 
     this->SelectPfosByAdaBDTScore(pAlgorithm, nuSliceHypotheses, crSliceHypotheses, sliceFeaturesVector, selectedPfos);
 }

void lar_content::BdtBeamParticleIdTool::SelectPfos	(	const pandora::PfoList &	pfos,
		pandora::PfoList &	selectedPfos
	)		const

private

Add the given pfos to the selected Pfo list.

Parameters

pfos	the pfos to select
selectedPfos	the list of pfos to populate

Definition at line 156 of file BdtBeamParticleIdTool.cc.

Referenced by SelectAllPfos(), and SelectPfosByAdaBDTScore().

 {
     selectedPfos.insert(selectedPfos.end(), pfos.begin(), pfos.end());
 }

void lar_content::BdtBeamParticleIdTool::SelectPfosByAdaBDTScore	(	const pandora::Algorithm *const	pAlgorithm,
		const SliceHypotheses &	nuSliceHypotheses,
		const SliceHypotheses &	crSliceHypotheses,
		const SliceFeaturesVector &	sliceFeaturesVector,
		pandora::PfoList &	selectedPfos
	)		const

private

Select pfos based on the AdaBDT score that the slice contains a beam particle interaction.

Parameters

pAlgorithm	address of the master algorithm
nuSliceHypotheses	the input neutrino slice hypotheses
crSliceHypotheses	the input cosmic slice hypotheses
sliceFeaturesVector	vector holding the slice features
selectedPfos	the list of pfos to populate

Definition at line 299 of file BdtBeamParticleIdTool.cc.

References m_adaBoostDecisionTree, m_maxNeutrinos, m_minAdaBDTScore, and SelectPfos().

Referenced by SelectOutputPfos().

 {
     // Calculate the probability of each slice that passes the minimum probability cut
     std::vector<UintFloatPair> sliceIndexAdaBDTScorePairs;
     for (unsigned int sliceIndex = 0, nSlices = nuSliceHypotheses.size(); sliceIndex < nSlices; ++sliceIndex)
     {
         const float nuAdaBDTScore(sliceFeaturesVector.at(sliceIndex).GetAdaBoostDecisionTreeScore(m_adaBoostDecisionTree));
 
         for (const ParticleFlowObject *const pPfo : crSliceHypotheses.at(sliceIndex))
         {
             object_creation::ParticleFlowObject::Metadata metadata;
             metadata.m_propertiesToAdd["TestBeamScore"] = nuAdaBDTScore;
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*pAlgorithm, pPfo, metadata));
         }
 
         for (const ParticleFlowObject *const pPfo : nuSliceHypotheses.at(sliceIndex))
         {
             object_creation::ParticleFlowObject::Metadata metadata;
             metadata.m_propertiesToAdd["TestBeamScore"] = nuAdaBDTScore;
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*pAlgorithm, pPfo, metadata));
         }
 
         if (nuAdaBDTScore < m_minAdaBDTScore)
         {
             this->SelectPfos(crSliceHypotheses.at(sliceIndex), selectedPfos);
             continue;
         }
 
         sliceIndexAdaBDTScorePairs.push_back(UintFloatPair(sliceIndex, nuAdaBDTScore));
     }
 
     // Sort the slices by probability
     std::sort(sliceIndexAdaBDTScorePairs.begin(), sliceIndexAdaBDTScorePairs.end(),
         [](const UintFloatPair &a, const UintFloatPair &b) { return (a.second > b.second); });
 
     // Select the first m_maxNeutrinos as neutrinos, and the rest as cosmic
     unsigned int nNuSlices(0);
     for (const UintFloatPair &slice : sliceIndexAdaBDTScorePairs)
     {
         if (nNuSlices < m_maxNeutrinos)
         {
             this->SelectPfos(nuSliceHypotheses.at(slice.first), selectedPfos);
             nNuSlices++;
             continue;
         }
 
         this->SelectPfos(crSliceHypotheses.at(slice.first), selectedPfos);
     }
 }

Member Data Documentation

AdaBoostDecisionTree lar_content::BdtBeamParticleIdTool::m_adaBoostDecisionTree

private

The adaptive boost decision tree.

Definition at line 397 of file BdtBeamParticleIdTool.h.

Referenced by ReadSettings(), and SelectPfosByAdaBDTScore().

std::string lar_content::BdtBeamParticleIdTool::m_caloHitListName

private

Name of input calo hit list.

Definition at line 391 of file BdtBeamParticleIdTool.h.

Referenced by GetBestMCSliceIndices(), and ReadSettings().

std::string lar_content::BdtBeamParticleIdTool::m_filePathEnvironmentVariable

private

The environment variable providing a list of paths to bdt files.

Definition at line 398 of file BdtBeamParticleIdTool.h.

Referenced by ReadSettings().

unsigned int lar_content::BdtBeamParticleIdTool::m_maxNeutrinos

private

The maximum number of neutrinos to select in any one event.

Definition at line 399 of file BdtBeamParticleIdTool.h.

Referenced by ReadSettings(), and SelectPfosByAdaBDTScore().

std::string lar_content::BdtBeamParticleIdTool::m_mcParticleListName

private

Name of input MC particle list.

Definition at line 392 of file BdtBeamParticleIdTool.h.

Referenced by GetBestMCSliceIndices(), and ReadSettings().

float lar_content::BdtBeamParticleIdTool::m_minAdaBDTScore

private

Minimum score required to classify a slice as a beam particle.

Definition at line 400 of file BdtBeamParticleIdTool.h.

Referenced by ReadSettings(), and SelectPfosByAdaBDTScore().

float lar_content::BdtBeamParticleIdTool::m_minCompleteness

private

Minimum completeness of the best slice to use event for training.

Definition at line 394 of file BdtBeamParticleIdTool.h.

Referenced by PassesQualityCuts(), and ReadSettings().

float lar_content::BdtBeamParticleIdTool::m_minPurity

private

Minimum purity of the best slice to use event for training.

Definition at line 393 of file BdtBeamParticleIdTool.h.

Referenced by PassesQualityCuts(), and ReadSettings().

SliceFeatureParameters lar_content::BdtBeamParticleIdTool::m_sliceFeatureParameters

private

Geometry information block.

Definition at line 401 of file BdtBeamParticleIdTool.h.

Referenced by lar_content::BdtBeamParticleIdTool::SliceFeatures::GetLArTPCIntercepts(), lar_content::BdtBeamParticleIdTool::SliceFeatures::GetLeadingCaloHits(), GetSliceFeatures(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::Initialize(), Initialize(), lar_content::BdtBeamParticleIdTool::SliceFeatures::IsContained(), and ReadSettings().

std::string lar_content::BdtBeamParticleIdTool::m_trainingOutputFile

private

Output file name for training examples.

Definition at line 390 of file BdtBeamParticleIdTool.h.

Referenced by ReadSettings(), and SelectOutputPfos().

bool lar_content::BdtBeamParticleIdTool::m_useTrainingMode

private

Should use training mode. If true, training examples will be written to the output file.

Definition at line 389 of file BdtBeamParticleIdTool.h.

Referenced by ReadSettings(), and SelectOutputPfos().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArControlFlow/BdtBeamParticleIdTool.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArControlFlow/BdtBeamParticleIdTool.cc

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation