lar_content::CheatingClusterMergingAlgorithm Class Reference

CheatingClusterMergingAlgorithm class. More...

#include "CheatingClusterMergingAlgorithm.h"

Inheritance diagram for lar_content::CheatingClusterMergingAlgorithm:

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

Private Member Functions
pandora::StatusCode	Run ()
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
void	CheatedClusterMerging (const pandora::ClusterList *const pClusterList, const std::string &listName) const
	Cheated Cluster Merging. Use MC to match clusters based on the main MC particle. More...
const pandora::MCParticle *	GetMCForCluster (const pandora::Cluster *const cluster, std::map< const pandora::Cluster *, const pandora::MCParticle * > &clusterToMCMap) const
	Get the MC particle for a given cluster, caching to a map. More...
bool	IsValidToUse (const pandora::Cluster *const cluster, std::map< const pandora::Cluster *, bool > &clusterIsUsed) const
	If a cluster is valid to use: Is a shower tagged cluster, and not been used yet. More...

Private Attributes
pandora::StringVector	m_inputClusterListNames
	The names of the input cluster lists. More...
std::string	m_mcParticleListName
	Input MC particle list name. More...
float	m_minNCaloHits
	The minimum number of hits for a cluster to be deemed true for IsAvailableToUse. More...

Detailed Description

CheatingClusterMergingAlgorithm class.

Definition at line 20 of file CheatingClusterMergingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::CheatingClusterMergingAlgorithm::CheatingClusterMergingAlgorithm

(

)

Default constructor.

Definition at line 26 of file CheatingClusterMergingAlgorithm.cc.

                                                                 :
    m_minNCaloHits(1)
{
}

Member Function Documentation

void lar_content::CheatingClusterMergingAlgorithm::CheatedClusterMerging ( const pandora::ClusterList *const  pClusterList, const std::string &  listName  ) const

private

Cheated Cluster Merging. Use MC to match clusters based on the main MC particle.

Parameters

pClusterList	the list of clusters
listName	the name of the current cluster list (ClustersU, ClustersV, ClustersW normally)

Definition at line 101 of file CheatingClusterMergingAlgorithm.cc.

References GetMCForCluster(), and IsValidToUse().

Referenced by Run().

{
    std::map<const Cluster *, const MCParticle *> clusterToMCParticleMap;
    std::map<const Cluster *, bool> clusterIsUsed;
    std::map<const Cluster *, ClusterVector> clustersToMerge;

    for (auto it = pClusterList->begin(); it != pClusterList->end(); ++it)
    {
        const Cluster *cluster(*it);

        if (!this->IsValidToUse(cluster, clusterIsUsed))
            continue;

        const MCParticle *clusterMC(this->GetMCForCluster(cluster, clusterToMCParticleMap));

        for (auto it2 = std::next(it); it2 != pClusterList->end(); ++it2)
        {
            const Cluster *const otherCluster(*it2);

            if (!this->IsValidToUse(otherCluster, clusterIsUsed))
                continue;

            const MCParticle *otherClusterMC(this->GetMCForCluster(otherCluster, clusterToMCParticleMap));

            if (clusterMC == otherClusterMC)
            {
                clusterIsUsed[cluster] = true;
                clusterIsUsed[otherCluster] = true;
                clustersToMerge[cluster].emplace_back(otherCluster);
            }
        }
    }

    for (auto clusterToMergePair : clustersToMerge)
    {
        const Cluster *currentCluster{clusterToMergePair.first};
        const auto clusters{clusterToMergePair.second};

        for (auto clusterToMerge : clusters)
        {
            if (!clusterToMerge->IsAvailable())
                continue;

            try
            {
                PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                    PandoraContentApi::MergeAndDeleteClusters(*this, currentCluster, clusterToMerge, listName, listName));
            }
            catch (StatusCodeException)
            {
            }
        }
    }
}

