lar_content::EventValidationBaseAlgorithm Class Reference

EventValidationBaseAlgorithm class. More...

#include <EventValidationBaseAlgorithm.h>

Inheritance diagram for lar_content::EventValidationBaseAlgorithm:

Classes
class	ValidationInfo
	ValidationInfo class. More...

Protected Member Functions
	EventValidationBaseAlgorithm ()
	Default constructor. More...
	~EventValidationBaseAlgorithm ()
	Destructor. More...
virtual void	FillValidationInfo (const pandora::MCParticleList *const pMCParticleList, const pandora::CaloHitList *const pCaloHitList, const pandora::PfoList *const pPfoList, ValidationInfo &validationInfo) const =0
	Fill the validation info containers. More...
virtual void	ProcessOutput (const ValidationInfo &validationInfo, const bool useInterpretedMatching, const bool printToScreen, const bool fillTree) const =0
	Print matching information in a provided validation info object, and write information to tree if configured to do so. More...
void	InterpretMatching (const ValidationInfo &validationInfo, LArMCParticleHelper::MCParticleToPfoHitSharingMap &interpretedMCToPfoHitSharingMap) const
	Apply an interpretative matching procedure to the comprehensive matches in the provided validation info object. More...
bool	GetStrongestPfoMatch (const ValidationInfo &validationInfo, const pandora::MCParticleVector &mcPrimaryVector, pandora::PfoSet &usedPfos, LArMCParticleHelper::MCParticleToPfoHitSharingMap &interpretedMCToPfoHitSharingMap) const
	Get the strongest pfo match (most matched hits) between an available mc primary and an available pfo. More...
void	GetRemainingPfoMatches (const ValidationInfo &validationInfo, const pandora::MCParticleVector &mcPrimaryVector, const pandora::PfoSet &usedPfos, LArMCParticleHelper::MCParticleToPfoHitSharingMap &interpretedMCToPfoHitSharingMap) const
	Get the best matches for any pfos left-over after the strong matching procedure. More...
bool	IsGoodMatch (const pandora::CaloHitList &trueHits, const pandora::CaloHitList &recoHits, const pandora::CaloHitList &sharedHits) const
	Whether a provided mc primary and pfo are deemed to be a good match. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Protected Attributes
LArMCParticleHelper::PrimaryParameters	m_primaryParameters
	The mc particle primary selection parameters. More...
int	m_fileIdentifier
	The input file identifier. More...
int	m_eventNumber
	The event number. More...
std::string	m_treeName
	Name of output tree. More...

Private Member Functions
pandora::StatusCode	Run ()
void	PrintAllMatches (const ValidationInfo &validationInfo) const
	Print all/raw matching information to screen. More...
void	PrintInterpretedMatches (const ValidationInfo &validationInfo) const
	Print interpreted matching information to screen. More...
void	WriteInterpretedMatches (const ValidationInfo &validationInfo) const
	Write interpreted matching information to tree. More...

Private Attributes
std::string	m_caloHitListName
	Name of input calo hit list. More...
std::string	m_mcParticleListName
	Name of input MC particle list. More...
std::string	m_pfoListName
	Name of input Pfo list. More...
bool	m_printAllToScreen
	Whether to print all/raw matching details to screen. More...
bool	m_printMatchingToScreen
	Whether to print matching output to screen. More...
bool	m_writeToTree
	Whether to write all/raw matching details to tree. More...
bool	m_useSmallPrimaries
	Whether to consider matches to mc primaries with fewer than m_matchingMinPrimaryHits. More...
unsigned int	m_matchingMinSharedHits
	The minimum number of shared hits used in matching scheme. More...
float	m_matchingMinCompleteness
	The minimum particle completeness to declare a match. More...
float	m_matchingMinPurity
	The minimum particle purity to declare a match. More...
std::string	m_fileName
	Name of output file. More...

Detailed Description

EventValidationBaseAlgorithm class.

Definition at line 27 of file EventValidationBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::EventValidationBaseAlgorithm::EventValidationBaseAlgorithm ( )

protected

Default constructor.

