lar_content::DeltaRayGrowingAlgorithm Class Reference

DeltaRayGrowingAlgorithm class. More...

#include "DeltaRayGrowingAlgorithm.h"

Inheritance diagram for lar_content::DeltaRayGrowingAlgorithm:

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

Protected Types
typedef std::unordered_map< const pandora::Cluster *, pandora::ClusterList >	ClusterMergeMap

Protected Member Functions
virtual pandora::StatusCode	Run ()

Private Member Functions
void	GetListOfCleanClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &cleanClusters) const
	Populate cluster vector with the subset of clusters judged to be clean. More...
void	GetListOfSeedClusters (const pandora::ClusterVector &inputClusters, pandora::ClusterVector &seedClusters) const
	Select seed clusters for growing. More...
void	GetPfos (const std::string inputPfoListName, pandora::PfoVector &pfoVector) const
	Get a vector of Pfos from an input Pfo list name. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
std::string	m_parentPfoListName
	The parent Pfo list name. More...
std::string	m_daughterPfoListName
	The daughter Pfo list name. More...
unsigned int	m_minCaloHitsPerCluster
	The minimum number of calo hits per candidate cluster. More...
unsigned int	m_minSeedClusterCaloHits
	The minimum number of calo hits for seed clusters. More...
float	m_maxSeedClusterLength
	The maximum length of a parent clusters. More...
float	m_maxSeedClusterDisplacement
	The maximum distance between parent and daughter clusters. More...

Detailed Description

DeltaRayGrowingAlgorithm class.

Definition at line 21 of file DeltaRayGrowingAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::Cluster *, pandora::ClusterList> lar_content::ClusterGrowingAlgorithm::ClusterMergeMap

protectedinherited

Definition at line 33 of file ClusterGrowingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::DeltaRayGrowingAlgorithm::DeltaRayGrowingAlgorithm

(

)

Default constructor.

Definition at line 21 of file DeltaRayGrowingAlgorithm.cc.

                                                   :
    m_minCaloHitsPerCluster(2),
    m_minSeedClusterCaloHits(5),
    m_maxSeedClusterLength(10.f),
    m_maxSeedClusterDisplacement(1.5f)
{
}

Member Function Documentation

void lar_content::DeltaRayGrowingAlgorithm::GetListOfCleanClusters ( const pandora::ClusterList *const  pClusterList, pandora::ClusterVector &  cleanClusters  ) const

privatevirtual

Populate cluster vector with the subset of clusters judged to be clean.

Parameters

pClusterList	address of the cluster list
cleanClusters	the output vector of clean clusters

Implements lar_content::ClusterGrowingAlgorithm.

Definition at line 31 of file DeltaRayGrowingAlgorithm.cc.

References m_minCaloHitsPerCluster, and lar_content::LArClusterHelper::SortByNHits().

{
    for (const Cluster *const pCluster : *pClusterList)
    {
        if (!pCluster->IsAvailable() || (pCluster->GetNCaloHits() < m_minCaloHitsPerCluster))
            continue;

        clusterVector.push_back(pCluster);
    }

    std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByNHits);
}

void lar_content::DeltaRayGrowingAlgorithm::GetListOfSeedClusters ( const pandora::ClusterVector &  cleanClusters, pandora::ClusterVector &  seedClusters  ) const

privatevirtual

Select seed clusters for growing.

Parameters

cleanClusters	the input vector of clean clusters
seedClusters	the output vector of seed clusters

Implements lar_content::ClusterGrowingAlgorithm.

Definition at line 46 of file DeltaRayGrowingAlgorithm.cc.

References lar_content::LArClusterHelper::GetClosestDistance(), lar_content::LArClusterHelper::GetClusterHitType(), lar_content::LArPfoHelper::GetClusters(), lar_content::LArClusterHelper::GetLengthSquared(), GetPfos(), m_daughterPfoListName, m_maxSeedClusterDisplacement, m_maxSeedClusterLength, m_minSeedClusterCaloHits, m_parentPfoListName, and lar_content::LArClusterHelper::SortByNHits().

{
    if (inputClusters.empty())
        return;

    const HitType clusterHitType(LArClusterHelper::GetClusterHitType(inputClusters.front()));

    // Get parent and daughter Pfos
    PfoVector parentPfos, daughterPfos;
    this->GetPfos(m_parentPfoListName, parentPfos);
    this->GetPfos(m_daughterPfoListName, daughterPfos);

    ClusterList parentClusters, daughterClusters;

    for (const Pfo *const pParentPfo : parentPfos)
        LArPfoHelper::GetClusters(pParentPfo, clusterHitType, parentClusters);

    for (const Pfo *const pDaughterPfo : daughterPfos)
        LArPfoHelper::GetClusters(pDaughterPfo, clusterHitType, daughterClusters);

    // Select short parent clusters
    for (const Cluster *const pCluster : parentClusters)
    {
        if (LArClusterHelper::GetLengthSquared(pCluster) < m_maxSeedClusterLength * m_maxSeedClusterLength)
            seedClusters.push_back(pCluster);
    }

    // Select all secondary clusters
    for (const Cluster *const pCluster : daughterClusters)
    {
        seedClusters.push_back(pCluster);
    }

    // Select other possible delta rays
    for (const Cluster *const pCluster : inputClusters)
    {
        if (pCluster->GetNCaloHits() < m_minSeedClusterCaloHits)
            continue;

        const float parentDistance(
            parentClusters.empty() ? std::numeric_limits<float>::max() : LArClusterHelper::GetClosestDistance(pCluster, parentClusters));

        if (parentDistance > m_maxSeedClusterDisplacement)
            continue;

        const float daughterDistance(
            daughterClusters.empty() ? std::numeric_limits<float>::max() : LArClusterHelper::GetClosestDistance(pCluster, daughterClusters));

        if (daughterDistance < m_maxSeedClusterDisplacement)
            continue;

        seedClusters.push_back(pCluster);
    }

    std::sort(seedClusters.begin(), seedClusters.end(), LArClusterHelper::SortByNHits);
}

