lar_content::LArHierarchyHelper Class Reference

LArHierarchyHelper class. More...

#include <LArHierarchyHelper.h>

Classes
class	FoldingParameters
	FoldingParameters class. More...
class	MatchInfo
	MatcheInfo class. More...
class	MCHierarchy
	MCHierarchy class. More...
class	MCMatches
	MCMatches class. More...
class	QualityCuts
	QualityCuts class. More...
class	RecoHierarchy
	RecoHierarchy class. More...

Public Types
typedef std::vector< MCMatches >	MCMatchesVector

Static Public Member Functions
static void	FillMCHierarchy (const pandora::MCParticleList &mcParticleList, const pandora::CaloHitList &caloHitList, const FoldingParameters &foldParameters, MCHierarchy &hierarchy)
	Fill an MC hierarchy based on the specified folding criteria (see MCHierarchy::FillHierarchy for details) More...
static void	FillRecoHierarchy (const pandora::PfoList &pfoList, const FoldingParameters &foldParameters, RecoHierarchy &hierarchy)
	Fill a reconstructed hierarchy based on the specified folding criteria (see RecoHierarchy::FillHierarchy for details) More...
static void	MatchHierarchies (const MCHierarchy &mcHierarchy, const RecoHierarchy &recoHierarchy, MatchInfo &matchInfo)
	Finds the matches between reconstructed and MC hierarchies. More...

Private Types
typedef std::set< const pandora::MCParticle * >	MCParticleSet
typedef std::set< const pandora::ParticleFlowObject * >	PfoSet

Static Private Member Functions
static const pandora::MCParticle *	GetMCPrimaries (const pandora::MCParticleList &mcParticleList, MCParticleSet &primaries)
	Retrieves the primary MC particles from a list and returns the root (neutrino) for hierarchy, if it exists. More...
static const pandora::ParticleFlowObject *	GetRecoPrimaries (const pandora::PfoList &pfoList, PfoSet &primaries)
	Retrieves the primary PFOs from a list and returns the root (neutrino) for hierarchy, if it exists. More...

Detailed Description

LArHierarchyHelper class.

Definition at line 24 of file LArHierarchyHelper.h.

Member Typedef Documentation

typedef std::vector<MCMatches> lar_content::LArHierarchyHelper::MCMatchesVector

Definition at line 717 of file LArHierarchyHelper.h.

typedef std::set<const pandora::MCParticle *> lar_content::LArHierarchyHelper::MCParticleSet

private

Definition at line 857 of file LArHierarchyHelper.h.

typedef std::set<const pandora::ParticleFlowObject *> lar_content::LArHierarchyHelper::PfoSet

private

Definition at line 858 of file LArHierarchyHelper.h.

Member Function Documentation

void lar_content::LArHierarchyHelper::FillMCHierarchy ( const pandora::MCParticleList &  mcParticleList, const pandora::CaloHitList &  caloHitList, const FoldingParameters &  foldParameters, MCHierarchy &  hierarchy  )

static

Fill an MC hierarchy based on the specified folding criteria (see MCHierarchy::FillHierarchy for details)

Parameters

mcParticleList	The MCParticle list to use to fill this hierarchy
caloHitList	The list of CaloHits to use to fill this hierarchy
foldParameters	The folding parameters to use for the hierarchy
hierarchy	The output MC hierarchy

Definition at line 1401 of file LArHierarchyHelper.cc.

{
    hierarchy.FillHierarchy(mcParticleList, caloHitList, foldParameters);
}

void lar_content::LArHierarchyHelper::FillRecoHierarchy ( const pandora::PfoList &  pfoList, const FoldingParameters &  foldParameters, RecoHierarchy &  hierarchy  )

static

Fill a reconstructed hierarchy based on the specified folding criteria (see RecoHierarchy::FillHierarchy for details)

Parameters

pfoList	The ParticleFlowObject list to use to fill this hierarchy
foldParameters	The folding parameters to use for the hierarchy
hierarchy	The output reconstructed hierarchy

Definition at line 1409 of file LArHierarchyHelper.cc.

{
    hierarchy.FillHierarchy(pfoList, foldParameters);
}