Definition at line 24 of file EventValidationBaseAlgorithm.cc.

                                                           :
    m_fileIdentifier(0),
    m_eventNumber(0),
    m_printAllToScreen(false),
    m_printMatchingToScreen(true),
    m_writeToTree(false),
    m_useSmallPrimaries(true),
    m_matchingMinSharedHits(5),
    m_matchingMinCompleteness(0.1f),
    m_matchingMinPurity(0.5f)
{
}

lar_content::EventValidationBaseAlgorithm::~EventValidationBaseAlgorithm ( )

protected

Destructor.

Definition at line 39 of file EventValidationBaseAlgorithm.cc.

{
    if (m_writeToTree)
    {
        try
        {
            PANDORA_MONITORING_API(SaveTree(this->GetPandora(), m_treeName.c_str(), m_fileName.c_str(), "UPDATE"));
        }
        catch (const StatusCodeException &)
        {
            std::cout << "EventValidationBaseAlgorithm: Unable to write tree " << m_treeName << " to file " << m_fileName << std::endl;
        }
    }
}

Member Function Documentation

virtual void lar_content::EventValidationBaseAlgorithm::FillValidationInfo ( const pandora::MCParticleList *const  pMCParticleList, const pandora::CaloHitList *const  pCaloHitList, const pandora::PfoList *const  pPfoList, ValidationInfo &  validationInfo  ) const

protectedpure virtual

Fill the validation info containers.

Parameters

pMCParticleList	the address of the mc particle list
pCaloHitList	the address of the calo hit list
pPfoList	the address of the pfo list
validationInfo	to receive the validation info

Implemented in lar_content::NeutrinoEventValidationAlgorithm, lar_content::TestBeamEventValidationAlgorithm, lar_content::TestBeamHierarchyEventValidationAlgorithm, and lar_content::MuonLeadingEventValidationAlgorithm.

void lar_content::EventValidationBaseAlgorithm::GetRemainingPfoMatches ( const ValidationInfo &  validationInfo, const pandora::MCParticleVector &  mcPrimaryVector, const pandora::PfoSet &  usedPfos, LArMCParticleHelper::MCParticleToPfoHitSharingMap &  interpretedMCToPfoHitSharingMap  ) const

protected

Get the best matches for any pfos left-over after the strong matching procedure.

Parameters

validationInfo	the validation info
mcPrimaryVector	the mc primary vector
usedPfos	the set of previously used pfos
interpretedMCToPfoHitSharingMap	the output, interpreted mc particle to pfo hit sharing map

Definition at line 155 of file EventValidationBaseAlgorithm.cc.

{
    LArMCParticleHelper::PfoToMCParticleHitSharingMap pfoToMCParticleHitSharingMap;

    for (const MCParticle *const pMCPrimary : mcPrimaryVector)
    {
        if (!m_useSmallPrimaries && !validationInfo.GetTargetMCParticleToHitsMap().count(pMCPrimary))
            continue;

        if (!validationInfo.GetMCToPfoHitSharingMap().count(pMCPrimary))
            continue;

        for (const LArMCParticleHelper::PfoCaloHitListPair &pfoToSharedHits : validationInfo.GetMCToPfoHitSharingMap().at(pMCPrimary))
        {
            if (usedPfos.count(pfoToSharedHits.first))
                continue;

            const LArMCParticleHelper::MCParticleCaloHitListPair mcParticleToHits(pMCPrimary, pfoToSharedHits.second);
            LArMCParticleHelper::PfoToMCParticleHitSharingMap::iterator iter(pfoToMCParticleHitSharingMap.find(pfoToSharedHits.first));

            if (pfoToMCParticleHitSharingMap.end() == iter)
            {
                pfoToMCParticleHitSharingMap[pfoToSharedHits.first].push_back(mcParticleToHits);
            }
            else
            {
                if (1 != iter->second.size())
                    throw StatusCodeException(STATUS_CODE_FAILURE);

                LArMCParticleHelper::MCParticleCaloHitListPair &originalMCParticleToHits(iter->second.at(0));

                if (mcParticleToHits.second.size() > originalMCParticleToHits.second.size())
                    originalMCParticleToHits = mcParticleToHits;
            }
        }
    }

    for (const auto &mapEntry : pfoToMCParticleHitSharingMap)
    {
        const LArMCParticleHelper::MCParticleCaloHitListPair &mcParticleToHits(mapEntry.second.at(0));
        interpretedMCToPfoHitSharingMap[mcParticleToHits.first].push_back(
            LArMCParticleHelper::PfoCaloHitListPair(mapEntry.first, mcParticleToHits.second));
    }
}

