lar_content::CheatingClusterCreationAlgorithm Class Reference

CheatingClusterCreationAlgorithm class. More...

#include "CheatingClusterCreationAlgorithm.h"

Inheritance diagram for lar_content::CheatingClusterCreationAlgorithm:

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

Private Types
typedef std::unordered_map< const pandora::MCParticle *, pandora::CaloHitList >	MCParticleToHitListMap

Private Member Functions
pandora::StatusCode	Run ()
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
void	GetMCParticleToHitListMap (MCParticleToHitListMap &mcParticleToHitListMap) const
	Create map between each (primary) MC particle and associated calo hits. More...
void	SimpleMCParticleCollection (const pandora::CaloHit *const pCaloHit, const LArMCParticleHelper::MCRelationMap &mcPrimaryMap, MCParticleToHitListMap &mcParticleToHitListMap) const
	Simple mc particle collection, using main mc particle associated with each calo hit. More...
bool	SelectMCParticlesForClustering (const pandora::MCParticle *const pMCParticle) const
	Check whether mc particle is of a type specified for inclusion in cheated clustering. More...
void	CreateClusters (const MCParticleToHitListMap &mcParticleToHitListMap) const
	Create clusters based on information in the mc particle to hit list map. More...

Private Attributes
bool	m_collapseToPrimaryMCParticles
	Whether to collapse mc particle hierarchies to primary particles. More...
std::string	m_mcParticleListName
	The mc particle list name, required if want to collapse mc particle hierarchy. More...
pandora::IntVector	m_particleIdList
	list of particle ids of MCPFOs to be selected More...

Detailed Description

CheatingClusterCreationAlgorithm class.

Definition at line 23 of file CheatingClusterCreationAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::MCParticle *, pandora::CaloHitList> lar_content::CheatingClusterCreationAlgorithm::MCParticleToHitListMap

private

Definition at line 35 of file CheatingClusterCreationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::CheatingClusterCreationAlgorithm::CheatingClusterCreationAlgorithm

(

)

Default constructor.

Definition at line 18 of file CheatingClusterCreationAlgorithm.cc.

                                                                   :
    m_collapseToPrimaryMCParticles(false)
{
}

Member Function Documentation

void lar_content::CheatingClusterCreationAlgorithm::CreateClusters ( const MCParticleToHitListMap &  mcParticleToHitListMap ) const

private

Create clusters based on information in the mc particle to hit list map.

Parameters

mcParticleToHitListMap

the mc particle to hit list map

Definition at line 107 of file CheatingClusterCreationAlgorithm.cc.

References lar_content::LArMCParticleHelper::SortByMomentum().

Referenced by Run().

{
    MCParticleVector mcParticleVector;
    for (const auto &mapEntry : mcParticleToHitListMap)
        mcParticleVector.push_back(mapEntry.first);
    std::sort(mcParticleVector.begin(), mcParticleVector.end(), LArMCParticleHelper::SortByMomentum);

    for (const MCParticle *const pMCParticle : mcParticleVector)
    {
        const CaloHitList &caloHitList(mcParticleToHitListMap.at(pMCParticle));

        if (caloHitList.empty())
            continue;

        const Cluster *pCluster(nullptr);
        PandoraContentApi::Cluster::Parameters parameters;
        parameters.m_caloHitList = caloHitList;
        PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::Create(*this, parameters, pCluster));

        PandoraContentApi::Cluster::Metadata metadata;

        switch (pMCParticle->GetParticleId())
        {
            case PHOTON:
            case E_PLUS:
            case E_MINUS:
            case MU_PLUS:
            case MU_MINUS:
                metadata.m_particleId = pMCParticle->GetParticleId();
                break;
            default:
                break;
        }

        if (metadata.m_particleId.IsInitialized())
            PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::AlterMetadata(*this, pCluster, metadata));
    }
}

void lar_content::CheatingClusterCreationAlgorithm::GetMCParticleToHitListMap ( MCParticleToHitListMap &  mcParticleToHitListMap ) const

private

Create map between each (primary) MC particle and associated calo hits.

Parameters

mcParticleToHitListMap

to receive the mc particle to hit list map

Definition at line 36 of file CheatingClusterCreationAlgorithm.cc.

References lar_content::LArMCParticleHelper::GetMCPrimaryMap(), m_collapseToPrimaryMCParticles, m_mcParticleListName, and SimpleMCParticleCollection().

Referenced by Run().

