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_writeTree
	Whether or not to output validation information to a ROOT file. More...
std::string	m_filename
	The name of the ROOT file to write. More...
std::string	m_treename
	The name of the 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...

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_validateEvent, m_validateMC, and m_writeTree.

                                                           :
    m_event{-1},
    m_detector{"dune_fd_hd"},
    m_writeTree{false},
    m_foldToPrimaries{false},
    m_foldDynamic{false},
    m_foldToLeadingShowers{false},
    m_validateEvent{false},
    m_validateMC{false},
    m_minPurity{0.8f},
    m_minCompleteness{0.65f}
{
}

lar_content::HierarchyValidationAlgorithm::~HierarchyValidationAlgorithm ( )

virtual

Definition at line 37 of file HierarchyValidationAlgorithm.cc.

References m_filename, m_treename, and m_writeTree.

{
    if (m_writeTree)
    {
        PANDORA_MONITORING_API(SaveTree(this->GetPandora(), m_treename.c_str(), m_filename.c_str(), "UPDATE"));
    }
}

Member Function Documentation

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

private

Definition at line 442 of file HierarchyValidationAlgorithm.cc.

References m_caloHitListName, m_detector, m_filename, m_foldDynamic, m_foldToLeadingShowers, m_foldToPrimaries, m_minCompleteness, m_minPurity, m_pfoListName, m_treename, m_validateEvent, m_validateMC, and m_writeTree.

{
    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, "WriteTree", m_writeTree));
    if (m_writeTree)
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "FileName", m_filename));
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "TreeName", m_treename));
        if (!(m_validateEvent || m_validateMC))
        {
            std::cout << "Error: WriteTree requested but no tree names found" << std::endl;
            return STATUS_CODE_NOT_FOUND;
        }
        else if (m_validateEvent && m_validateMC)
        {
            std::cout << "Error: Both event-level and MC-level validation requested simulataneously" << std::endl;
            return STATUS_CODE_INVALID_PARAMETER;
        }
    }

    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));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::HierarchyValidationAlgorithm::Run ( )

private

Definition at line 47 of file HierarchyValidationAlgorithm.cc.

References util::abs(), 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::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::LArHierarchyHelper::MCHierarchy::Node::IsTestBeamParticle(), m_caloHitListName, m_detector, m_event, 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_minCompleteness, m_minPurity, m_pfoListName, m_treename, m_validateEvent, m_validateMC, m_writeTree, 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;
    LArHierarchyHelper::MCHierarchy mcHierarchy;
    LArHierarchyHelper::FillMCHierarchy(*pMCParticleList, *pCaloHitList, foldParameters, mcHierarchy);
    LArHierarchyHelper::RecoHierarchy recoHierarchy;
    LArHierarchyHelper::FillRecoHierarchy(*pPfoList, foldParameters, recoHierarchy);
    LArHierarchyHelper::QualityCuts quality(m_minPurity, m_minCompleteness);
    LArHierarchyHelper::MatchInfo matchInfo(mcHierarchy, recoHierarchy, quality);
    LArHierarchyHelper::MatchHierarchies(matchInfo);
    matchInfo.Print(mcHierarchy);

#ifdef MONITORING
    if (m_validateEvent)
        this->EventValidation(matchInfo);
    else 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_filename

private

The name of the ROOT file to write.

Definition at line 58 of file HierarchyValidationAlgorithm.h.

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

bool lar_content::HierarchyValidationAlgorithm::m_foldDynamic

private

Whether or not to fold the hierarchy dynamically.

Definition at line 61 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 62 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 60 of file HierarchyValidationAlgorithm.h.

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

float lar_content::HierarchyValidationAlgorithm::m_minCompleteness

private

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

Definition at line 66 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 65 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().

std::string lar_content::HierarchyValidationAlgorithm::m_treename

private

The name of the ROOT tree to write.

Definition at line 59 of file HierarchyValidationAlgorithm.h.

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

bool lar_content::HierarchyValidationAlgorithm::m_validateEvent

private

Whether to validate at the level of an event.

Definition at line 63 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 64 of file HierarchyValidationAlgorithm.h.

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

bool lar_content::HierarchyValidationAlgorithm::m_writeTree

private

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

Definition at line 57 of file HierarchyValidationAlgorithm.h.

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

---

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

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