bool lar_content::EventValidationBaseAlgorithm::GetStrongestPfoMatch ( const ValidationInfo &  validationInfo, const pandora::MCParticleVector &  mcPrimaryVector, pandora::PfoSet &  usedPfos, LArMCParticleHelper::MCParticleToPfoHitSharingMap &  interpretedMCToPfoHitSharingMap  ) const

protected

Get the strongest pfo match (most matched hits) between an available mc primary and an available pfo.

Parameters

validationInfo	the validation info
mcPrimaryVector	the mc primary vector
usedPfos	the set of previously used pfos
interpretedMCToPfoHitSharingMap	the output, interpreted mc particle to pfo hit sharing map

Returns

whether a strong match was identified

Definition at line 111 of file EventValidationBaseAlgorithm.cc.

{
    const MCParticle *pBestMCParticle(nullptr);
    LArMCParticleHelper::PfoCaloHitListPair bestPfoHitPair(nullptr, CaloHitList());

    for (const MCParticle *const pMCPrimary : mcPrimaryVector)
    {
        if (interpretedMCToPfoHitSharingMap.count(pMCPrimary))
            continue;

        if (!m_useSmallPrimaries && !validationInfo.GetTargetMCParticleToHitsMap().count(pMCPrimary))
            continue;

        if (!validationInfo.GetMCToPfoHitSharingMap().count(pMCPrimary))
            continue;

        for (const LArMCParticleHelper::PfoCaloHitListPair &pfoToSharedHits : validationInfo.GetMCToPfoHitSharingMap().at(pMCPrimary))
        {
            if (usedPfos.count(pfoToSharedHits.first))
                continue;

            if (!this->IsGoodMatch(validationInfo.GetAllMCParticleToHitsMap().at(pMCPrimary),
                    validationInfo.GetPfoToHitsMap().at(pfoToSharedHits.first), pfoToSharedHits.second))
                continue;

            if (pfoToSharedHits.second.size() > bestPfoHitPair.second.size())
            {
                pBestMCParticle = pMCPrimary;
                bestPfoHitPair = pfoToSharedHits;
            }
        }
    }

    if (!pBestMCParticle || !bestPfoHitPair.first)
        return false;

    interpretedMCToPfoHitSharingMap[pBestMCParticle].push_back(bestPfoHitPair);
    usedPfos.insert(bestPfoHitPair.first);
    return true;
}

void lar_content::EventValidationBaseAlgorithm::InterpretMatching ( const ValidationInfo &  validationInfo, LArMCParticleHelper::MCParticleToPfoHitSharingMap &  interpretedMCToPfoHitSharingMap  ) const

protected

Apply an interpretative matching procedure to the comprehensive matches in the provided validation info object.

Parameters

validationInfo	the validation info
interpretedMCToPfoHitSharingMap	the output, interpreted mc particle to pfo hit sharing map

Definition at line 86 of file EventValidationBaseAlgorithm.cc.

{
    MCParticleVector mcPrimaryVector;
    LArMonitoringHelper::GetOrderedMCParticleVector({validationInfo.GetAllMCParticleToHitsMap()}, mcPrimaryVector);

    PfoSet usedPfos;
    while (this->GetStrongestPfoMatch(validationInfo, mcPrimaryVector, usedPfos, interpretedMCToPfoHitSharingMap))
    {
    }
    this->GetRemainingPfoMatches(validationInfo, mcPrimaryVector, usedPfos, interpretedMCToPfoHitSharingMap);

    // Ensure all primaries have an entry, and sorting is as desired
    for (const MCParticle *const pMCPrimary : mcPrimaryVector)
    {
        LArMCParticleHelper::PfoToSharedHitsVector &pfoHitPairs(interpretedMCToPfoHitSharingMap[pMCPrimary]);
        std::sort(pfoHitPairs.begin(), pfoHitPairs.end(),
            [](const LArMCParticleHelper::PfoCaloHitListPair &a, const LArMCParticleHelper::PfoCaloHitListPair &b) -> bool {
                return ((a.second.size() != b.second.size()) ? a.second.size() > b.second.size() : LArPfoHelper::SortByNHits(a.first, b.first));
            });
    }
}

