Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
lar_content::TransverseMatrixVisualizationTool Class Reference

TransverseMatrixVisualizationTool class. More...

#include "TransverseMatrixVisualizationTool.h"

Inheritance diagram for lar_content::TransverseMatrixVisualizationTool:
Inheritance graph
[legend]
Collaboration diagram for lar_content::TransverseMatrixVisualizationTool:
Collaboration graph
[legend]

Public Types

typedef TwoViewTransverseTracksAlgorithm::MatchingType::MatrixType MatrixType
 
typedef std::vector< MatrixType::ElementList::const_iterator > IteratorList
 

Public Member Functions

 TransverseMatrixVisualizationTool ()
 Default constructor.
 
bool Run (TwoViewTransverseTracksAlgorithm *const pAlgorithm, MatrixType &overlapMatrix)
 Run the algorithm tool.
 
const std::string & GetType () const
 Get the type.
 
const std::string & GetInstanceName () const
 Get the instance name.
 
const Pandora & GetPandora () const
 Get the associated pandora instance.
 

Protected Member Functions

virtual StatusCode Initialize ()
 Perform any operations that must occur after reading settings, but before running the process.
 
virtual StatusCode Reset ()
 Perform any operations when pandora is reset, typically at the end of each event.
 
StatusCode RegisterDetails (const Pandora *const pPandora, const std::string &type, const std::string &instanceName)
 Register i) the pandora instance that will run the process and ii) the process type.
 

Protected Attributes

const Pandora * m_pPandora
 The pandora object that will run the process.
 
std::string m_type
 The process type.
 
std::string m_instanceName
 The process instance name.
 

Private Member Functions

pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 

Private Attributes

unsigned int m_minClusterConnections
 The minimum number of cluster connections for display.
 
bool m_ignoreUnavailableClusters
 Whether to ignore (skip-over) unavailable clusters in the matrix.
 
bool m_showEachIndividualElement
 Whether to draw each individual matrix element.
 
bool m_showOnlyTrueMatchIndividualElements
 Whether to draw only truly matching individual matrix elements.
 

Detailed Description

TransverseMatrixVisualizationTool class.

Definition at line 19 of file TransverseMatrixVisualizationTool.h.

Member Typedef Documentation

◆ IteratorList

typedef std::vector<MatrixType::ElementList::const_iterator> lar_content::TransverseMatrixTool::IteratorList
inherited

Definition at line 103 of file TwoViewTransverseTracksAlgorithm.h.

◆ MatrixType

typedef TwoViewTransverseTracksAlgorithm::MatchingType::MatrixType lar_content::TransverseMatrixTool::MatrixType
inherited

Definition at line 102 of file TwoViewTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

◆ TransverseMatrixVisualizationTool()

lar_content::TransverseMatrixVisualizationTool::TransverseMatrixVisualizationTool ( )

Default constructor.

Definition at line 18 of file TransverseMatrixVisualizationTool.cc.

Member Function Documentation

◆ GetInstanceName()

const std::string & pandora::Process::GetInstanceName ( ) const
inlineinherited

Get the instance name.

Returns
The instance name

Definition at line 109 of file Process.h.

◆ GetPandora()

const Pandora & pandora::Process::GetPandora ( ) const
inlineinherited

Get the associated pandora instance.

Returns
the associated pandora instance

Definition at line 116 of file Process.h.

◆ GetType()

const std::string & pandora::Process::GetType ( ) const
inlineinherited

Get the type.

Returns
The type

Definition at line 102 of file Process.h.

◆ Initialize()

StatusCode pandora::Process::Initialize ( )
inlineprotectedvirtualinherited

Perform any operations that must occur after reading settings, but before running the process.

Reimplemented in lar_content::BdtBeamParticleIdTool, lar_content::BeamParticleIdTool, lar_content::CosmicRayTaggingTool, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::LArPseudoLayerPlugin, lar_content::LArRotationalTransformationPlugin, EventReadingAlgorithm, and EventWritingAlgorithm.

Definition at line 126 of file Process.h.

Here is the caller graph for this function:

◆ ReadSettings()

StatusCode lar_content::TransverseMatrixVisualizationTool::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
privatevirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

Definition at line 137 of file TransverseMatrixVisualizationTool.cc.

Here is the call graph for this function:

◆ RegisterDetails()

StatusCode pandora::Process::RegisterDetails ( const Pandora *const  pPandora,
const std::string &  type,
const std::string &  instanceName 
)
inlineprotectedinherited

Register i) the pandora instance that will run the process and ii) the process type.

Parameters
pPandoraaddress of the pandora object that will run the process
typethe process type
instanceNamethe process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

◆ Reset()

StatusCode pandora::Process::Reset ( )
inlineprotectedvirtualinherited

Perform any operations when pandora is reset, typically at the end of each event.

Reimplemented in lar_content::MasterAlgorithm, lar_content::PostProcessingAlgorithm, and lar_content::PreProcessingAlgorithm.

Definition at line 133 of file Process.h.

Here is the caller graph for this function:

◆ Run()

bool lar_content::TransverseMatrixVisualizationTool::Run ( TwoViewTransverseTracksAlgorithm *const  pAlgorithm,
MatrixType &  overlapMatrix 
)
virtual

Run the algorithm tool.

Parameters
pAlgorithmaddress of the calling algorithm
overlapMatrixthe overlap matrix
Returns
whether changes have been made by the tool

Implements lar_content::TransverseMatrixTool.

Definition at line 28 of file TransverseMatrixVisualizationTool.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_ignoreUnavailableClusters

bool lar_content::TransverseMatrixVisualizationTool::m_ignoreUnavailableClusters
private

Whether to ignore (skip-over) unavailable clusters in the matrix.

Definition at line 33 of file TransverseMatrixVisualizationTool.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName
protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_minClusterConnections

unsigned int lar_content::TransverseMatrixVisualizationTool::m_minClusterConnections
private

The minimum number of cluster connections for display.

Definition at line 32 of file TransverseMatrixVisualizationTool.h.

◆ m_pPandora

const Pandora* pandora::Process::m_pPandora
protectedinherited

The pandora object that will run the process.

Definition at line 87 of file Process.h.

◆ m_showEachIndividualElement

bool lar_content::TransverseMatrixVisualizationTool::m_showEachIndividualElement
private

Whether to draw each individual matrix element.

Definition at line 34 of file TransverseMatrixVisualizationTool.h.

◆ m_showOnlyTrueMatchIndividualElements

bool lar_content::TransverseMatrixVisualizationTool::m_showOnlyTrueMatchIndividualElements
private

Whether to draw only truly matching individual matrix elements.

Definition at line 35 of file TransverseMatrixVisualizationTool.h.

◆ m_type

std::string pandora::Process::m_type
protectedinherited

The process type.

Definition at line 88 of file Process.h.

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