lar_content::VisualParticleMonitoringAlgorithm Class Reference

VisualParticleMonitoringAlgorithm class. More...

#include "VisualParticleMonitoringAlgorithm.h"

Inheritance diagram for lar_content::VisualParticleMonitoringAlgorithm:

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

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

Private Attributes
std::string	m_caloHitListName
	Name of input calo hit list. More...
std::string	m_pfoListName
	Name of input PFO list. More...
bool	m_visualizeMC
	Whether or not to visualize MC particles. More...
bool	m_visualizePfo
	Whether or not to visualize PFOs. More...
bool	m_visualizeSlice
	Whether or not to visualize reconstructed slices. More...
bool	m_groupMCByPdg
	Whether or not to group MC particles by particle id. More...
bool	m_showPfoByPid
	Whether or not to colour PFOs by particle id. More...
bool	m_showPfoMatchedMC
	Whether or not to display the best matched MC particle for a PFO. More...
bool	m_isTestBeam
	Whether or not this is a test beam experiment. 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

VisualParticleMonitoringAlgorithm class.

Definition at line 21 of file VisualParticleMonitoringAlgorithm.h.

Constructor & Destructor Documentation

lar_content::VisualParticleMonitoringAlgorithm::VisualParticleMonitoringAlgorithm

(

)

Default constructor.

Definition at line 22 of file VisualParticleMonitoringAlgorithm.cc.

References m_energyScaleThresholdE, m_scalingFactor, and m_transparencyThresholdE.

                                                                     :
    m_visualizeMC(false),
    m_visualizePfo(false),
    m_visualizeSlice(false),
    m_groupMCByPdg(false),
    m_showPfoByPid(false),
    m_showPfoMatchedMC(false),
    m_isTestBeam{false},
    m_transparencyThresholdE{-1.f},
    m_energyScaleThresholdE{1.f},
    m_scalingFactor{1.f}
{
}

lar_content::VisualParticleMonitoringAlgorithm::~VisualParticleMonitoringAlgorithm ( )

virtual

Definition at line 38 of file VisualParticleMonitoringAlgorithm.cc.

{
}

Member Function Documentation

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

private

Definition at line 474 of file VisualParticleMonitoringAlgorithm.cc.

References m_caloHitListName, m_energyScaleThresholdE, m_groupMCByPdg, m_isTestBeam, m_pfoListName, m_scalingFactor, m_showPfoByPid, m_showPfoMatchedMC, m_transparencyThresholdE, m_visualizeMC, m_visualizePfo, and m_visualizeSlice.

{
    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, "VisualizeMC", m_visualizeMC));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VisualizePFO", m_visualizePfo));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VisualizeSlice", m_visualizeSlice));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "GroupMCByPDG", m_groupMCByPdg));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ShowPFOByPID", m_showPfoByPid));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ShowPFOMatchedMC", m_showPfoMatchedMC));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "IsTestBeam", m_isTestBeam));
    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::VisualParticleMonitoringAlgorithm::Run ( )

private

Definition at line 44 of file VisualParticleMonitoringAlgorithm.cc.

References util::abs(), util::empty(), lar_content::LArPfoHelper::GetBreadthFirstHierarchyRepresentation(), lar_content::LArMCParticleHelper::GetBreadthFirstHierarchyRepresentation(), lar_content::LArPfoHelper::GetCaloHits(), lar_content::LArPfoHelper::GetIsolatedCaloHits(), lar_content::LArMCParticleHelper::GetMainMCParticle(), lar_content::LArMCParticleHelper::IsBeamNeutrinoFinalState(), lar_content::LArMCParticleHelper::IsBeamParticle(), lar_content::LArMCParticleHelper::IsCosmicRay(), lar_content::LArPfoHelper::IsTrack(), m_caloHitListName, m_energyScaleThresholdE, lar_content::LArMCParticleHelper::PrimaryParameters::m_foldBackHierarchy, m_groupMCByPdg, m_isTestBeam, lar_content::LArMCParticleHelper::PrimaryParameters::m_maxPhotonPropagation, lar_content::LArMCParticleHelper::PrimaryParameters::m_minHitsForGoodView, lar_content::LArMCParticleHelper::PrimaryParameters::m_minHitSharingFraction, lar_content::LArMCParticleHelper::PrimaryParameters::m_minPrimaryGoodHits, m_pfoListName, m_scalingFactor, m_showPfoByPid, m_showPfoMatchedMC, m_transparencyThresholdE, m_visualizeMC, m_visualizePfo, m_visualizeSlice, lar_content::LArMCParticleHelper::SelectReconstructableMCParticles(), util::to_string(), and value.

{
#ifdef MONITORING
    LArMCParticleHelper::MCContributionMap targetMCParticleToHitsMap;
    if (m_visualizeMC || m_showPfoMatchedMC)
    {
        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));
        this->MakeSelection(pMCParticleList, pCaloHitList, targetMCParticleToHitsMap);
    }

    if (m_visualizeMC)
    {
        if (m_groupMCByPdg)
            this->VisualizeMCByPdgCode(targetMCParticleToHitsMap);
        else
            this->VisualizeIndependentMC(targetMCParticleToHitsMap);
    }
    if (m_visualizePfo)
    {
        const PfoList *pPfoList(nullptr);
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_pfoListName, pPfoList));
        if (m_showPfoByPid)
        {
            this->VisualizePfoByParticleId(*pPfoList);
        }
        else
        {
            if (m_showPfoMatchedMC)
                this->VisualizeIndependentPfo(*pPfoList, targetMCParticleToHitsMap);
            else
                this->VisualizeIndependentPfo(*pPfoList);
        }
    }
    if (m_visualizeSlice)
    {
        const PfoList *pPfoList(nullptr);
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_pfoListName, pPfoList));
        this->VisualizeReconstructedSlice(*pPfoList);
    }
#endif // MONITORING
    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

std::string lar_content::VisualParticleMonitoringAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 102 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

float lar_content::VisualParticleMonitoringAlgorithm::m_energyScaleThresholdE

private

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

Definition at line 112 of file VisualParticleMonitoringAlgorithm.h.

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

bool lar_content::VisualParticleMonitoringAlgorithm::m_groupMCByPdg

private

Whether or not to group MC particles by particle id.

Definition at line 107 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::VisualParticleMonitoringAlgorithm::m_isTestBeam

private

Whether or not this is a test beam experiment.

Definition at line 110 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::VisualParticleMonitoringAlgorithm::m_pfoListName

private

Name of input PFO list.

Definition at line 103 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

float lar_content::VisualParticleMonitoringAlgorithm::m_scalingFactor

private

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

Definition at line 113 of file VisualParticleMonitoringAlgorithm.h.

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

bool lar_content::VisualParticleMonitoringAlgorithm::m_showPfoByPid

private

Whether or not to colour PFOs by particle id.

Definition at line 108 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::VisualParticleMonitoringAlgorithm::m_showPfoMatchedMC

private

Whether or not to display the best matched MC particle for a PFO.

Definition at line 109 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

float lar_content::VisualParticleMonitoringAlgorithm::m_transparencyThresholdE

private

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

Definition at line 111 of file VisualParticleMonitoringAlgorithm.h.

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

bool lar_content::VisualParticleMonitoringAlgorithm::m_visualizeMC

private

Whether or not to visualize MC particles.

Definition at line 104 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::VisualParticleMonitoringAlgorithm::m_visualizePfo

private

Whether or not to visualize PFOs.

Definition at line 105 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::VisualParticleMonitoringAlgorithm::m_visualizeSlice

private

Whether or not to visualize reconstructed slices.

Definition at line 106 of file VisualParticleMonitoringAlgorithm.h.

Referenced by ReadSettings(), and Run().

---

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

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