bool lar_content::EventValidationBaseAlgorithm::IsGoodMatch ( const pandora::CaloHitList &  trueHits, const pandora::CaloHitList &  recoHits, const pandora::CaloHitList &  sharedHits  ) const

protected

Whether a provided mc primary and pfo are deemed to be a good match.

Parameters

trueHits	the list of true hits
recoHits	the list of reco hits
sharedHits	the list of shared hits

Returns

boolean

Definition at line 203 of file EventValidationBaseAlgorithm.cc.

{
    const float purity((recoHits.size() > 0) ? static_cast<float>(sharedHits.size()) / static_cast<float>(recoHits.size()) : 0.f);
    const float completeness((trueHits.size() > 0) ? static_cast<float>(sharedHits.size()) / static_cast<float>(trueHits.size()) : 0.f);

    return ((sharedHits.size() >= m_matchingMinSharedHits) && (purity >= m_matchingMinPurity) && (completeness >= m_matchingMinCompleteness));
}

void lar_content::EventValidationBaseAlgorithm::PrintAllMatches ( const ValidationInfo &  validationInfo ) const

inlineprivate

Print all/raw matching information to screen.

Parameters

validationInfo

the validation info

Definition at line 313 of file EventValidationBaseAlgorithm.h.

{
    return this->ProcessOutput(validationInfo, false, true, false);
}

void lar_content::EventValidationBaseAlgorithm::PrintInterpretedMatches ( const ValidationInfo &  validationInfo ) const

inlineprivate

Print interpreted matching information to screen.

Parameters

validationInfo

the validation info

Definition at line 320 of file EventValidationBaseAlgorithm.h.

{
    return this->ProcessOutput(validationInfo, true, true, false);
}

virtual void lar_content::EventValidationBaseAlgorithm::ProcessOutput ( const ValidationInfo &  validationInfo, const bool  useInterpretedMatching, const bool  printToScreen, const bool  fillTree  ) const

protectedpure virtual

Print matching information in a provided validation info object, and write information to tree if configured to do so.

Parameters

validationInfo	the validation info
useInterpretedMatching	whether to use the interpreted (rather than raw) matching information
printToScreen	whether to print the information to screen
fillTree	whether to write the information to tree

Implemented in lar_content::MuonLeadingEventValidationAlgorithm, lar_content::NeutrinoEventValidationAlgorithm, lar_content::TestBeamEventValidationAlgorithm, and lar_content::TestBeamHierarchyEventValidationAlgorithm.

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

protected

Definition at line 213 of file EventValidationBaseAlgorithm.cc.

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "CaloHitListName", m_caloHitListName));
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MCParticleListName", m_mcParticleListName));
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "PfoListName", m_pfoListName));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MinPrimaryGoodHits", m_primaryParameters.m_minPrimaryGoodHits));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MinHitsForGoodView", m_primaryParameters.m_minHitsForGoodView));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MinPrimaryGoodViews", m_primaryParameters.m_minPrimaryGoodViews));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "SelectInputHits", m_primaryParameters.m_selectInputHits));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MinHitSharingFraction", m_primaryParameters.m_minHitSharingFraction));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MaxPhotonPropagation", m_primaryParameters.m_maxPhotonPropagation));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "FoldToPrimaries", m_primaryParameters.m_foldBackHierarchy));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "PrintAllToScreen", m_printAllToScreen));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "PrintMatchingToScreen", m_printMatchingToScreen));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "WriteToTree", m_writeToTree));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseSmallPrimaries", m_useSmallPrimaries));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MatchingMinSharedHits", m_matchingMinSharedHits));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MatchingMinCompleteness", m_matchingMinCompleteness));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MatchingMinPurity", m_matchingMinPurity));

    if (m_writeToTree)
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputTree", m_treeName));
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputFile", m_fileName));

        PANDORA_RETURN_RESULT_IF_AND_IF(
            STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "FileIdentifier", m_fileIdentifier));
    }

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::EventValidationBaseAlgorithm::Run ( )

private

