#include "EndAssociatedPfosTool.h"

Inheritance diagram for lar_content::EndAssociatedPfosTool:

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

void	Run (const NeutrinoHierarchyAlgorithm const pAlgorithm, const pandora::Vertex const pNeutrinoVertex, NeutrinoHierarchyAlgorithm::PfoInfoMap &pfoInfoMap)
	Run the algorithm tool. More...

Private Member Functions
bool	IsCloseToParentEndpoint (const pandora::CartesianVector &parentEndpoint, const pandora::Cluster const pParentCluster3D, const pandora::Cluster const pDaughterCluster3D) const
	Whether a daughter 3D cluster is in close proximity to the endpoint of a parent 3D cluster. More...

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

Private Attributes
float	m_minNeutrinoVertexDistance
	Min distance between candidate parent endpoint and neutrino vertex. More...

float	m_minVertexLongitudinalDistance
	Vertex association check: min longitudinal distance cut. More...

float	m_maxVertexLongitudinalDistance
	Vertex association check: max longitudinal distance cut. More...

float	m_maxVertexTransverseDistance
	Vertex association check: max transverse distance cut. More...

float	m_vertexAngularAllowance
	Vertex association check: pointing angular allowance in degrees. More...

float	m_maxParentEndpointDistance
	Max distance between candidate parent endpoint and candidate daughter. More...

Detailed Description

EndAssociatedPfosTool class.

Definition at line 21 of file EndAssociatedPfosTool.h.

Constructor & Destructor Documentation

lar_content::EndAssociatedPfosTool::EndAssociatedPfosTool ( )

Default constructor.

Definition at line 26 of file EndAssociatedPfosTool.cc.

                                              :
     m_minNeutrinoVertexDistance(5.f),
     m_minVertexLongitudinalDistance(-2.5f),
     m_maxVertexLongitudinalDistance(20.f),
     m_maxVertexTransverseDistance(3.5f),
     m_vertexAngularAllowance(3.f),
     m_maxParentEndpointDistance(2.5f)
 {
 }

Member Function Documentation

bool lar_content::EndAssociatedPfosTool::IsCloseToParentEndpoint	(	const pandora::CartesianVector &	parentEndpoint,
		const pandora::Cluster *const	pParentCluster3D,
		const pandora::Cluster *const	pDaughterCluster3D
	)		const

private

Whether a daughter 3D cluster is in close proximity to the endpoint of a parent 3D cluster.

Parameters

parentEndpoint	the parent endpoint position
pParentCluster3D	the address of the parent 3D cluster
pDaughterCluster3D	the address of the daughter 3D cluster

Returns: boolean

Definition at line 103 of file EndAssociatedPfosTool.cc.

References f, lar_content::LArClusterHelper::GetClosestPositions(), and m_maxParentEndpointDistance.

Referenced by Run().

 {
     try
     {
         CartesianVector parentPosition3D(0.f, 0.f, 0.f), daughterPosition3D(0.f, 0.f, 0.f);
         LArClusterHelper::GetClosestPositions(pParentCluster3D, pDaughterCluster3D, parentPosition3D, daughterPosition3D);
 
         if (((parentPosition3D - parentEndpoint).GetMagnitude() < m_maxParentEndpointDistance) &&
             ((parentPosition3D - daughterPosition3D).GetMagnitude() < m_maxParentEndpointDistance))
             return true;
     }
     catch (const StatusCodeException &)
     {
     }
 
     return false;
 }

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

private

Definition at line 124 of file EndAssociatedPfosTool.cc.

References m_maxParentEndpointDistance, m_maxVertexLongitudinalDistance, m_maxVertexTransverseDistance, m_minNeutrinoVertexDistance, m_minVertexLongitudinalDistance, and m_vertexAngularAllowance.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinNeutrinoVertexDistance", m_minNeutrinoVertexDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinVertexLongitudinalDistance", m_minVertexLongitudinalDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxVertexLongitudinalDistance", m_maxVertexLongitudinalDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxVertexTransverseDistance", m_maxVertexTransverseDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VertexAngularAllowance", m_vertexAngularAllowance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxParentEndpointDistance", m_maxParentEndpointDistance));
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::EndAssociatedPfosTool::Run	(	const NeutrinoHierarchyAlgorithm *const	pAlgorithm,
		const pandora::Vertex *const	pNeutrinoVertex,
		NeutrinoHierarchyAlgorithm::PfoInfoMap &	pfoInfoMap
	)

virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
pNeutrinoVertex	the address of the three dimensional neutrino interaction vertex
pfoInfoMap	mapping from pfos to three dimensional clusters, sliding fits, vertices, etc.

Implements lar_content::PfoRelationTool.

Definition at line 38 of file EndAssociatedPfosTool.cc.

References IsCloseToParentEndpoint(), lar_content::LArPointingClusterHelper::IsEmission(), lar_content::LArPointingClusterHelper::IsNode(), m_maxVertexLongitudinalDistance, m_maxVertexTransverseDistance, m_minNeutrinoVertexDistance, m_minVertexLongitudinalDistance, m_vertexAngularAllowance, and lar_content::NeutrinoHierarchyAlgorithm::SeparatePfos().

 {
     if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
         std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     bool associationsMade(true);
 
     while (associationsMade)
     {
         associationsMade = false;
         PfoVector assignedPfos, unassignedPfos;
         pAlgorithm->SeparatePfos(pfoInfoMap, assignedPfos, unassignedPfos);
 
         if (unassignedPfos.empty())
             break;
 
         // ATTN May want to reconsider precise association mechanics for complex situations
         PfoSet recentlyAssigned;
 
         for (const ParticleFlowObject *const pParentPfo : assignedPfos)
         {
             PfoInfo *const pParentPfoInfo(pfoInfoMap.at(pParentPfo));
             const LArPointingCluster parentPointingCluster(*(pParentPfoInfo->GetSlidingFitResult3D()));
 
             const LArPointingCluster::Vertex &parentEndpoint(
                 pParentPfoInfo->IsInnerLayerAssociated() ? parentPointingCluster.GetOuterVertex() : parentPointingCluster.GetInnerVertex());
             const float neutrinoVertexDistance((parentEndpoint.GetPosition() - pNeutrinoVertex->GetPosition()).GetMagnitude());
 
             if (neutrinoVertexDistance < m_minNeutrinoVertexDistance)
                 continue;
 
             for (const ParticleFlowObject *const pPfo : unassignedPfos)
             {
                 if (recentlyAssigned.count(pPfo))
                     continue;
 
                 PfoInfo *const pPfoInfo(pfoInfoMap.at(pPfo));
 
                 const LArPointingCluster pointingCluster(*(pPfoInfo->GetSlidingFitResult3D()));
                 const bool useInner((pointingCluster.GetInnerVertex().GetPosition() - parentEndpoint.GetPosition()).GetMagnitudeSquared() <
                     (pointingCluster.GetOuterVertex().GetPosition() - parentEndpoint.GetPosition()).GetMagnitudeSquared());
 
                 const LArPointingCluster::Vertex &daughterVertex(useInner ? pointingCluster.GetInnerVertex() : pointingCluster.GetOuterVertex());
 
                 if (LArPointingClusterHelper::IsNode(parentEndpoint.GetPosition(), daughterVertex, m_minVertexLongitudinalDistance, m_maxVertexTransverseDistance) ||
                     LArPointingClusterHelper::IsNode(daughterVertex.GetPosition(), parentEndpoint, m_minVertexLongitudinalDistance, m_maxVertexTransverseDistance) ||
                     LArPointingClusterHelper::IsEmission(parentEndpoint.GetPosition(), daughterVertex, m_minVertexLongitudinalDistance,
                         m_maxVertexLongitudinalDistance, m_maxVertexTransverseDistance, m_vertexAngularAllowance) ||
                     LArPointingClusterHelper::IsEmission(daughterVertex.GetPosition(), parentEndpoint, m_minVertexLongitudinalDistance,
                         m_maxVertexLongitudinalDistance, m_maxVertexTransverseDistance, m_vertexAngularAllowance) ||
                     this->IsCloseToParentEndpoint(parentEndpoint.GetPosition(), pParentPfoInfo->GetCluster3D(), pPfoInfo->GetCluster3D()))
                 {
                     associationsMade = true;
                     pParentPfoInfo->AddDaughterPfo(pPfoInfo->GetThisPfo());
                     pPfoInfo->SetParentPfo(pParentPfoInfo->GetThisPfo());
                     pPfoInfo->SetInnerLayerAssociation(useInner);
                     recentlyAssigned.insert(pPfoInfo->GetThisPfo());
                 }
             }
         }
     }
 }

Member Data Documentation

float lar_content::EndAssociatedPfosTool::m_maxParentEndpointDistance

private

Max distance between candidate parent endpoint and candidate daughter.

Definition at line 52 of file EndAssociatedPfosTool.h.

Referenced by IsCloseToParentEndpoint(), and ReadSettings().

float lar_content::EndAssociatedPfosTool::m_maxVertexLongitudinalDistance

private

Vertex association check: max longitudinal distance cut.

Definition at line 49 of file EndAssociatedPfosTool.h.

Referenced by ReadSettings(), and Run().

float lar_content::EndAssociatedPfosTool::m_maxVertexTransverseDistance

private

Vertex association check: max transverse distance cut.

Definition at line 50 of file EndAssociatedPfosTool.h.

Referenced by ReadSettings(), and Run().

float lar_content::EndAssociatedPfosTool::m_minNeutrinoVertexDistance

private

Min distance between candidate parent endpoint and neutrino vertex.

Definition at line 47 of file EndAssociatedPfosTool.h.

Referenced by ReadSettings(), and Run().

float lar_content::EndAssociatedPfosTool::m_minVertexLongitudinalDistance

private

Vertex association check: min longitudinal distance cut.

Definition at line 48 of file EndAssociatedPfosTool.h.

Referenced by ReadSettings(), and Run().

float lar_content::EndAssociatedPfosTool::m_vertexAngularAllowance

private

Vertex association check: pointing angular allowance in degrees.

Definition at line 51 of file EndAssociatedPfosTool.h.

Referenced by ReadSettings(), and Run().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArEventBuilding/EndAssociatedPfosTool.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArEventBuilding/EndAssociatedPfosTool.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation