lar_content::HierarchyValidationAlgorithm Class Reference

HierarchyValidationAlgorithm class. More...

#include "HierarchyValidationAlgorithm.h"

Inheritance diagram for lar_content::HierarchyValidationAlgorithm:

Public Member Functions
	HierarchyValidationAlgorithm ()
	Default constructor. More...
virtual	~HierarchyValidationAlgorithm ()

Private Member Functions
pandora::StatusCode	Run ()
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
int	m_event
	The current event. More...
std::string	m_caloHitListName
	Name of input calo hit list. More...
std::string	m_pfoListName
	Name of input PFO list. More...
std::string	m_detector
	Name of the detector. More...
bool	m_writeEventTree
	Whether or not to output event validation information to a ROOT file. More...
bool	m_writeMCTree
	Whether or not to output MC validation information to a ROOT file. More...
std::string	m_eventFileName
	The name of the event ROOT file to write. More...
std::string	m_eventTreeName
	The name of the event ROOT tree to write. More...
std::string	m_MCFileName
	The name of the MC ROOT file to write. More...
std::string	m_MCTreeName
	The name of the MC ROOT tree to write. More...
bool	m_foldToPrimaries
	Whether or not to fold the hierarchy back to primary particles. More...
bool	m_foldDynamic
	Whether or not to fold the hierarchy dynamically. More...
bool	m_foldToLeadingShowers
	Whether or not to fold the hierarchy back to leading shower particles. More...
bool	m_validateEvent
	Whether to validate at the level of an event. More...
bool	m_validateMC
	Whether to validate at the level of MC nodes. More...
float	m_minPurity
	Minimum purity to tag a node as being of good quality. More...
float	m_minCompleteness
	Minimum completeness to tag a node as being of good quality. More...
unsigned int	m_minRecoHits
	Minimum number of reconstructed primary good hits. More...
unsigned int	m_minRecoHitsPerView
	Minimum number of reconstructed hits for a good view. More...
unsigned int	m_minRecoGoodViews
	Minimum number of reconstructed primary good views. More...
bool	m_removeRecoNeutrons
	Whether to remove reconstructed neutrons and their downstream particles. More...
bool	m_selectRecoHits
	Whether to select reco hits that overlap with the MC particle hits. More...

Detailed Description

HierarchyValidationAlgorithm class.

Definition at line 22 of file HierarchyValidationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::HierarchyValidationAlgorithm::HierarchyValidationAlgorithm

(

)

Default constructor.

Definition at line 21 of file HierarchyValidationAlgorithm.cc.

References m_detector, m_foldDynamic, m_foldToLeadingShowers, m_foldToPrimaries, m_minCompleteness, m_minPurity, m_minRecoGoodViews, m_minRecoHits, m_minRecoHitsPerView, m_removeRecoNeutrons, m_selectRecoHits, m_validateEvent, m_validateMC, m_writeEventTree, and m_writeMCTree.

                                                           :
    m_event{-1},
    m_detector{"dune_fd_hd"},
    m_writeEventTree{false},
    m_writeMCTree{false},
    m_foldToPrimaries{false},
    m_foldDynamic{false},
    m_foldToLeadingShowers{false},
    m_validateEvent{false},
    m_validateMC{false},
    m_minPurity{0.8f},
    m_minCompleteness{0.65f},
    m_minRecoHits{30},
    m_minRecoHitsPerView{10},
    m_minRecoGoodViews{2},
    m_removeRecoNeutrons{true},
    m_selectRecoHits{false}
{
}

lar_content::HierarchyValidationAlgorithm::~HierarchyValidationAlgorithm ( )

virtual

Definition at line 43 of file HierarchyValidationAlgorithm.cc.

References m_eventFileName, m_eventTreeName, m_MCFileName, m_MCTreeName, m_writeEventTree, and m_writeMCTree.

{
    if (m_writeEventTree)
    {
        PANDORA_MONITORING_API(SaveTree(this->GetPandora(), m_eventTreeName.c_str(), m_eventFileName.c_str(), "UPDATE"));
    }
    if (m_writeMCTree)
    {
        PANDORA_MONITORING_API(SaveTree(this->GetPandora(), m_MCTreeName.c_str(), m_MCFileName.c_str(), "UPDATE"));
    }
}

Member Function Documentation

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

private

Definition at line 558 of file HierarchyValidationAlgorithm.cc.

