lar_content::HierarchyMonitoringAlgorithm Class Reference

HierarchyMonitoringAlgorithm class. More...

#include "HierarchyMonitoringAlgorithm.h"

Inheritance diagram for lar_content::HierarchyMonitoringAlgorithm:

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

Private Member Functions
pandora::StatusCode	Run ()
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
std::string	ToStringSF (const float val, const int sf=3) const

Private Attributes
std::string	m_caloHitListName
	Name of input calo hit list. More...
std::string	m_pfoListName
	Name of input PFO list. More...
std::string	m_rootFileName
	Name of the output ROOT file (optional) More...
bool	m_visualizeMC
	Whether or not to visualize the MC nodes. More...
bool	m_visualizeReco
	Whether or not to visualize the reco nodes. More...
bool	m_visualizeDistinct
	If true, allocate colours without consideration of particle id. More...
bool	m_visualizeProcess
	If true, allocate colours based on the MC process. More...
bool	m_match
	Whether or not to visualize the reco to MC matches. More...
bool	m_collectionOnly
	Limit display to the collection plane only. More...
bool	m_foldToPrimaries
	Whether or not to fold everything back to primaries. More...
bool	m_foldDynamic
	Whether or not to fold based on process information. More...
float	m_minPurity
	The minimum purity for a match to be considered good. More...
float	m_minCompleteness
	The minimum completeness for a match to be considered good. More...
float	m_minMatchCompleteness
	The minimum completeness at which to a PFO should be considered matching at all. More...
float	m_transparencyThresholdE
	Cell energy for which transparency is saturated (0%, fully opaque) More...
float	m_energyScaleThresholdE
	Cell energy for which color is at top end of continous color palette. More...
float	m_scalingFactor
	TEve works with [cm], Pandora usually works with [mm] (but LArContent went with cm too) More...

Detailed Description

HierarchyMonitoringAlgorithm class.

Definition at line 22 of file HierarchyMonitoringAlgorithm.h.

Constructor & Destructor Documentation

lar_content::HierarchyMonitoringAlgorithm::HierarchyMonitoringAlgorithm

(

)

Default constructor.

Definition at line 18 of file HierarchyMonitoringAlgorithm.cc.

References m_collectionOnly, m_energyScaleThresholdE, m_foldDynamic, m_foldToPrimaries, m_match, m_minCompleteness, m_minMatchCompleteness, m_minPurity, m_scalingFactor, and m_transparencyThresholdE.

                                                           :
    m_visualizeMC(false),
    m_visualizeReco(false),
    m_visualizeDistinct(false),
    m_visualizeProcess{false},
    m_match(false),
    m_collectionOnly{false},
    m_foldToPrimaries{false},
    m_foldDynamic{true},
    m_minPurity{0.8f},
    m_minCompleteness{0.65f},
    m_minMatchCompleteness{0.1f},
    m_transparencyThresholdE{-1.f},
    m_energyScaleThresholdE{1.f},
    m_scalingFactor{1.f}
{
}

lar_content::HierarchyMonitoringAlgorithm::~HierarchyMonitoringAlgorithm ( )

virtual

Definition at line 38 of file HierarchyMonitoringAlgorithm.cc.

References m_rootFileName.

{
    if (!m_rootFileName.empty())
    {
        PANDORA_MONITORING_API(SaveTree(this->GetPandora(), "processes", m_rootFileName, "UPDATE"));
    }
}

Member Function Documentation

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

private

Definition at line 479 of file HierarchyMonitoringAlgorithm.cc.

References m_caloHitListName, m_collectionOnly, m_energyScaleThresholdE, m_foldDynamic, m_foldToPrimaries, m_match, m_minCompleteness, m_minMatchCompleteness, m_minPurity, m_pfoListName, m_rootFileName, m_scalingFactor, m_transparencyThresholdE, m_visualizeDistinct, m_visualizeMC, m_visualizeProcess, and m_visualizeReco.

{
    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, "RootFileName", m_rootFileName));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VisualizeMC", m_visualizeMC));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VisualizeReco", m_visualizeReco));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VisualizeDistinct", m_visualizeDistinct));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VisualizeProcess", m_visualizeProcess));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "PerformMatching", m_match));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "CollectionOnly", m_collectionOnly));
    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));
    if (m_foldToPrimaries)
        m_foldDynamic = false;
    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, "MinMatchCompleteness", m_minMatchCompleteness));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "TransparencyThresholdE", m_transparencyThresholdE));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "EnergyScaleThresholdE", m_energyScaleThresholdE));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ScalingFactor", m_scalingFactor));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::HierarchyMonitoringAlgorithm::Run ( )

private

Definition at line 48 of file HierarchyMonitoringAlgorithm.cc.

