lar_content::NeutrinoHierarchyAlgorithm Class Reference

NeutrinoHierarchyAlgorithm class. More...

#include "NeutrinoHierarchyAlgorithm.h"

Inheritance diagram for lar_content::NeutrinoHierarchyAlgorithm:

Classes
class	PfoInfo
	PfoInfo class. More...

Public Types
typedef std::unordered_map< const pandora::ParticleFlowObject *, PfoInfo * >	PfoInfoMap

Public Member Functions
	NeutrinoHierarchyAlgorithm ()
	Default constructor. More...
void	SeparatePfos (const NeutrinoHierarchyAlgorithm::PfoInfoMap &pfoInfoMap, pandora::PfoVector &assignedPfos, pandora::PfoVector &unassignedPfos) const
	Query the pfo info map and separate/extract pfos currently either acting as parents or associated with the neutrino vertex. More...

Private Types
typedef std::vector< PfoRelationTool * >	PfoRelationToolVector

Private Member Functions
pandora::StatusCode	Run ()
void	GetNeutrinoPfo (const pandora::ParticleFlowObject *&pNeutrinoPfo) const
	Get the address of the input neutrino pfo - enforces only one pfo present in input list; can return NULL if no neutrino exists. More...
void	GetCandidateDaughterPfoList (pandora::PfoList &candidateDaughterPfoList) const
	Get the list of candidate daughter pfos. More...
void	GetInitialPfoInfoMap (const pandora::PfoList &pfoList, PfoInfoMap &pfoInfoMap) const
	Process a provided pfo list and populate an initial pfo info map. More...
void	ProcessPfoInfoMap (const pandora::ParticleFlowObject *const pNeutrinoPfo, const pandora::PfoList &candidateDaughterPfoList, const PfoInfoMap &pfoInfoMap) const
	Process the information in a pfo info map, creating pfo parent/daughter links. More...
void	DisplayPfoInfoMap (const pandora::ParticleFlowObject *const pNeutrinoPfo, const PfoInfoMap &pfoInfoMap) const
	Display the information in a pfo info map, visualising pfo parent/daughter links. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
PfoRelationToolVector	m_algorithmToolVector
	The algorithm tool vector. More...
std::string	m_neutrinoPfoListName
	The neutrino pfo list name. More...
pandora::StringVector	m_daughterPfoListNames
	The list of daughter pfo list names. More...
unsigned int	m_halfWindowLayers
	The number of layers to use for half-window of sliding fit. More...
bool	m_displayPfoInfoMap
	Whether to display the pfo info map (if monitoring is enabled) More...

Detailed Description

NeutrinoHierarchyAlgorithm class.

Definition at line 27 of file NeutrinoHierarchyAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::ParticleFlowObject*, PfoInfo*> lar_content::NeutrinoHierarchyAlgorithm::PfoInfoMap

Definition at line 170 of file NeutrinoHierarchyAlgorithm.h.

typedef std::vector<PfoRelationTool*> lar_content::NeutrinoHierarchyAlgorithm::PfoRelationToolVector

private

Definition at line 226 of file NeutrinoHierarchyAlgorithm.h.

Constructor & Destructor Documentation

lar_content::NeutrinoHierarchyAlgorithm::NeutrinoHierarchyAlgorithm

(

)

Default constructor.

Definition at line 21 of file NeutrinoHierarchyAlgorithm.cc.

                                                       :
    m_halfWindowLayers(20),
    m_displayPfoInfoMap(false)
{
}

Member Function Documentation

void lar_content::NeutrinoHierarchyAlgorithm::DisplayPfoInfoMap ( const pandora::ParticleFlowObject *const  pNeutrinoPfo, const PfoInfoMap &  pfoInfoMap  ) const

private

Display the information in a pfo info map, visualising pfo parent/daughter links.

Parameters

pNeutrinoPfo	the address of the (original) parent neutrino pfo
pfoInfoMap	the pfo info map