References m_caloHitListName, m_detector, m_eventFileName, m_eventTreeName, m_foldDynamic, m_foldToLeadingShowers, m_foldToPrimaries, m_MCFileName, m_MCTreeName, m_minCompleteness, m_minPurity, m_minRecoGoodViews, m_minRecoHits, m_minRecoHitsPerView, m_pfoListName, m_removeRecoNeutrons, m_selectRecoHits, m_validateEvent, m_validateMC, m_writeEventTree, and m_writeMCTree.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "CaloHitListName", m_caloHitListName));
    if (m_caloHitListName.empty())
        m_caloHitListName = "CaloHitList2D";
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "PfoListName", m_pfoListName));
    if (m_pfoListName.empty())
        m_pfoListName = "RecreatedPfos";

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "Detector", m_detector));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ValidateEvent", m_validateEvent));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ValidateMC", m_validateMC));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "WriteEventTree", m_writeEventTree));
    if (m_writeEventTree)
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "EventFileName", m_eventFileName));
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "EventTreeName", m_eventTreeName));
    }

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "WriteMCTree", m_writeMCTree));
    if (m_writeMCTree)
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MCFileName", m_MCFileName));
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MCTreeName", m_MCTreeName));
    }

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "FoldToPrimaries", m_foldToPrimaries));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "FoldDynamic", m_foldDynamic));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "FoldToLeadingShowers", m_foldToLeadingShowers));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinPurity", m_minPurity));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinCompleteness", m_minCompleteness));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinRecoHits", m_minRecoHits));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinRecoHitsPerView", m_minRecoHitsPerView));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinRecoGoodViews", m_minRecoGoodViews));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "RemoveRecoNeutrons", m_removeRecoNeutrons));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SelectRecoHits", m_selectRecoHits));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::HierarchyValidationAlgorithm::Run ( )

private

Definition at line 57 of file HierarchyValidationAlgorithm.cc.

References util::abs(), f, lar_content::LArHierarchyHelper::FillMCHierarchy(), lar_content::LArHierarchyHelper::FillRecoHierarchy(), lar_content::LArInteractionTypeHelper::GetInteractionDescriptor(), lar_content::LArHierarchyHelper::MCHierarchy::Node::GetLeadingMCParticle(), lar_content::LArHierarchyHelper::MatchInfo::GetMatches(), lar_content::LArHierarchyHelper::MatchInfo::GetNMCNodes(), lar_content::LArMCParticleHelper::GetParentMCParticle(), lar_content::LArHierarchyHelper::MatchInfo::GetQualityCuts(), lar_content::LArHierarchyHelper::MatchInfo::GetRecoHierarchy(), lar_content::LArHierarchyHelper::MatchInfo::GetRootMCParticles(), lar_content::LArHierarchyHelper::RecoHierarchy::GetRootPfos(), lar_content::LArPfoHelper::GetVertex(), lcvn::interaction, lar_content::InteractionDescriptor::IsCC(), lar_content::LArMCParticleHelper::IsDecay(), lar_content::LArVertexHelper::IsInFiducialVolume(), lar_content::LArMCParticleHelper::IsNeutrino(), m_caloHitListName, m_detector, m_event, m_eventTreeName, lar_content::LArHierarchyHelper::FoldingParameters::m_foldDynamic, m_foldDynamic, lar_content::LArHierarchyHelper::FoldingParameters::m_foldToLeadingShowers, m_foldToLeadingShowers, m_foldToPrimaries, lar_content::LArHierarchyHelper::FoldingParameters::m_foldToTier, m_MCTreeName, m_minCompleteness, m_minPurity, m_minRecoGoodViews, m_minRecoHits, m_minRecoHitsPerView, m_pfoListName, m_removeRecoNeutrons, m_selectRecoHits, m_validateEvent, m_validateMC, m_writeEventTree, m_writeMCTree, lar_content::LArHierarchyHelper::MatchHierarchies(), lar_content::LArHierarchyHelper::MatchInfo::Print(), and lar_content::LArMCParticleHelper::SortByMomentum().

{
    ++m_event;
    const CaloHitList *pCaloHitList(nullptr);
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_caloHitListName, pCaloHitList));
    const MCParticleList *pMCParticleList(nullptr);
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pMCParticleList));
    const PfoList *pPfoList(nullptr);
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_pfoListName, pPfoList));

    LArHierarchyHelper::FoldingParameters foldParameters;
    if (m_foldToPrimaries)
        foldParameters.m_foldToTier = true;
    else if (m_foldDynamic)
        foldParameters.m_foldDynamic = true;
    else if (m_foldToLeadingShowers)
        foldParameters.m_foldToLeadingShowers = true;
    const LArHierarchyHelper::MCHierarchy::ReconstructabilityCriteria recoCriteria(
        m_minRecoHits, m_minRecoHitsPerView, m_minRecoGoodViews, m_removeRecoNeutrons);

    LArHierarchyHelper::MCHierarchy mcHierarchy(recoCriteria);
    LArHierarchyHelper::FillMCHierarchy(*pMCParticleList, *pCaloHitList, foldParameters, mcHierarchy);
    LArHierarchyHelper::RecoHierarchy recoHierarchy;
    LArHierarchyHelper::FillRecoHierarchy(*pPfoList, foldParameters, recoHierarchy);
    const LArHierarchyHelper::QualityCuts quality(m_minPurity, m_minCompleteness, m_selectRecoHits);
    LArHierarchyHelper::MatchInfo matchInfo(mcHierarchy, recoHierarchy, quality);
    LArHierarchyHelper::MatchHierarchies(matchInfo);
    matchInfo.Print(mcHierarchy);