void lar_content::DeltaRayGrowingAlgorithm::GetPfos ( const std::string  inputPfoListName, pandora::PfoVector &  pfoVector  ) const

private

Get a vector of Pfos from an input Pfo list name.

Parameters

inputPfoListName	the input Pfo list name
pfoVector	the output vector of Pfos

Definition at line 105 of file DeltaRayGrowingAlgorithm.cc.

References lar_content::LArPfoHelper::SortByNHits().

Referenced by GetListOfSeedClusters().

{
    const PfoList *pPfoList(nullptr);
    PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, inputPfoListName, pPfoList));

    if (!pPfoList)
        return;

    for (const Pfo *const pPfo : *pPfoList)
        pfoVector.push_back(pPfo);

    std::sort(pfoVector.begin(), pfoVector.end(), LArPfoHelper::SortByNHits);
}

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

privatevirtual

Reimplemented from lar_content::ClusterGrowingAlgorithm.

Definition at line 121 of file DeltaRayGrowingAlgorithm.cc.

References m_daughterPfoListName, m_maxSeedClusterDisplacement, m_maxSeedClusterLength, m_minCaloHitsPerCluster, m_minSeedClusterCaloHits, m_parentPfoListName, and lar_content::ClusterGrowingAlgorithm::ReadSettings().

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ParentPfoListName", m_parentPfoListName));
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "DaughterPfoListName", m_daughterPfoListName));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinCaloHitsPerCluster", m_minCaloHitsPerCluster));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinSeedClusterCaloHits", m_minSeedClusterCaloHits));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxSeedClusterLength", m_maxSeedClusterLength));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MaxSeedClusterDisplacement", m_maxSeedClusterDisplacement));

    return ClusterGrowingAlgorithm::ReadSettings(xmlHandle);
}

StatusCode lar_content::ClusterGrowingAlgorithm::Run ( )

protectedvirtualinherited

Definition at line 27 of file ClusterGrowingAlgorithm.cc.

References lar_content::ClusterGrowingAlgorithm::GetListOfCleanClusters(), lar_content::ClusterGrowingAlgorithm::GetListOfNonSeedClusters(), lar_content::ClusterGrowingAlgorithm::GetListOfSeedClusters(), lar_content::ClusterGrowingAlgorithm::m_inputClusterListName, lar_content::ClusterGrowingAlgorithm::MergeClusters(), and lar_content::ClusterGrowingAlgorithm::PopulateClusterMergeMap().

{
    const ClusterList *pClusterList = NULL;

    if (m_inputClusterListName.empty())
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pClusterList));
    }
    else
    {
        PANDORA_RETURN_RESULT_IF_AND_IF(
            STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, m_inputClusterListName, pClusterList));
    }

    if (!pClusterList || pClusterList->empty())
    {
        if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
            std::cout << "ClusterGrowingAlgorithm: unable to find cluster list " << m_inputClusterListName << std::endl;

        return STATUS_CODE_SUCCESS;
    }

    ClusterVector inputClusters, seedClusters;
    this->GetListOfCleanClusters(pClusterList, inputClusters);
    this->GetListOfSeedClusters(inputClusters, seedClusters);

    while (true)
    {
        ClusterVector currentClusters, nonSeedClusters;
        this->GetListOfCleanClusters(pClusterList, currentClusters);
        this->GetListOfNonSeedClusters(currentClusters, seedClusters, nonSeedClusters);

        ClusterMergeMap clusterMergeMap;
        this->PopulateClusterMergeMap(seedClusters, nonSeedClusters, clusterMergeMap);

        if (clusterMergeMap.empty())
            break;

        this->MergeClusters(clusterMergeMap);
    }

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

std::string lar_content::DeltaRayGrowingAlgorithm::m_daughterPfoListName

private

The daughter Pfo list name.

Definition at line 44 of file DeltaRayGrowingAlgorithm.h.

Referenced by GetListOfSeedClusters(), and ReadSettings().

float lar_content::DeltaRayGrowingAlgorithm::m_maxSeedClusterDisplacement

private

The maximum distance between parent and daughter clusters.

Definition at line 49 of file DeltaRayGrowingAlgorithm.h.

Referenced by GetListOfSeedClusters(), and ReadSettings().

float lar_content::DeltaRayGrowingAlgorithm::m_maxSeedClusterLength

private

The maximum length of a parent clusters.

Definition at line 48 of file DeltaRayGrowingAlgorithm.h.

Referenced by GetListOfSeedClusters(), and ReadSettings().

unsigned int lar_content::DeltaRayGrowingAlgorithm::m_minCaloHitsPerCluster

private

The minimum number of calo hits per candidate cluster.

Definition at line 46 of file DeltaRayGrowingAlgorithm.h.

Referenced by GetListOfCleanClusters(), and ReadSettings().

unsigned int lar_content::DeltaRayGrowingAlgorithm::m_minSeedClusterCaloHits

private

The minimum number of calo hits for seed clusters.

Definition at line 47 of file DeltaRayGrowingAlgorithm.h.

Referenced by GetListOfSeedClusters(), and ReadSettings().

std::string lar_content::DeltaRayGrowingAlgorithm::m_parentPfoListName

private

The parent Pfo list name.

Definition at line 43 of file DeltaRayGrowingAlgorithm.h.

Referenced by GetListOfSeedClusters(), and ReadSettings().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArCosmicRay/DeltaRayGrowingAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArCosmicRay/DeltaRayGrowingAlgorithm.cc