const MCParticle * lar_content::CheatingClusterMergingAlgorithm::GetMCForCluster ( const pandora::Cluster *const  cluster, std::map< const pandora::Cluster *, const pandora::MCParticle * > &  clusterToMCMap  ) const

private

Get the MC particle for a given cluster, caching to a map.

Parameters

cluster	The current cluster to lookup
clusterToMCMap	Map from Cluster to MC to cache results.

Definition at line 59 of file CheatingClusterMergingAlgorithm.cc.

References e.

Referenced by CheatedClusterMerging().

{
    const MCParticle *clusterMC{nullptr};

    if (clusterToMCMap.count(cluster) > 0)
    {
        clusterMC = clusterToMCMap.at(cluster);
    }
    else
    {
        try
        {
            clusterMC = MCParticleHelper::GetMainMCParticle(cluster);
            clusterToMCMap[cluster] = clusterMC;
        }
        catch (StatusCodeException e)
        {
            std::cout << "Failed to get MC particle for cluster of " << cluster->GetOrderedCaloHitList().size() << " : " << e.ToString() << std::endl;
        }
    }
    return clusterMC;
}

bool lar_content::CheatingClusterMergingAlgorithm::IsValidToUse ( const pandora::Cluster *const  cluster, std::map< const pandora::Cluster *, bool > &  clusterIsUsed  ) const

private

If a cluster is valid to use: Is a shower tagged cluster, and not been used yet.

Parameters

cluster	The current cluster to lookup
clusterIsUsed	Map from Cluster to bool to check if a cluster has been used yet.

Definition at line 85 of file CheatingClusterMergingAlgorithm.cc.

References m_minNCaloHits.

Referenced by CheatedClusterMerging().

{
    if (!cluster->IsAvailable())
        return false;

    if (cluster->GetNCaloHits() < m_minNCaloHits)
        return false;

    if (clusterIsUsed.count(cluster) > 0)
        return false;

    return true;
}

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

private

Definition at line 158 of file CheatingClusterMergingAlgorithm.cc.

References m_inputClusterListNames, m_mcParticleListName, and m_minNCaloHits.

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "InputClusterListNames", m_inputClusterListNames));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MCParticleListName", m_mcParticleListName));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinNCaloHits", m_minNCaloHits));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::CheatingClusterMergingAlgorithm::Run ( )

private

Definition at line 32 of file CheatingClusterMergingAlgorithm.cc.

References CheatedClusterMerging(), and m_inputClusterListNames.

{
    for (const std::string &clusterListName : m_inputClusterListNames)
    {
        try
        {
            const ClusterList *pClusterList{nullptr};
            PANDORA_RETURN_RESULT_IF_AND_IF(
                STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, clusterListName, pClusterList));

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

                continue;
            }
            this->CheatedClusterMerging(pClusterList, clusterListName);
        }
        catch (StatusCodeException &statusCodeException)
        {
            throw statusCodeException;
        }
    }
    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

pandora::StringVector lar_content::CheatingClusterMergingAlgorithm::m_inputClusterListNames

private

The names of the input cluster lists.

Definition at line 57 of file CheatingClusterMergingAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::CheatingClusterMergingAlgorithm::m_mcParticleListName

private

Input MC particle list name.

Definition at line 58 of file CheatingClusterMergingAlgorithm.h.

Referenced by ReadSettings().

float lar_content::CheatingClusterMergingAlgorithm::m_minNCaloHits

private

The minimum number of hits for a cluster to be deemed true for IsAvailableToUse.

Definition at line 59 of file CheatingClusterMergingAlgorithm.h.

Referenced by IsValidToUse(), and ReadSettings().

---

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

• larpandoracontent/v04_14_00/source/larpandoracontent/LArCheating/CheatingClusterMergingAlgorithm.h
• larpandoracontent/v04_14_00/source/larpandoracontent/LArCheating/CheatingClusterMergingAlgorithm.cc