#ifdef MONITORING
    if (m_validateEvent)
        this->EventValidation(matchInfo);
    if (m_validateMC)
        this->MCValidation(matchInfo);
#endif

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

std::string lar_content::HierarchyValidationAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 54 of file HierarchyValidationAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::HierarchyValidationAlgorithm::m_detector

private

Name of the detector.

Definition at line 56 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

int lar_content::HierarchyValidationAlgorithm::m_event

private

The current event.

Definition at line 53 of file HierarchyValidationAlgorithm.h.

Referenced by Run().

std::string lar_content::HierarchyValidationAlgorithm::m_eventFileName

private

The name of the event ROOT file to write.

Definition at line 59 of file HierarchyValidationAlgorithm.h.

Referenced by ReadSettings(), and ~HierarchyValidationAlgorithm().

std::string lar_content::HierarchyValidationAlgorithm::m_eventTreeName

private

The name of the event ROOT tree to write.

Definition at line 60 of file HierarchyValidationAlgorithm.h.

Referenced by ReadSettings(), Run(), and ~HierarchyValidationAlgorithm().

bool lar_content::HierarchyValidationAlgorithm::m_foldDynamic

private

Whether or not to fold the hierarchy dynamically.

Definition at line 64 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

bool lar_content::HierarchyValidationAlgorithm::m_foldToLeadingShowers

private

Whether or not to fold the hierarchy back to leading shower particles.

Definition at line 65 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

bool lar_content::HierarchyValidationAlgorithm::m_foldToPrimaries

private

Whether or not to fold the hierarchy back to primary particles.

Definition at line 63 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

std::string lar_content::HierarchyValidationAlgorithm::m_MCFileName

private

The name of the MC ROOT file to write.

Definition at line 61 of file HierarchyValidationAlgorithm.h.

Referenced by ReadSettings(), and ~HierarchyValidationAlgorithm().

std::string lar_content::HierarchyValidationAlgorithm::m_MCTreeName

private

The name of the MC ROOT tree to write.

Definition at line 62 of file HierarchyValidationAlgorithm.h.

Referenced by ReadSettings(), Run(), and ~HierarchyValidationAlgorithm().

float lar_content::HierarchyValidationAlgorithm::m_minCompleteness

private

Minimum completeness to tag a node as being of good quality.

Definition at line 69 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

float lar_content::HierarchyValidationAlgorithm::m_minPurity

private

Minimum purity to tag a node as being of good quality.

Definition at line 68 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

unsigned int lar_content::HierarchyValidationAlgorithm::m_minRecoGoodViews

private

Minimum number of reconstructed primary good views.

Definition at line 72 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

unsigned int lar_content::HierarchyValidationAlgorithm::m_minRecoHits

private

Minimum number of reconstructed primary good hits.

Definition at line 70 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

unsigned int lar_content::HierarchyValidationAlgorithm::m_minRecoHitsPerView

private

Minimum number of reconstructed hits for a good view.

Definition at line 71 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

std::string lar_content::HierarchyValidationAlgorithm::m_pfoListName

private

Name of input PFO list.

Definition at line 55 of file HierarchyValidationAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::HierarchyValidationAlgorithm::m_removeRecoNeutrons

private

Whether to remove reconstructed neutrons and their downstream particles.

Definition at line 73 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

bool lar_content::HierarchyValidationAlgorithm::m_selectRecoHits

private

Whether to select reco hits that overlap with the MC particle hits.

Definition at line 74 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

bool lar_content::HierarchyValidationAlgorithm::m_validateEvent

private

Whether to validate at the level of an event.

Definition at line 66 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

bool lar_content::HierarchyValidationAlgorithm::m_validateMC

private

Whether to validate at the level of MC nodes.

Definition at line 67 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), and Run().

bool lar_content::HierarchyValidationAlgorithm::m_writeEventTree

private

Whether or not to output event validation information to a ROOT file.

Definition at line 57 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), Run(), and ~HierarchyValidationAlgorithm().

bool lar_content::HierarchyValidationAlgorithm::m_writeMCTree

private

Whether or not to output MC validation information to a ROOT file.

Definition at line 58 of file HierarchyValidationAlgorithm.h.

Referenced by HierarchyValidationAlgorithm(), ReadSettings(), Run(), and ~HierarchyValidationAlgorithm().

---

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

• larpandoracontent/v04_14_00/source/larpandoracontent/LArMonitoring/HierarchyValidationAlgorithm.h
• larpandoracontent/v04_14_00/source/larpandoracontent/LArMonitoring/HierarchyValidationAlgorithm.cc