const MCParticle * lar_content::LArHierarchyHelper::GetMCPrimaries ( const pandora::MCParticleList &  mcParticleList, MCParticleSet &  primaries  )

staticprivate

Retrieves the primary MC particles from a list and returns the root (neutrino) for hierarchy, if it exists.

Parameters

mcParticleList	The input list of MC particles
primaries	The output set of primary MC particles

Returns

The root neutrino, if it exists, or nullptr

Definition at line 1424 of file LArHierarchyHelper.cc.

{
    const MCParticle *pRoot{nullptr};
    for (const MCParticle *pMCParticle : mcParticleList)
    {
        try
        {
            const MCParticle *const pPrimary{LArMCParticleHelper::GetPrimaryMCParticle(pMCParticle)};
            if (!LArMCParticleHelper::IsTriggeredBeamParticle(pPrimary))
                primaries.insert(pPrimary);
            else
                primaries.insert(pPrimary);
        }
        catch (const StatusCodeException &)
        {
            if (LArMCParticleHelper::IsNeutrino(pMCParticle))
                pRoot = pMCParticle;
            else if (pMCParticle->GetParticleId() != 111 && pMCParticle->GetParticleId() < 1e9)
                std::cout << "LArHierarchyHelper::MCHierarchy::FillHierarchy: MC particle with PDG code " << pMCParticle->GetParticleId()
                          << " at address " << pMCParticle << " has no associated primary particle" << std::endl;
        }
    }

    return pRoot;
}

const ParticleFlowObject * lar_content::LArHierarchyHelper::GetRecoPrimaries ( const pandora::PfoList &  pfoList, PfoSet &  primaries  )

staticprivate

Retrieves the primary PFOs from a list and returns the root (neutrino) for hierarchy, if it exists.

Parameters

pfoList	The input list of PFOs
primaries	The output set of primary PFOs

Returns

The root neutrino, if it exists, or nullptr

Definition at line 1450 of file LArHierarchyHelper.cc.

{
    const ParticleFlowObject *pRoot{nullptr};
    PfoSet cosmicPfos;
    for (const ParticleFlowObject *pPfo : pfoList)
    {
        if (LArPfoHelper::IsNeutrino(pPfo))
        {
            pRoot = pPfo;
            break;
        }
        else
        {
            const ParticleFlowObject *const pParent{LArPfoHelper::GetParentPfo(pPfo)};
            if (pParent && LArPfoHelper::IsNeutrino(pParent))
            {
                pRoot = pParent;
                break;
            }
            else
            {
                // Should be in a test beam scenario
                const int tier{LArPfoHelper::GetHierarchyTier(pPfo)};
                if (tier == 0 && LArPfoHelper::IsTestBeam(pPfo))
                {
                    // Triggered beam particle
                    primaries.insert(pPfo);
                    continue;
                }
                if (tier > 1)
                    continue;
                if (!LArPfoHelper::IsTestBeam(pPfo))
                {
                    // Cosmic induced
                    cosmicPfos.insert(pPfo);
                }
            }
        }
    }
    if (pRoot && LArPfoHelper::IsNeutrino(pRoot))
    {
        const PfoList &children{pRoot->GetDaughterPfoList()};
        for (const ParticleFlowObject *pPrimary : children)
            primaries.insert(pPrimary);
    }
    else
    {
        for (const ParticleFlowObject *pPfo : cosmicPfos)
            primaries.insert(pPfo);
    }

    return pRoot;
}

void lar_content::LArHierarchyHelper::MatchHierarchies ( const MCHierarchy &  mcHierarchy, const RecoHierarchy &  recoHierarchy, MatchInfo &  matchInfo  )

static

Finds the matches between reconstructed and MC hierarchies.

Parameters

mcHierarchy	The MC hiearchy
recoHierarchy	The reconstructed hierarchy
matchInfo	The output match information

Definition at line 1416 of file LArHierarchyHelper.cc.

{
    matchInfo.Match(mcHierarchy, recoHierarchy);
}

---

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

• larpandoracontent/larpandoracontent/LArHelpers/LArHierarchyHelper.h
• larpandoracontent/larpandoracontent/LArHelpers/LArHierarchyHelper.cc