lar_content::AmbiguousDeltaRayTool Class Reference

AmbiguousDeltaRayTool class. More...

#include "AmbiguousDeltaRayTool.h"

Inheritance diagram for lar_content::AmbiguousDeltaRayTool:

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

Public Member Functions
	AmbiguousDeltaRayTool ()
	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)
void	ExamineConnectedElements (TensorType &overlapTensor) const
	Identify ambiguous matches (e.g. 3:2:1) and, if possible, create pfos out of the best 1:1:1 cluster match. More...
void	PickOutGoodMatches (const TensorType::ElementList &elementList, pandora::ClusterSet &usedClusters, ProtoParticleVector &protoParticleVector) const
	Identify the best 1:1:1 match in a group of connected elements and from it create a pfo. More...

Private Attributes
float	m_maxGoodMatchReducedChiSquared
	The maximum reduced chi squared value of a good 1:1:1 match. More...

Detailed Description

AmbiguousDeltaRayTool class.

Definition at line 18 of file AmbiguousDeltaRayTool.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::AmbiguousDeltaRayTool::AmbiguousDeltaRayTool

(

)

Default constructor.

Definition at line 18 of file AmbiguousDeltaRayTool.cc.

                                             :
    m_maxGoodMatchReducedChiSquared(1.f)
{
}

Member Function Documentation

void lar_content::AmbiguousDeltaRayTool::ExamineConnectedElements ( TensorType &  overlapTensor ) const

private

Identify ambiguous matches (e.g. 3:2:1) and, if possible, create pfos out of the best 1:1:1 cluster match.

Parameters

overlapTensor

the overlap tensor

Definition at line 40 of file AmbiguousDeltaRayTool.cc.

References lar_content::NViewDeltaRayMatchingAlgorithm< T >::CreatePfos(), lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), lar_content::DeltaRayTensorTool::m_pParentAlgorithm, and PickOutGoodMatches().

Referenced by Run().

{
    ClusterVector sortedKeyClusters;
    overlapTensor.GetSortedKeyClusters(sortedKeyClusters);

    ClusterSet usedClusters;
    ClusterSet usedKeyClusters;
    ProtoParticleVector protoParticleVector;

    for (const Cluster *const pKeyCluster : sortedKeyClusters)
    {
        if (usedKeyClusters.count(pKeyCluster))
            continue;

        TensorType::ElementList elementList;
        overlapTensor.GetConnectedElements(pKeyCluster, true, elementList);

        for (const TensorType::Element &element : elementList)
            usedKeyClusters.insert(element.GetClusterU());

        if (elementList.size() < 2)
            continue;

        this->PickOutGoodMatches(elementList, usedClusters, protoParticleVector);
    }

    if (!protoParticleVector.empty())
        m_pParentAlgorithm->CreatePfos(protoParticleVector);
}

void lar_content::AmbiguousDeltaRayTool::PickOutGoodMatches ( const TensorType::ElementList &  elementList, pandora::ClusterSet &  usedClusters, ProtoParticleVector &  protoParticleVector  ) const

private

Identify the best 1:1:1 match in a group of connected elements and from it create a pfo.

Parameters

elementList	the tensor element list
usedClusters	the output list of clusters contained within to be created pfos
protoParticleVector	the output vector of ProtoParticles

Definition at line 72 of file AmbiguousDeltaRayTool.cc.

References lar_content::ProtoParticle::m_clusterList, and m_maxGoodMatchReducedChiSquared.

Referenced by ExamineConnectedElements().

{
    bool found(false);

    do
    {
        found = false;

        unsigned int highestHitCount(0);
        float bestChiSquared(std::numeric_limits<float>::max());
        const Cluster *pBestClusterU(nullptr), *pBestClusterV(nullptr), *pBestClusterW(nullptr);

        for (const TensorType::Element &element : elementList)
        {
            const Cluster *const pClusterU(element.GetClusterU()), *const pClusterV(element.GetClusterV()), *const pClusterW(element.GetClusterW());

            if (usedClusters.count(pClusterU) || usedClusters.count(pClusterV) || usedClusters.count(pClusterW))
                continue;

            const float chiSquared(element.GetOverlapResult().GetReducedChi2());

            if (chiSquared > m_maxGoodMatchReducedChiSquared)
                continue;

            const unsigned int hitSum(pClusterU->GetNCaloHits() + pClusterV->GetNCaloHits() + pClusterW->GetNCaloHits());

            if ((hitSum > highestHitCount) || ((hitSum == highestHitCount) && (chiSquared < bestChiSquared)))
            {
                bestChiSquared = chiSquared;
                highestHitCount = hitSum;
                pBestClusterU = pClusterU;
                pBestClusterV = pClusterV;
                pBestClusterW = pClusterW;
            }
        }

        if (pBestClusterU && pBestClusterV && pBestClusterW)
        {
            found = true;
            usedClusters.insert(pBestClusterU);
            usedClusters.insert(pBestClusterV);
            usedClusters.insert(pBestClusterW);

            ProtoParticle protoParticle;
            protoParticle.m_clusterList.push_back(pBestClusterU);
            protoParticle.m_clusterList.push_back(pBestClusterV);
            protoParticle.m_clusterList.push_back(pBestClusterW);
            protoParticleVector.push_back(protoParticle);
        }
    } while (found);
}

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

private

Definition at line 127 of file AmbiguousDeltaRayTool.cc.

References m_maxGoodMatchReducedChiSquared.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MaxGoodMatchReducedChiSquared", m_maxGoodMatchReducedChiSquared));

    return STATUS_CODE_SUCCESS;
}

bool lar_content::AmbiguousDeltaRayTool::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 25 of file AmbiguousDeltaRayTool.cc.

References ExamineConnectedElements(), 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;

    this->ExamineConnectedElements(overlapTensor);

    // ATTN: Prevent tensor tool loop running again
    return false;
}

Member Data Documentation

float lar_content::AmbiguousDeltaRayTool::m_maxGoodMatchReducedChiSquared

private

The maximum reduced chi squared value of a good 1:1:1 match.

Definition at line 46 of file AmbiguousDeltaRayTool.h.

Referenced by PickOutGoodMatches(), 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(), ExamineConnectedElements(), lar_content::UnambiguousDeltaRayTool::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(), Run(), lar_content::UnambiguousDeltaRayTool::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/AmbiguousDeltaRayTool.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArCosmicRay/AmbiguousDeltaRayTool.cc