{
    LArMCParticleHelper::MCRelationMap mcPrimaryMap;

    if (m_collapseToPrimaryMCParticles)
    {
        const MCParticleList *pMCParticleList(nullptr);
        PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_mcParticleListName, pMCParticleList));

        LArMCParticleHelper::GetMCPrimaryMap(pMCParticleList, mcPrimaryMap);
    }

    const CaloHitList *pCaloHitList(nullptr);
    PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pCaloHitList));

    for (const CaloHit *const pCaloHit : *pCaloHitList)
    {
        try
        {
            if (!PandoraContentApi::IsAvailable(*this, pCaloHit))
                continue;

            this->SimpleMCParticleCollection(pCaloHit, mcPrimaryMap, mcParticleToHitListMap);
        }
        catch (const StatusCodeException &)
        {
        }
    }
}

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

private

Definition at line 148 of file CheatingClusterCreationAlgorithm.cc.

References m_collapseToPrimaryMCParticles, m_mcParticleListName, and m_particleIdList.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "CollapseToPrimaryMCParticles", m_collapseToPrimaryMCParticles));

    if (m_collapseToPrimaryMCParticles)
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MCParticleListName", m_mcParticleListName));
    }

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "ParticleIdList", m_particleIdList));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::CheatingClusterCreationAlgorithm::Run ( )

private

Definition at line 25 of file CheatingClusterCreationAlgorithm.cc.

References CreateClusters(), and GetMCParticleToHitListMap().

{
    MCParticleToHitListMap mcParticleToHitListMap;
    this->GetMCParticleToHitListMap(mcParticleToHitListMap);
    this->CreateClusters(mcParticleToHitListMap);

    return STATUS_CODE_SUCCESS;
}

bool lar_content::CheatingClusterCreationAlgorithm::SelectMCParticlesForClustering ( const pandora::MCParticle *const  pMCParticle ) const

private

Check whether mc particle is of a type specified for inclusion in cheated clustering.

Parameters

pMCParticle

the mc particle to hit list map

Returns

boolean

Definition at line 91 of file CheatingClusterCreationAlgorithm.cc.

References m_particleIdList.

Referenced by SimpleMCParticleCollection().

{
    if (m_particleIdList.empty())
        return true;

    for (const int particleId : m_particleIdList)
    {
        if (pMCParticle->GetParticleId() == particleId)
            return true;
    }

    return false;
}

void lar_content::CheatingClusterCreationAlgorithm::SimpleMCParticleCollection ( const pandora::CaloHit *const  pCaloHit, const LArMCParticleHelper::MCRelationMap &  mcPrimaryMap, MCParticleToHitListMap &  mcParticleToHitListMap  ) const

private

Simple mc particle collection, using main mc particle associated with each calo hit.

Parameters

pCaloHit	address of the calo hit
mcPrimaryMap	the mapping between mc particles and their parents
mcParticleToHitListMap	the mc particle to hit list map

Definition at line 68 of file CheatingClusterCreationAlgorithm.cc.

References m_collapseToPrimaryMCParticles, and SelectMCParticlesForClustering().

Referenced by GetMCParticleToHitListMap().

{
    const MCParticle *pMCParticle(MCParticleHelper::GetMainMCParticle(pCaloHit));

    if (!this->SelectMCParticlesForClustering(pMCParticle))
        return;

    if (m_collapseToPrimaryMCParticles)
    {
        LArMCParticleHelper::MCRelationMap::const_iterator primaryIter = mcPrimaryMap.find(pMCParticle);

        if (mcPrimaryMap.end() == primaryIter)
            throw StatusCodeException(STATUS_CODE_NOT_FOUND);

        pMCParticle = primaryIter->second;
    }

    mcParticleToHitListMap[pMCParticle].push_back(pCaloHit);
}

Member Data Documentation

bool lar_content::CheatingClusterCreationAlgorithm::m_collapseToPrimaryMCParticles

private

Whether to collapse mc particle hierarchies to primary particles.

Definition at line 70 of file CheatingClusterCreationAlgorithm.h.

Referenced by GetMCParticleToHitListMap(), ReadSettings(), and SimpleMCParticleCollection().

std::string lar_content::CheatingClusterCreationAlgorithm::m_mcParticleListName

private

The mc particle list name, required if want to collapse mc particle hierarchy.

Definition at line 71 of file CheatingClusterCreationAlgorithm.h.

Referenced by GetMCParticleToHitListMap(), and ReadSettings().

pandora::IntVector lar_content::CheatingClusterCreationAlgorithm::m_particleIdList

private

list of particle ids of MCPFOs to be selected

Definition at line 73 of file CheatingClusterCreationAlgorithm.h.

Referenced by ReadSettings(), and SelectMCParticlesForClustering().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArCheating/CheatingClusterCreationAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArCheating/CheatingClusterCreationAlgorithm.cc