Definition at line 217 of file NeutrinoHierarchyAlgorithm.cc.

References f, lar_content::NeutrinoHierarchyAlgorithm::PfoInfo::GetThisPfo(), and lar_content::LArPfoHelper::SortByNHits().

Referenced by Run().

{
    bool display(false);
    PANDORA_MONITORING_API(SetEveDisplayParameters(this->GetPandora(), false, DETECTOR_VIEW_XZ, -1.f, -1.f, 1.f));
    std::cout << "-Neutrino Pfo, nDaughters " << pNeutrinoPfo->GetDaughterPfoList().size() << ", nVertices " << pNeutrinoPfo->GetVertexList().size() << std::endl;

    PfoVector sortedPfos;
    for (const auto &mapEntry : pfoInfoMap) sortedPfos.push_back(mapEntry.first);
    std::sort(sortedPfos.begin(), sortedPfos.end(), LArPfoHelper::SortByNHits);

    for (const Pfo *const pPfo : sortedPfos)
    {
        const PfoInfo *const pPfoInfo(pfoInfoMap.at(pPfo));

        std::cout << "Pfo " << pPfoInfo->GetThisPfo() << ", vtxAssoc " << pPfoInfo->IsNeutrinoVertexAssociated()
                  << ", parent " << pPfoInfo->GetParentPfo() << ", nDaughters " << pPfoInfo->GetDaughterPfoList().size() << " (";

        for (const ParticleFlowObject *const pDaughterPfo : pPfoInfo->GetDaughterPfoList()) std::cout << pDaughterPfo << " ";
        std::cout << ") " << std::endl;

        if (pPfoInfo->IsNeutrinoVertexAssociated())
        {
            display = true;
            const PfoList tempPfoList(1, pPfoInfo->GetThisPfo());
            PANDORA_MONITORING_API(VisualizeParticleFlowObjects(this->GetPandora(), &tempPfoList, "VertexPfo", RED, true, false));
        }
    }

    if (display)
    {
        PANDORA_MONITORING_API(VisualizeVertices(this->GetPandora(), &(pNeutrinoPfo->GetVertexList()), "NeutrinoVertex", ORANGE));
        PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
        display = false;
    }

    for (const Pfo *const pPfo : sortedPfos)
    {
        const PfoInfo *const pPfoInfo(pfoInfoMap.at(pPfo));

        if (!pPfoInfo->GetDaughterPfoList().empty())
        {
            display = true;
            const PfoList tempPfoList(1, pPfoInfo->GetThisPfo());
            PANDORA_MONITORING_API(VisualizeParticleFlowObjects(this->GetPandora(), &tempPfoList, "ParentPfo", RED, true, false));
            PANDORA_MONITORING_API(VisualizeParticleFlowObjects(this->GetPandora(), &(pPfoInfo->GetDaughterPfoList()), "DaughterPfos", BLUE, true, false));
            PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
        }
    }
}

void lar_content::NeutrinoHierarchyAlgorithm::GetCandidateDaughterPfoList ( pandora::PfoList &  candidateDaughterPfoList ) const

private

Get the list of candidate daughter pfos.

Parameters

candidateDaughterPfoList

to receive the candidate daughter pfo list

Definition at line 126 of file NeutrinoHierarchyAlgorithm.cc.

References m_daughterPfoListNames.

Referenced by Run().

{
    for (const std::string &daughterPfoListName : m_daughterPfoListNames)
    {
        const PfoList *pCandidatePfoList(nullptr);

        if (STATUS_CODE_SUCCESS == PandoraContentApi::GetList(*this, daughterPfoListName, pCandidatePfoList))
        {
            candidateDaughterPfoList.insert(candidateDaughterPfoList.end(), pCandidatePfoList->begin(), pCandidatePfoList->end());
        }
        else if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
        {
            std::cout << "NeutrinoHierarchyAlgorithm: unable to find pfo list " << daughterPfoListName << std::endl;
        }
    }

    if (candidateDaughterPfoList.empty())
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);
}

