lar_content::UnambiguousDeltaRayTool Class Reference

UnambiguousDeltaRayTool class. More...

#include "UnambiguousDeltaRayTool.h"

Inheritance diagram for lar_content::UnambiguousDeltaRayTool:

Public Types
typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType
typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

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

Public Attributes
ThreeViewDeltaRayMatchingAlgorithm *	m_pParentAlgorithm
	Address of the parent matching algorithm. More...

Private Member Functions
bool	Run (ThreeViewDeltaRayMatchingAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
bool	ExamineUnambiguousElements (TensorType::ElementList &elementList)
	Create delta ray pfos out of unambiguous (1:1:1) matches that are connected to a parent cosmic ray. More...
bool	IsConnected (const TensorType::Element &element) const
	Determine whether the clusters of an element are connected to a cosmic ray pfo. More...

Private Attributes
float	m_maxSeparation
	The maximum separation between a connected delta ray cluster and a cosmic ray cluster. More...
unsigned int	m_minNConnectedClusters
	The threshold number of connected delta ray clusters required for particle creation. More...

Detailed Description

UnambiguousDeltaRayTool class.

Definition at line 18 of file UnambiguousDeltaRayTool.h.

Member Typedef Documentation

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::DeltaRayTensorTool::IteratorList

inherited

Definition at line 102 of file ThreeViewDeltaRayMatchingAlgorithm.h.

typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType lar_content::DeltaRayTensorTool::TensorType

inherited

Definition at line 101 of file ThreeViewDeltaRayMatchingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::UnambiguousDeltaRayTool::UnambiguousDeltaRayTool

(

)

Default constructor.

Definition at line 21 of file UnambiguousDeltaRayTool.cc.

                                                 :
    m_maxSeparation(2.f),
    m_minNConnectedClusters(1)
{
}

Member Function Documentation

bool lar_content::UnambiguousDeltaRayTool::ExamineUnambiguousElements ( TensorType::ElementList &  elementList )

private

Create delta ray pfos out of unambiguous (1:1:1) matches that are connected to a parent cosmic ray.

Parameters

elementList

the tensor element list

Returns

whether any delta ray pfos were created

Definition at line 44 of file UnambiguousDeltaRayTool.cc.

References lar_content::NViewDeltaRayMatchingAlgorithm< T >::CreatePfos(), IsConnected(), lar_content::ProtoParticle::m_clusterList, and lar_content::DeltaRayTensorTool::m_pParentAlgorithm.

Referenced by Run().

{
    ProtoParticleVector protoParticleVector;

    for (TensorType::Element &element : elementList)
    {
        if (!this->IsConnected(element))
            continue;

        ProtoParticle protoParticle;
        protoParticle.m_clusterList.push_back(element.GetClusterU());
        protoParticle.m_clusterList.push_back(element.GetClusterV());
        protoParticle.m_clusterList.push_back(element.GetClusterW());
        protoParticleVector.push_back(protoParticle);
    }

    return m_pParentAlgorithm->CreatePfos(protoParticleVector);
}

bool lar_content::UnambiguousDeltaRayTool::IsConnected ( const TensorType::Element &  element ) const

private

Determine whether the clusters of an element are connected to a cosmic ray pfo.

Parameters

elementList

the tensor element

Returns

whether the clusters are connected to a cosmic ray pfo

Definition at line 65 of file UnambiguousDeltaRayTool.cc.

References lar_content::LArClusterHelper::GetClosestDistance(), lar_content::LArPfoHelper::GetClusters(), m_maxSeparation, and m_minNConnectedClusters.

Referenced by ExamineUnambiguousElements().

{
    PfoList commonMuonPfoList(element.GetOverlapResult().GetCommonMuonPfoList());

    for (const ParticleFlowObject *const pMuonPfo : commonMuonPfoList)
    {
        unsigned int connectedClusterCount(0);

        for (const HitType hitType : {TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W})
        {
            ClusterList muonClusterList;
            LArPfoHelper::GetClusters(pMuonPfo, hitType, muonClusterList);

            const float separation(LArClusterHelper::GetClosestDistance(element.GetCluster(hitType), muonClusterList));

            if (separation < m_maxSeparation)
                ++connectedClusterCount;
        }

        if (connectedClusterCount > m_minNConnectedClusters)
            return true;
    }

    return false;
}

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

private

Definition at line 93 of file UnambiguousDeltaRayTool.cc.

References m_maxSeparation, and m_minNConnectedClusters.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinSeparation", m_maxSeparation));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinNConnectedClusters", m_minNConnectedClusters));

    return STATUS_CODE_SUCCESS;
}

bool lar_content::UnambiguousDeltaRayTool::Run ( ThreeViewDeltaRayMatchingAlgorithm *const  pAlgorithm, TensorType &  overlapTensor  )

privatevirtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns

whether changes have been made by the tool

Implements lar_content::DeltaRayTensorTool.

Definition at line 29 of file UnambiguousDeltaRayTool.cc.

References ExamineUnambiguousElements(), lar_content::OverlapTensor< T >::GetUnambiguousElements(), and lar_content::DeltaRayTensorTool::m_pParentAlgorithm.

{
    m_pParentAlgorithm = pAlgorithm;

    if (PandoraContentApi::GetSettings(*m_pParentAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;

    TensorType::ElementList elementList;
    overlapTensor.GetUnambiguousElements(true, elementList);

    return this->ExamineUnambiguousElements(elementList);
}

Member Data Documentation

float lar_content::UnambiguousDeltaRayTool::m_maxSeparation

private

The maximum separation between a connected delta ray cluster and a cosmic ray cluster.

Definition at line 48 of file UnambiguousDeltaRayTool.h.

Referenced by IsConnected(), and ReadSettings().

unsigned int lar_content::UnambiguousDeltaRayTool::m_minNConnectedClusters

private

The threshold number of connected delta ray clusters required for particle creation.

Definition at line 49 of file UnambiguousDeltaRayTool.h.

Referenced by IsConnected(), and ReadSettings().

ThreeViewDeltaRayMatchingAlgorithm* lar_content::DeltaRayTensorTool::m_pParentAlgorithm

inherited

Address of the parent matching algorithm.

Definition at line 114 of file ThreeViewDeltaRayMatchingAlgorithm.h.

Referenced by lar_content::CosmicRayRemovalTool::CreateSeed(), lar_content::AmbiguousDeltaRayTool::ExamineConnectedElements(), ExamineUnambiguousElements(), lar_content::CosmicRayRemovalTool::GrowSeed(), lar_content::DeltaRayRemovalTool::IsContaminated(), lar_content::CosmicRayRemovalTool::IsContaminated(), lar_content::RemovalBaseTool::IsMuonEndpoint(), lar_content::DeltaRayMergeTool::MakeOneCommonViewMerges(), lar_content::DeltaRayMergeTool::MakeTwoCommonViewMerges(), lar_content::RemovalBaseTool::PassElementChecks(), lar_content::RemovalBaseTool::ProjectDeltaRayPositions(), lar_content::CosmicRayRemovalTool::ReclusterRemnant(), lar_content::DeltaRayRemovalTool::RemoveDeltaRayHits(), lar_content::AmbiguousDeltaRayTool::Run(), Run(), lar_content::DeltaRayMergeTool::Run(), lar_content::DeltaRayRemovalTool::Run(), lar_content::CosmicRayRemovalTool::Run(), lar_content::CosmicRayRemovalTool::SplitDeltaRayCluster(), and lar_content::DeltaRayRemovalTool::SplitMuonCluster().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArCosmicRay/UnambiguousDeltaRayTool.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArCosmicRay/UnambiguousDeltaRayTool.cc