DLBaseHierarchyTool to calculate variables related to the initial shower region. More...

#include "DLBaseHierarchyTool.h"

Inheritance diagram for lar_dl_content::DLBaseHierarchyTool:

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

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

void	SetDetectorBoundaries ()
	Set the detector boundaries. More...

std::pair< float, float >	GetParticleInfoAboutPfoPosition (const pandora::Algorithm const pAlgorithm, const pandora::ParticleFlowObject const pPfo, const pandora::CartesianVector &pointOfInterest) const
	Return the number of 3D hits and the number of corresponding pfos of a given pfo about a point. More...

void	NormaliseNetworkParam (const float minLimit, const float maxLimit, float &networkParam) const
	Shift and normalise a network parameter with respect to an input range. More...

Protected Attributes
float	m_vertexRegionRadiusSq
	the radius (squared) in which to search for particle hits More...

pandora::StringVector	m_pfoListNames
	the input pfo list name vector More...

LArGeometryHelper::DetectorBoundaries	m_detectorBoundaries
	the detector boundaries More...

bool	m_areBoundariesSet
	whether the detector boundaries have been set More...

Detailed Description

DLBaseHierarchyTool to calculate variables related to the initial shower region.

Definition at line 27 of file DLBaseHierarchyTool.h.

Constructor & Destructor Documentation

lar_dl_content::DLBaseHierarchyTool::DLBaseHierarchyTool ( )

Default constructor.

Definition at line 27 of file DLBaseHierarchyTool.cc.

References m_areBoundariesSet.

                                          :
     m_vertexRegionRadiusSq(25.f),
     m_pfoListNames({"TrackParticles3D", "ShowerParticles3D"}),
     m_areBoundariesSet(false)
 {
 }

Member Function Documentation

std::pair< float, float > lar_dl_content::DLBaseHierarchyTool::GetParticleInfoAboutPfoPosition	(	const pandora::Algorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pPfo,
		const pandora::CartesianVector &	pointOfInterest
	)		const

protected

Return the number of 3D hits and the number of corresponding pfos of a given pfo about a point.

Parameters

pAlgorithm	a pointer to the pandora algorithm calling the tool
pPfo	a pointer to the pfo
pointOfInterest	the input position

Returns: std::pair of the number of 3D hits and the number of corresponding pfos

Definition at line 47 of file DLBaseHierarchyTool.cc.

References m_pfoListNames, and m_vertexRegionRadiusSq.

Referenced by lar_dl_content::DLLaterTierHierarchyTool::SetEndRegionParams(), and lar_dl_content::DLPrimaryHierarchyTool::SetVertexRegionParams().

 {
     int hitCount(0);
     int particleCount(0);
 
     for (const std::string &pfoListName : m_pfoListNames)
     {
         const PfoList *pPfoList(nullptr);
         if (PandoraContentApi::GetList(*pAlgorithm, pfoListName, pPfoList) != STATUS_CODE_SUCCESS)
             continue;
 
         for (const ParticleFlowObject *const pOtherPfo : *pPfoList)
         {
             if (pPfo == pOtherPfo)
                 continue;
 
             bool isClose(false);
 
             CartesianPointVector otherPfoPositions3D;
             LArPfoHelper::GetCoordinateVector(pOtherPfo, TPC_3D, otherPfoPositions3D);
 
             for (const CartesianVector &otherPfoPosition : otherPfoPositions3D)
             {
                 const double sepSq((otherPfoPosition - pointOfInterest).GetMagnitudeSquared());
 
                 if (sepSq < m_vertexRegionRadiusSq)
                 {
                     isClose = true;
                     ++hitCount;
                 }
             }
 
             if (isClose)
                 ++particleCount;
         }
     }
 
     return std::pair<float, float>({hitCount, particleCount});
 }

void lar_dl_content::DLBaseHierarchyTool::NormaliseNetworkParam	(	const float	minLimit,
		const float	maxLimit,
		float &	networkParam
	)		const

protected

Shift and normalise a network parameter with respect to an input range.

