lar_content::LArHierarchyHelper::FoldingParameters Class Reference

FoldingParameters class. More...

#include "LArHierarchyHelper.h"

Public Member Functions
	FoldingParameters ()
	Default constructor. More...
	FoldingParameters (const bool foldDynamic, const float cosAngleTolerance=0.9962f)
	Constructor. More...
	FoldingParameters (const int foldingTier)
	Constructor. More...

Public Attributes
bool	m_foldToLeadingShowers
	Whether or not to fold shower children to the leading shower particle. More...
bool	m_foldToTier
	Whether or not to apply folding based on particle tier. More...
bool	m_foldDynamic
	Whether or not to use process and topological information to make folding decisions. More...
float	m_cosAngleTolerance
	Cosine of the maximum angle at which topologies can be considered continuous. More...
int	m_tier
	If folding to a tier, the tier to be combined with its child particles. More...

Detailed Description

FoldingParameters class.

Definition at line 30 of file LArHierarchyHelper.h.

Constructor & Destructor Documentation

lar_content::LArHierarchyHelper::FoldingParameters::FoldingParameters

(

)

Default constructor.

Definition at line 22 of file LArHierarchyHelper.cc.

References m_cosAngleTolerance, m_foldDynamic, m_foldToTier, and m_tier.

                                                       :
    m_foldToLeadingShowers{false},
    m_foldToTier{false},
    m_foldDynamic{false},
    m_cosAngleTolerance{0.9962f},
    m_tier{1}
{
}

lar_content::LArHierarchyHelper::FoldingParameters::FoldingParameters	(	const bool	foldDynamic,
		const float	cosAngleTolerance = 0.9962f
	)

Constructor.

Parameters

foldDynamic

Whether or not to apply dynamic folding to the hierarchy

Definition at line 33 of file LArHierarchyHelper.cc.

References m_cosAngleTolerance, m_foldDynamic, m_foldToTier, and m_tier.

                                                                                                            :
    m_foldToLeadingShowers{false},
    m_foldToTier{false},
    m_foldDynamic{foldDynamic},
    m_cosAngleTolerance{cosAngleTolerance},
    m_tier{1}
{
}

lar_content::LArHierarchyHelper::FoldingParameters::FoldingParameters

(

const int

foldingTier

)

Constructor.

If folding back to tier 2, any MC particle/PFO ("particles") at tier 1 will be allocated their own node. At tier 2, the particles will be allocated as the main particle for a node and all of their children will also be incorprated into the node

Parameters

foldingTier

The tier at which level child particles should be folded back (> 0)

Definition at line 44 of file LArHierarchyHelper.cc.

References m_cosAngleTolerance, m_foldDynamic, m_foldToTier, and m_tier.

                                                                            :
    m_foldToLeadingShowers{false},
    m_foldToTier{true},
    m_foldDynamic{false},
    m_cosAngleTolerance{0.9962f},
    m_tier{foldingTier}
{
    if (m_tier < 1)
    {
        std::cout << "LArHierarchyHelper: Error - attempting to fold to non-positive tier" << std::endl;
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
    }
}

Member Data Documentation

float lar_content::LArHierarchyHelper::FoldingParameters::m_cosAngleTolerance

Cosine of the maximum angle at which topologies can be considered continuous.

Definition at line 58 of file LArHierarchyHelper.h.

Referenced by lar_content::LArHierarchyHelper::MCHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::MCHierarchy::FillHierarchy(), and FoldingParameters().

bool lar_content::LArHierarchyHelper::FoldingParameters::m_foldDynamic

Whether or not to use process and topological information to make folding decisions.

Definition at line 57 of file LArHierarchyHelper.h.

Referenced by lar_content::LArHierarchyHelper::MCHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::MCHierarchy::FillHierarchy(), FoldingParameters(), lar_content::HierarchyValidationAlgorithm::Run(), and lar_content::HierarchyMonitoringAlgorithm::Run().

bool lar_content::LArHierarchyHelper::FoldingParameters::m_foldToLeadingShowers

Whether or not to fold shower children to the leading shower particle.

Definition at line 55 of file LArHierarchyHelper.h.

Referenced by lar_content::LArHierarchyHelper::MCHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::MCHierarchy::FillHierarchy(), lar_content::LArHierarchyHelper::RecoHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::RecoHierarchy::FillHierarchy(), and lar_content::HierarchyValidationAlgorithm::Run().

bool lar_content::LArHierarchyHelper::FoldingParameters::m_foldToTier

Whether or not to apply folding based on particle tier.

Definition at line 56 of file LArHierarchyHelper.h.

Referenced by lar_content::LArHierarchyHelper::MCHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::MCHierarchy::FillHierarchy(), lar_content::LArHierarchyHelper::RecoHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::RecoHierarchy::FillHierarchy(), FoldingParameters(), lar_content::HierarchyValidationAlgorithm::Run(), and lar_content::HierarchyMonitoringAlgorithm::Run().

int lar_content::LArHierarchyHelper::FoldingParameters::m_tier

If folding to a tier, the tier to be combined with its child particles.

Definition at line 59 of file LArHierarchyHelper.h.

Referenced by lar_content::LArHierarchyHelper::MCHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::MCHierarchy::FillHierarchy(), lar_content::LArHierarchyHelper::RecoHierarchy::Node::FillHierarchy(), lar_content::LArHierarchyHelper::RecoHierarchy::FillHierarchy(), FoldingParameters(), lar_content::LArHierarchyHelper::MCHierarchy::Node::GetHierarchyTier(), and lar_content::LArHierarchyHelper::RecoHierarchy::Node::GetHierarchyTier().

---

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

• larpandoracontent/v04_15_01/source/larpandoracontent/LArHelpers/LArHierarchyHelper.h
• larpandoracontent/v04_15_01/source/larpandoracontent/LArHelpers/LArHierarchyHelper.cc