References util::abs(), color(), lar_content::LArHierarchyHelper::FillMCHierarchy(), lar_content::LArHierarchyHelper::FillRecoHierarchy(), lar_content::LArHierarchyHelper::MCHierarchy::GetFlattenedNodes(), lar_content::LArHierarchyHelper::RecoHierarchy::GetFlattenedNodes(), lar_content::LArMCParticleHelper::GetHierarchyTier(), lar_content::LArHierarchyHelper::MatchInfo::GetMatches(), lar_content::LArHierarchyHelper::MatchInfo::GetMCHierarchy(), lar_content::LArMCParticle::GetProcess(), lar_content::LArHierarchyHelper::MatchInfo::GetQualityCuts(), lar_content::LArHierarchyHelper::MatchInfo::GetRecoHierarchy(), lar_content::LArHierarchyHelper::MCHierarchy::GetRootMCParticles(), lar_content::LArHierarchyHelper::MatchInfo::GetRootMCParticles(), lar_content::LArHierarchyHelper::RecoHierarchy::GetRootPfos(), hits(), m_caloHitListName, m_collectionOnly, m_energyScaleThresholdE, lar_content::LArHierarchyHelper::FoldingParameters::m_foldDynamic, m_foldDynamic, m_foldToPrimaries, lar_content::LArHierarchyHelper::FoldingParameters::m_foldToTier, m_match, m_minCompleteness, m_minMatchCompleteness, m_minPurity, m_pfoListName, m_rootFileName, m_scalingFactor, m_transparencyThresholdE, m_visualizeDistinct, m_visualizeMC, m_visualizeProcess, m_visualizeReco, lar_content::LArHierarchyHelper::MatchHierarchies(), lar_content::MC_PROC_ALPHA_INELASTIC, lar_content::MC_PROC_ANNIHIL, lar_content::MC_PROC_ANTI_ALPHA_INELASTIC, lar_content::MC_PROC_ANTI_DEUTERON_INELASTIC, lar_content::MC_PROC_ANTI_HE3_INELASTIC, lar_content::MC_PROC_ANTI_NEUTRON_INELASTIC, lar_content::MC_PROC_ANTI_PROTON_INELASTIC, lar_content::MC_PROC_ANTI_TRITON_INELASTIC, lar_content::MC_PROC_CHIPS_NUCLEAR_CAPTURE_AT_REST, lar_content::MC_PROC_COMPT, lar_content::MC_PROC_CONV, lar_content::MC_PROC_COULOMB_SCAT, lar_content::MC_PROC_DECAY, lar_content::MC_PROC_DEUTERON_INELASTIC, lar_content::MC_PROC_E_BREM, lar_content::MC_PROC_E_IONI, lar_content::MC_PROC_ELECTRON_NUCLEAR, lar_content::MC_PROC_HAD_BERTINI_CAPTURE_AT_REST, lar_content::MC_PROC_HAD_BREM, lar_content::MC_PROC_HAD_ELASTIC, lar_content::MC_PROC_HAD_FRITIOF_CAPTURE_AT_REST, lar_content::MC_PROC_HAD_IONI, lar_content::MC_PROC_HAD_PAIR_PROD, lar_content::MC_PROC_HE3_INELASTIC, lar_content::MC_PROC_INCIDENT_NU, lar_content::MC_PROC_ION_INELASTIC, lar_content::MC_PROC_ION_IONI, lar_content::MC_PROC_KAON_MINUS_INELASTIC, lar_content::MC_PROC_KAON_PLUS_INELASTIC, lar_content::MC_PROC_LAMBDA_INELASTIC, lar_content::MC_PROC_MU_BREM, lar_content::MC_PROC_MU_IONI, lar_content::MC_PROC_MU_MINUS_CAPTURE_AT_REST, lar_content::MC_PROC_MU_NUCLEAR, lar_content::MC_PROC_MU_PAIR_PROD, lar_content::MC_PROC_N_CAPTURE, lar_content::MC_PROC_NEUTRON_INELASTIC, lar_content::MC_PROC_NEUTRON_KILLER, lar_content::MC_PROC_PHOT, lar_content::MC_PROC_PHOTON_INELASTIC, lar_content::MC_PROC_PHOTON_NUCLEAR, lar_content::MC_PROC_PI_MINUS_INELASTIC, lar_content::MC_PROC_PI_PLUS_INELASTIC, lar_content::MC_PROC_PRIMARY, lar_content::MC_PROC_PRIMARY_BACKGROUND, lar_content::MC_PROC_PROTON_INELASTIC, lar_content::MC_PROC_RAYLEIGH, lar_content::MC_PROC_TRANSPORTATION, lar_content::MC_PROC_TRITON_INELASTIC, lar_content::MC_PROC_UNKNOWN, lar_content::LArHierarchyHelper::MatchInfo::Print(), util::to_string(), lar_content::LArHierarchyHelper::MCHierarchy::ToString(), lar_content::LArHierarchyHelper::RecoHierarchy::ToString(), and ToStringSF().

{
#ifdef MONITORING
    PANDORA_MONITORING_API(
        SetEveDisplayParameters(this->GetPandora(), true, DETECTOR_VIEW_XZ, m_transparencyThresholdE, m_energyScaleThresholdE, m_scalingFactor));

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

    LArHierarchyHelper::MCHierarchy::ReconstructabilityCriteria criteria(15, 5, 2, false);
    LArHierarchyHelper::MCHierarchy mcHierarchy(criteria);
    LArHierarchyHelper::RecoHierarchy recoHierarchy;
    LArHierarchyHelper::FoldingParameters foldParameters;
    if (m_foldToPrimaries)
        foldParameters.m_foldToTier = true;
    else if (m_foldDynamic)
        foldParameters.m_foldDynamic = true;

    if (m_visualizeMC || m_match)
    {
        LArHierarchyHelper::FillMCHierarchy(*pMCParticleList, *pCaloHitList, foldParameters, mcHierarchy);
        std::cout << mcHierarchy.ToString() << std::endl;
    }
    if (m_visualizeReco || m_match)
    {
        const PfoList *pPfoList(nullptr);
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_pfoListName, pPfoList));
        LArHierarchyHelper::FillRecoHierarchy(*pPfoList, foldParameters, recoHierarchy);
        std::cout << recoHierarchy.ToString() << std::endl;
    }
    if (m_match)
    {
        LArHierarchyHelper::QualityCuts quality(m_minPurity, m_minCompleteness);
        LArHierarchyHelper::MatchInfo matchInfo(mcHierarchy, recoHierarchy, quality);
        LArHierarchyHelper::MatchHierarchies(matchInfo);
        matchInfo.Print(mcHierarchy);
        this->VisualizeMatches(matchInfo);
    }
    else
    {
        if (m_visualizeMC)
        {
            if (m_visualizeDistinct)
                this->VisualizeMCDistinct(mcHierarchy);
            else if (m_visualizeProcess)
                this->VisualizeMCProcess(mcHierarchy);
            else
                this->VisualizeMC(mcHierarchy);
        }
        if (m_visualizeReco)
            this->VisualizeReco(recoHierarchy);
    }
#endif

    return STATUS_CODE_SUCCESS;
}

std::string lar_content::HierarchyMonitoringAlgorithm::ToStringSF ( const float  val, const int  sf = 3  ) const

private

Definition at line 469 of file HierarchyMonitoringAlgorithm.cc.

Referenced by Run().

{
    std::ostringstream out;
    out.precision(sf);
    out << std::fixed << val;
    return out.str();
}

Member Data Documentation

std::string lar_content::HierarchyMonitoringAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 94 of file HierarchyMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::HierarchyMonitoringAlgorithm::m_collectionOnly

private

Limit display to the collection plane only.

Definition at line 102 of file HierarchyMonitoringAlgorithm.h.

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

float lar_content::HierarchyMonitoringAlgorithm::m_energyScaleThresholdE

private

Cell energy for which color is at top end of continous color palette.

Definition at line 109 of file HierarchyMonitoringAlgorithm.h.

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

bool lar_content::HierarchyMonitoringAlgorithm::m_foldDynamic

private

Whether or not to fold based on process information.

Definition at line 104 of file HierarchyMonitoringAlgorithm.h.

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

bool lar_content::HierarchyMonitoringAlgorithm::m_foldToPrimaries

private

Whether or not to fold everything back to primaries.

Definition at line 103 of file HierarchyMonitoringAlgorithm.h.

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

bool lar_content::HierarchyMonitoringAlgorithm::m_match

private

Whether or not to visualize the reco to MC matches.

Definition at line 101 of file HierarchyMonitoringAlgorithm.h.

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

float lar_content::HierarchyMonitoringAlgorithm::m_minCompleteness

private

The minimum completeness for a match to be considered good.

Definition at line 106 of file HierarchyMonitoringAlgorithm.h.

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

float lar_content::HierarchyMonitoringAlgorithm::m_minMatchCompleteness

private

The minimum completeness at which to a PFO should be considered matching at all.

Definition at line 107 of file HierarchyMonitoringAlgorithm.h.

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

float lar_content::HierarchyMonitoringAlgorithm::m_minPurity

private

The minimum purity for a match to be considered good.

Definition at line 105 of file HierarchyMonitoringAlgorithm.h.

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

std::string lar_content::HierarchyMonitoringAlgorithm::m_pfoListName

private

Name of input PFO list.

Definition at line 95 of file HierarchyMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::HierarchyMonitoringAlgorithm::m_rootFileName

private

Name of the output ROOT file (optional)

Definition at line 96 of file HierarchyMonitoringAlgorithm.h.

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

float lar_content::HierarchyMonitoringAlgorithm::m_scalingFactor

private

TEve works with [cm], Pandora usually works with [mm] (but LArContent went with cm too)

Definition at line 110 of file HierarchyMonitoringAlgorithm.h.

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

float lar_content::HierarchyMonitoringAlgorithm::m_transparencyThresholdE

private

Cell energy for which transparency is saturated (0%, fully opaque)

Definition at line 108 of file HierarchyMonitoringAlgorithm.h.

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

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeDistinct

private

If true, allocate colours without consideration of particle id.

Definition at line 99 of file HierarchyMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeMC

private

Whether or not to visualize the MC nodes.

Definition at line 97 of file HierarchyMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeProcess

private

If true, allocate colours based on the MC process.

Definition at line 100 of file HierarchyMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeReco

private

Whether or not to visualize the reco nodes.

Definition at line 98 of file HierarchyMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

---

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

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