Parameters

minLimit	the minimum allowed value of the variable
maxLimit	the maximum allowed value of the variable
networkParam	the input network parameter value

Definition at line 90 of file DLBaseHierarchyTool.cc.

Referenced by lar_dl_content::DLPrimaryHierarchyTool::NormaliseNetworkParams(), and lar_dl_content::DLLaterTierHierarchyTool::NormaliseNetworkParams().

 {
     const float interval(std::fabs(maxLimit - minLimit));
 
     if (interval < std::numeric_limits<float>::epsilon())
     {
         networkParam = minLimit;
         return;
     }
 
     if (networkParam < minLimit)
         networkParam = minLimit;
 
     if (networkParam > maxLimit)
         networkParam = maxLimit;
 
     networkParam /= interval;
 }

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

protected

Definition at line 111 of file DLBaseHierarchyTool.cc.

References m_pfoListNames, and m_vertexRegionRadiusSq.

Referenced by lar_dl_content::DLPrimaryHierarchyTool::ReadSettings(), and lar_dl_content::DLLaterTierHierarchyTool::ReadSettings().

 {
     StatusCode statCode(XmlHelper::ReadValue(xmlHandle, "VertexRegionRadius", m_vertexRegionRadiusSq));
 
     if (statCode == STATUS_CODE_SUCCESS)
     {
         m_vertexRegionRadiusSq = m_vertexRegionRadiusSq * m_vertexRegionRadiusSq;
     }
     else if (statCode != STATUS_CODE_NOT_FOUND)
     {
         return statCode;
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "PfoListNames", m_pfoListNames));
 
     return STATUS_CODE_SUCCESS;
 }

void lar_dl_content::DLBaseHierarchyTool::SetDetectorBoundaries ( )

protected

Set the detector boundaries.

Definition at line 36 of file DLBaseHierarchyTool.cc.

References m_areBoundariesSet, and m_detectorBoundaries.

Referenced by lar_dl_content::DLLaterTierHierarchyTool::Run(), and lar_dl_content::DLPrimaryHierarchyTool::Run().

 {
     if (m_areBoundariesSet)
         return;
 
     m_detectorBoundaries = LArGeometryHelper::GetDetectorBoundaries(this->GetPandora());
     m_areBoundariesSet = true;
 }

Member Data Documentation

bool lar_dl_content::DLBaseHierarchyTool::m_areBoundariesSet

protected

whether the detector boundaries have been set

Definition at line 68 of file DLBaseHierarchyTool.h.

Referenced by DLBaseHierarchyTool(), and SetDetectorBoundaries().

LArGeometryHelper::DetectorBoundaries lar_dl_content::DLBaseHierarchyTool::m_detectorBoundaries

protected

the detector boundaries

Definition at line 67 of file DLBaseHierarchyTool.h.

Referenced by lar_dl_content::DLPrimaryHierarchyTool::CalculateConnectionDistances(), SetDetectorBoundaries(), and lar_dl_content::DLLaterTierHierarchyTool::SetEndRegionRToWall().

pandora::StringVector lar_dl_content::DLBaseHierarchyTool::m_pfoListNames

protected

the input pfo list name vector

Definition at line 66 of file DLBaseHierarchyTool.h.

Referenced by GetParticleInfoAboutPfoPosition(), ReadSettings(), and lar_dl_content::DLPrimaryHierarchyTool::ReadSettings().

float lar_dl_content::DLBaseHierarchyTool::m_vertexRegionRadiusSq

protected

the radius (squared) in which to search for particle hits

Definition at line 65 of file DLBaseHierarchyTool.h.

Referenced by GetParticleInfoAboutPfoPosition(), and ReadSettings().

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

larpandoracontent/v04_15_01/source/larpandoradlcontent/LArThreeDReco/LArEventBuilding/DLBaseHierarchyTool.h
larpandoracontent/v04_15_01/source/larpandoradlcontent/LArThreeDReco/LArEventBuilding/DLBaseHierarchyTool.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation