LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
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.

22  :
24  m_foldToTier{false},
25  m_foldDynamic{false},
26  m_cosAngleTolerance{0.9962f},
27  m_tier{1}
28 {
29 }
bool m_foldToTier
Whether or not to apply folding based on particle tier.
int m_tier
If folding to a tier, the tier to be combined with its child particles.
float m_cosAngleTolerance
Cosine of the maximum angle at which topologies can be considered continuous.
bool m_foldDynamic
Whether or not to use process and topological information to make folding decisions.
bool m_foldToLeadingShowers
Whether or not to fold shower children to the leading shower particle.
lar_content::LArHierarchyHelper::FoldingParameters::FoldingParameters ( const bool  foldDynamic,
const float  cosAngleTolerance = 0.9962f 
)

Constructor.

Parameters
foldDynamicWhether 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.

33  :
35  m_foldToTier{false},
36  m_foldDynamic{foldDynamic},
37  m_cosAngleTolerance{cosAngleTolerance},
38  m_tier{1}
39 {
40 }
bool m_foldToTier
Whether or not to apply folding based on particle tier.
int m_tier
If folding to a tier, the tier to be combined with its child particles.
float m_cosAngleTolerance
Cosine of the maximum angle at which topologies can be considered continuous.
bool m_foldDynamic
Whether or not to use process and topological information to make folding decisions.
bool m_foldToLeadingShowers
Whether or not to fold shower children to the leading shower particle.
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
foldingTierThe 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.

44  :
46  m_foldToTier{true},
47  m_foldDynamic{false},
48  m_cosAngleTolerance{0.9962f},
49  m_tier{foldingTier}
50 {
51  if (m_tier < 1)
52  {
53  std::cout << "LArHierarchyHelper: Error - attempting to fold to non-positive tier" << std::endl;
54  throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
55  }
56 }
bool m_foldToTier
Whether or not to apply folding based on particle tier.
int m_tier
If folding to a tier, the tier to be combined with its child particles.
float m_cosAngleTolerance
Cosine of the maximum angle at which topologies can be considered continuous.
bool m_foldDynamic
Whether or not to use process and topological information to make folding decisions.
bool m_foldToLeadingShowers
Whether or not to fold shower children to the leading shower particle.

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

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