Definition at line 56 of file EventValidationBaseAlgorithm.cc.

{
    ++m_eventNumber;

    const MCParticleList *pMCParticleList = nullptr;
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_mcParticleListName, pMCParticleList));

    const CaloHitList *pCaloHitList = nullptr;
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_caloHitListName, pCaloHitList));

    const PfoList *pPfoList = nullptr;
    (void)PandoraContentApi::GetList(*this, m_pfoListName, pPfoList);

    ValidationInfo validationInfo;
    this->FillValidationInfo(pMCParticleList, pCaloHitList, pPfoList, validationInfo);

    if (m_printAllToScreen)
        this->PrintAllMatches(validationInfo);

    if (m_printMatchingToScreen)
        this->PrintInterpretedMatches(validationInfo);

    if (m_writeToTree)
        this->WriteInterpretedMatches(validationInfo);

    return STATUS_CODE_SUCCESS;
}

void lar_content::EventValidationBaseAlgorithm::WriteInterpretedMatches ( const ValidationInfo &  validationInfo ) const

inlineprivate

Write interpreted matching information to tree.

Parameters

validationInfo

the validation info

Definition at line 327 of file EventValidationBaseAlgorithm.h.

{
    return this->ProcessOutput(validationInfo, true, false, true);
}

Member Data Documentation

std::string lar_content::EventValidationBaseAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 222 of file EventValidationBaseAlgorithm.h.

int lar_content::EventValidationBaseAlgorithm::m_eventNumber

protected

The event number.

Definition at line 194 of file EventValidationBaseAlgorithm.h.

int lar_content::EventValidationBaseAlgorithm::m_fileIdentifier

protected

The input file identifier.

Definition at line 193 of file EventValidationBaseAlgorithm.h.

std::string lar_content::EventValidationBaseAlgorithm::m_fileName

private

Name of output file.

Definition at line 235 of file EventValidationBaseAlgorithm.h.

float lar_content::EventValidationBaseAlgorithm::m_matchingMinCompleteness

private

The minimum particle completeness to declare a match.

Definition at line 232 of file EventValidationBaseAlgorithm.h.

float lar_content::EventValidationBaseAlgorithm::m_matchingMinPurity

private

The minimum particle purity to declare a match.

Definition at line 233 of file EventValidationBaseAlgorithm.h.

unsigned int lar_content::EventValidationBaseAlgorithm::m_matchingMinSharedHits

private

The minimum number of shared hits used in matching scheme.

Definition at line 231 of file EventValidationBaseAlgorithm.h.

std::string lar_content::EventValidationBaseAlgorithm::m_mcParticleListName

private

Name of input MC particle list.

Definition at line 223 of file EventValidationBaseAlgorithm.h.

std::string lar_content::EventValidationBaseAlgorithm::m_pfoListName

private

Name of input Pfo list.

Definition at line 224 of file EventValidationBaseAlgorithm.h.

LArMCParticleHelper::PrimaryParameters lar_content::EventValidationBaseAlgorithm::m_primaryParameters

protected

The mc particle primary selection parameters.

Definition at line 192 of file EventValidationBaseAlgorithm.h.

bool lar_content::EventValidationBaseAlgorithm::m_printAllToScreen

private

Whether to print all/raw matching details to screen.

Definition at line 226 of file EventValidationBaseAlgorithm.h.

bool lar_content::EventValidationBaseAlgorithm::m_printMatchingToScreen

private

Whether to print matching output to screen.

Definition at line 227 of file EventValidationBaseAlgorithm.h.

std::string lar_content::EventValidationBaseAlgorithm::m_treeName

protected

Name of output tree.

Definition at line 196 of file EventValidationBaseAlgorithm.h.

bool lar_content::EventValidationBaseAlgorithm::m_useSmallPrimaries

private

Whether to consider matches to mc primaries with fewer than m_matchingMinPrimaryHits.

Definition at line 230 of file EventValidationBaseAlgorithm.h.

bool lar_content::EventValidationBaseAlgorithm::m_writeToTree

private

Whether to write all/raw matching details to tree.

Definition at line 228 of file EventValidationBaseAlgorithm.h.

---

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

• EventValidationBaseAlgorithm.h
• EventValidationBaseAlgorithm.cc