void lar_content::NeutrinoHierarchyAlgorithm::GetInitialPfoInfoMap ( const pandora::PfoList &  pfoList, PfoInfoMap &  pfoInfoMap  ) const

private

Process a provided pfo list and populate an initial pfo info map.

Parameters

pfoList	the provided pfo list
pfoInfoMap	to receive the initial pfo info map

Definition at line 148 of file NeutrinoHierarchyAlgorithm.cc.

References lar_content::LArGeometryHelper::GetWireZPitch(), and m_halfWindowLayers.

Referenced by Run().

{
    const float layerPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));

    for (const ParticleFlowObject *const pPfo : pfoList)
    {
        PfoInfo *pPfoInfo(nullptr);

        try
        {
            pPfoInfo = new PfoInfo(pPfo, m_halfWindowLayers, layerPitch);
            (void) pfoInfoMap.insert(PfoInfoMap::value_type(pPfo, pPfoInfo));
        }
        catch (StatusCodeException &)
        {
            if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                std::cout << "NeutrinoHierarchyAlgorithm: Unable to calculate pfo information " << std::endl;

            delete pPfoInfo;
        }
    }
}

void lar_content::NeutrinoHierarchyAlgorithm::GetNeutrinoPfo ( const pandora::ParticleFlowObject *&  pNeutrinoPfo ) const

private

Get the address of the input neutrino pfo - enforces only one pfo present in input list; can return NULL if no neutrino exists.

Parameters

to	receive the address of the input neutrino pfo

Definition at line 104 of file NeutrinoHierarchyAlgorithm.cc.

References lar_content::LArPfoHelper::IsNeutrino(), and m_neutrinoPfoListName.

Referenced by Run().

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

    if (!pPfoList || pPfoList->empty())
    {
        if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
            std::cout << "NeutrinoHierarchyAlgorithm: unable to find pfo list " << m_neutrinoPfoListName << std::endl;

        throw StatusCodeException(STATUS_CODE_NOT_FOUND);
    }

    // ATTN Enforces that only one pfo, of neutrino-type, be in the specified input list
    pNeutrinoPfo = ((1 == pPfoList->size()) ? *(pPfoList->begin()) : nullptr);

    if (!pNeutrinoPfo || !LArPfoHelper::IsNeutrino(pNeutrinoPfo))
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
}

void lar_content::NeutrinoHierarchyAlgorithm::ProcessPfoInfoMap ( const pandora::ParticleFlowObject *const  pNeutrinoPfo, const pandora::PfoList &  candidateDaughterPfoList, const PfoInfoMap &  pfoInfoMap  ) const

private

Process the information in a pfo info map, creating pfo parent/daughter links.

Parameters

pNeutrinoPfo	the address of the (original) parent neutrino pfo
candidateDaughterPfoList	the list of candidate daughter pfos
pfoInfoMap	the pfo info map

Definition at line 173 of file NeutrinoHierarchyAlgorithm.cc.

References lar_content::LArPfoHelper::SortByNHits().

Referenced by Run().

{
    PfoVector candidateDaughterPfoVector(candidateDaughterPfoList.begin(), candidateDaughterPfoList.end());
    std::sort(candidateDaughterPfoVector.begin(), candidateDaughterPfoVector.end(), LArPfoHelper::SortByNHits);

    // Add neutrino->primary pfo links
    for (const ParticleFlowObject *const pDaughterPfo : candidateDaughterPfoVector)
    {
        PfoInfoMap::const_iterator iter = pfoInfoMap.find(pDaughterPfo);

        if ((pfoInfoMap.end() != iter) && (iter->second->IsNeutrinoVertexAssociated()))
            PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SetPfoParentDaughterRelationship(*this, pNeutrinoPfo, pDaughterPfo));
    }

    // Add primary pfo->daughter pfo links
    PfoVector sortedPfos;
    for (const auto &mapEntry : pfoInfoMap) sortedPfos.push_back(mapEntry.first);
    std::sort(sortedPfos.begin(), sortedPfos.end(), LArPfoHelper::SortByNHits);

    for (const Pfo *const pPfo : sortedPfos)
    {
        const PfoInfo *const pPfoInfo(pfoInfoMap.at(pPfo));

        PfoVector daughterPfos(pPfoInfo->GetDaughterPfoList().begin(), pPfoInfo->GetDaughterPfoList().end());
        std::sort(daughterPfos.begin(), daughterPfos.end(), LArPfoHelper::SortByNHits);

        for (const ParticleFlowObject *const pDaughterPfo : daughterPfos)
            PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SetPfoParentDaughterRelationship(*this, pPfoInfo->GetThisPfo(), pDaughterPfo));
    }

    // Deal with any remaining parent-less pfos
    for (const ParticleFlowObject *const pRemainingPfo : candidateDaughterPfoVector)
    {
        if (!pRemainingPfo->GetParentPfoList().empty())
            continue;

        // TODO Most appropriate decision - add as daughter of either i) nearest pfo, or ii) the neutrino (current approach)
        PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SetPfoParentDaughterRelationship(*this, pNeutrinoPfo, pRemainingPfo));
    }
}

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

private

Definition at line 400 of file NeutrinoHierarchyAlgorithm.cc.

References m_algorithmToolVector, m_daughterPfoListNames, m_displayPfoInfoMap, m_halfWindowLayers, and m_neutrinoPfoListName.

{
    AlgorithmToolVector algorithmToolVector;
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle,
        "PfoRelationTools", algorithmToolVector));

    for (AlgorithmToolVector::const_iterator iter = algorithmToolVector.begin(), iterEnd = algorithmToolVector.end(); iter != iterEnd; ++iter)
    {
        PfoRelationTool *const pPfoRelationTool(dynamic_cast<PfoRelationTool*>(*iter));

        if (!pPfoRelationTool)
            return STATUS_CODE_INVALID_PARAMETER;

        m_algorithmToolVector.push_back(pPfoRelationTool);
    }

    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle,
        "NeutrinoPfoListName", m_neutrinoPfoListName));

    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle,
        "DaughterPfoListNames", m_daughterPfoListNames));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
        "SlidingFitHalfWindow", m_halfWindowLayers));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
        "DisplayPfoInfoMap", m_displayPfoInfoMap));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::NeutrinoHierarchyAlgorithm::Run ( )

private

Definition at line 52 of file NeutrinoHierarchyAlgorithm.cc.

References DisplayPfoInfoMap(), GetCandidateDaughterPfoList(), GetInitialPfoInfoMap(), GetNeutrinoPfo(), lar_content::LArPfoHelper::GetVertex(), m_algorithmToolVector, m_displayPfoInfoMap, and ProcessPfoInfoMap().

{
    const ParticleFlowObject *pNeutrinoPfo(nullptr);
    PfoList candidateDaughterPfoList;

    try
    {
        this->GetNeutrinoPfo(pNeutrinoPfo);
        this->GetCandidateDaughterPfoList(candidateDaughterPfoList);
    }
    catch (StatusCodeException &statusCodeException)
    {
        if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
            std::cout << "NeutrinoHierarchyAlgorithm: required input pfos unavailable." << std::endl;

        if (STATUS_CODE_NOT_FOUND != statusCodeException.GetStatusCode())
            throw statusCodeException;

        return STATUS_CODE_SUCCESS;
    }

    PfoInfoMap pfoInfoMap;

    try
    {
        if (!pNeutrinoPfo->GetVertexList().empty())
        {
            const Vertex *const pNeutrinoVertex(LArPfoHelper::GetVertex(pNeutrinoPfo));
            this->GetInitialPfoInfoMap(candidateDaughterPfoList, pfoInfoMap);

            for (PfoRelationTool *const pPfoRelationTool : m_algorithmToolVector)
                pPfoRelationTool->Run(this, pNeutrinoVertex, pfoInfoMap);
        }

        this->ProcessPfoInfoMap(pNeutrinoPfo, candidateDaughterPfoList, pfoInfoMap);
    }
    catch (StatusCodeException &statusCodeException)
    {
        std::cout << "NeutrinoHierarchyAlgorithm: unable to process input neutrino pfo, " << statusCodeException.ToString() << std::endl;
    }

    if (m_displayPfoInfoMap)
        this->DisplayPfoInfoMap(pNeutrinoPfo, pfoInfoMap);

    for (auto &mapIter : pfoInfoMap)
        delete mapIter.second;

    return STATUS_CODE_SUCCESS;
}

void lar_content::NeutrinoHierarchyAlgorithm::SeparatePfos	(	const NeutrinoHierarchyAlgorithm::PfoInfoMap &	pfoInfoMap,
		pandora::PfoVector &	assignedPfos,
		pandora::PfoVector &	unassignedPfos
	)		const

Query the pfo info map and separate/extract pfos currently either acting as parents or associated with the neutrino vertex.

Parameters

pfoInfoMap	the pfo info map
assignedPfos	to receive the sorted vector of assigned pfos
unassignedPfos	to receive the sorted vector of unassigned pfos

Definition at line 29 of file NeutrinoHierarchyAlgorithm.cc.

References lar_content::LArPfoHelper::SortByNHits().

Referenced by lar_content::BranchAssociatedPfosTool::Run(), and lar_content::EndAssociatedPfosTool::Run().

{
    PfoVector sortedPfos;
    for (const auto &mapEntry : pfoInfoMap) sortedPfos.push_back(mapEntry.first);
    std::sort(sortedPfos.begin(), sortedPfos.end(), LArPfoHelper::SortByNHits);

    for (const Pfo *const pPfo : sortedPfos)
    {
        const PfoInfo *const pPfoInfo(pfoInfoMap.at(pPfo));

        if (pPfoInfo->IsNeutrinoVertexAssociated() || pPfoInfo->GetParentPfo())
        {
            assignedPfos.push_back(pPfoInfo->GetThisPfo());
        }
        else
        {
            unassignedPfos.push_back(pPfoInfo->GetThisPfo());
        }
    }
}

Member Data Documentation

PfoRelationToolVector lar_content::NeutrinoHierarchyAlgorithm::m_algorithmToolVector

private

The algorithm tool vector.

Definition at line 227 of file NeutrinoHierarchyAlgorithm.h.

Referenced by ReadSettings(), and Run().

pandora::StringVector lar_content::NeutrinoHierarchyAlgorithm::m_daughterPfoListNames

private

The list of daughter pfo list names.

Definition at line 230 of file NeutrinoHierarchyAlgorithm.h.

Referenced by GetCandidateDaughterPfoList(), and ReadSettings().

bool lar_content::NeutrinoHierarchyAlgorithm::m_displayPfoInfoMap

private

Whether to display the pfo info map (if monitoring is enabled)

Definition at line 233 of file NeutrinoHierarchyAlgorithm.h.

Referenced by ReadSettings(), and Run().

unsigned int lar_content::NeutrinoHierarchyAlgorithm::m_halfWindowLayers

private

The number of layers to use for half-window of sliding fit.

Definition at line 232 of file NeutrinoHierarchyAlgorithm.h.

Referenced by GetInitialPfoInfoMap(), and ReadSettings().

std::string lar_content::NeutrinoHierarchyAlgorithm::m_neutrinoPfoListName

private

The neutrino pfo list name.

Definition at line 229 of file NeutrinoHierarchyAlgorithm.h.

Referenced by GetNeutrinoPfo(), and ReadSettings().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArEventBuilding/NeutrinoHierarchyAlgorithm.h
• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArEventBuilding/NeutrinoHierarchyAlgorithm.cc