#include "PreProcessingAlgorithm.h"

Inheritance diagram for lar_content::PreProcessingAlgorithm:

[legend]

Collaboration diagram for lar_content::PreProcessingAlgorithm:

[legend]

Public Member Functions
	PreProcessingAlgorithm ()
	Default constructor.

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.

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 Types
typedef KDTreeLinkerAlgo< const pandora::CaloHit *, 2 >	HitKDTree2D

typedef KDTreeNodeInfoT< const pandora::CaloHit *, 2 >	HitKDNode2D

typedef std::vector< HitKDNode2D >	HitKDNode2DList

Private Member Functions
pandora::StatusCode	Reset ()
	Perform any operations when pandora is reset, typically at the end of each event.

pandora::StatusCode	Run ()
	Run the algorithm.

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

void	ProcessCaloHits ()
	Build separate CaloHitLists for each view.

void	PopulateVoidCaloHitLists () noexcept
	Build empty calo hit lists.

void	GetFilteredCaloHitList (const pandora::CaloHitList &inputList, pandora::CaloHitList &outputList)
	Clean up the input CaloHitList.

void	ProcessMCParticles ()
	Build separate MCParticleLists for each view.

Private Attributes
pandora::CaloHitSet	m_processedHits
	The set of all previously processed calo hits.

float	m_mipEquivalentCut
	Minimum mip equivalent energy for calo hit.

float	m_minCellLengthScale
	The minimum length scale for calo hit.

float	m_maxCellLengthScale
	The maximum length scale for calo hit.

float	m_searchRegion1D
	Search region, applied to each dimension, for look-up from kd-trees.

unsigned int	m_maxEventHits
	The maximum number of hits in an event to proceed with the reconstruction.

bool	m_onlyAvailableCaloHits
	Whether to only include available calo hits.

std::string	m_inputCaloHitListName
	The input calo hit list name.

std::string	m_outputCaloHitListNameU
	The output calo hit list name for TPC_VIEW_U hits.

std::string	m_outputCaloHitListNameV
	The output calo hit list name for TPC_VIEW_V hits.

std::string	m_outputCaloHitListNameW
	The output calo hit list name for TPC_VIEW_W hits.

std::string	m_filteredCaloHitListName
	The output calo hit list name for all U, V and W hits.

std::string	m_currentCaloHitListReplacement
	The name of the calo hit list to replace the current list (optional)

Detailed Description

PreProcessingAlgorithm class.

Definition at line 26 of file PreProcessingAlgorithm.h.

Member Typedef Documentation

◆ HitKDNode2D

typedef KDTreeNodeInfoT<const pandora::CaloHit *, 2> lar_content::PreProcessingAlgorithm::HitKDNode2D

private

Definition at line 36 of file PreProcessingAlgorithm.h.

◆ HitKDNode2DList

typedef std::vector<HitKDNode2D> lar_content::PreProcessingAlgorithm::HitKDNode2DList

private

Definition at line 37 of file PreProcessingAlgorithm.h.

◆ HitKDTree2D

typedef KDTreeLinkerAlgo<const pandora::CaloHit *, 2> lar_content::PreProcessingAlgorithm::HitKDTree2D

private

Definition at line 35 of file PreProcessingAlgorithm.h.

Constructor & Destructor Documentation

◆ PreProcessingAlgorithm()

lar_content::PreProcessingAlgorithm::PreProcessingAlgorithm ( )

Default constructor.

Definition at line 22 of file PreProcessingAlgorithm.cc.

Member Function Documentation

◆ GetFilteredCaloHitList()

void lar_content::PreProcessingAlgorithm::GetFilteredCaloHitList	(	const pandora::CaloHitList &	inputList,
		pandora::CaloHitList &	outputList
	)

private

Clean up the input CaloHitList.

Parameters

inputList	the input CaloHitList
outputList	the output CaloHitList

Definition at line 189 of file PreProcessingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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:

◆ PopulateVoidCaloHitLists()

void lar_content::PreProcessingAlgorithm::PopulateVoidCaloHitLists ( )

privatenoexcept

Build empty calo hit lists.

Definition at line 163 of file PreProcessingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessCaloHits()

void lar_content::PreProcessingAlgorithm::ProcessCaloHits ( )

private

Build separate CaloHitLists for each view.

Definition at line 79 of file PreProcessingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessMCParticles()

void lar_content::PreProcessingAlgorithm::ProcessMCParticles ( )

private

Build separate MCParticleLists for each view.

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 243 of file PreProcessingAlgorithm.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

pPandora	address of the pandora object that will run the process
type	the process type
instanceName	the process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

◆ Reset()

StatusCode lar_content::PreProcessingAlgorithm::Reset ( )

privatevirtual

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

Reimplemented from pandora::Process.

Definition at line 35 of file PreProcessingAlgorithm.cc.

◆ Run()

StatusCode lar_content::PreProcessingAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 43 of file PreProcessingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_currentCaloHitListReplacement

std::string lar_content::PreProcessingAlgorithm::m_currentCaloHitListReplacement

private

The name of the calo hit list to replace the current list (optional)

Definition at line 80 of file PreProcessingAlgorithm.h.

◆ m_filteredCaloHitListName

std::string lar_content::PreProcessingAlgorithm::m_filteredCaloHitListName

private

The output calo hit list name for all U, V and W hits.

Definition at line 79 of file PreProcessingAlgorithm.h.

◆ m_inputCaloHitListName

std::string lar_content::PreProcessingAlgorithm::m_inputCaloHitListName

private

The input calo hit list name.

Definition at line 75 of file PreProcessingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxCellLengthScale

float lar_content::PreProcessingAlgorithm::m_maxCellLengthScale

private

The maximum length scale for calo hit.

Definition at line 70 of file PreProcessingAlgorithm.h.

◆ m_maxEventHits

unsigned int lar_content::PreProcessingAlgorithm::m_maxEventHits

private

The maximum number of hits in an event to proceed with the reconstruction.

Definition at line 72 of file PreProcessingAlgorithm.h.

◆ m_minCellLengthScale

float lar_content::PreProcessingAlgorithm::m_minCellLengthScale

private

The minimum length scale for calo hit.

Definition at line 69 of file PreProcessingAlgorithm.h.

◆ m_mipEquivalentCut

float lar_content::PreProcessingAlgorithm::m_mipEquivalentCut

private

Minimum mip equivalent energy for calo hit.

Definition at line 68 of file PreProcessingAlgorithm.h.

◆ m_onlyAvailableCaloHits

bool lar_content::PreProcessingAlgorithm::m_onlyAvailableCaloHits

private

Whether to only include available calo hits.

Definition at line 74 of file PreProcessingAlgorithm.h.

◆ m_outputCaloHitListNameU

std::string lar_content::PreProcessingAlgorithm::m_outputCaloHitListNameU

private

The output calo hit list name for TPC_VIEW_U hits.

Definition at line 76 of file PreProcessingAlgorithm.h.

◆ m_outputCaloHitListNameV

std::string lar_content::PreProcessingAlgorithm::m_outputCaloHitListNameV

private

The output calo hit list name for TPC_VIEW_V hits.

Definition at line 77 of file PreProcessingAlgorithm.h.

◆ m_outputCaloHitListNameW

std::string lar_content::PreProcessingAlgorithm::m_outputCaloHitListNameW

private

The output calo hit list name for TPC_VIEW_W hits.

Definition at line 78 of file PreProcessingAlgorithm.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_processedHits

pandora::CaloHitSet lar_content::PreProcessingAlgorithm::m_processedHits

private

The set of all previously processed calo hits.

Definition at line 66 of file PreProcessingAlgorithm.h.

◆ m_searchRegion1D

float lar_content::PreProcessingAlgorithm::m_searchRegion1D

private

Search region, applied to each dimension, for look-up from kd-trees.

Definition at line 71 of file PreProcessingAlgorithm.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:

LArContent/larpandoracontent/LArControlFlow/PreProcessingAlgorithm.h
LArContent/larpandoracontent/LArControlFlow/PreProcessingAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HitKDNode2D

◆ HitKDNode2DList

◆ HitKDTree2D

Constructor & Destructor Documentation

◆ PreProcessingAlgorithm()

Member Function Documentation

◆ GetFilteredCaloHitList()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ PopulateVoidCaloHitLists()

◆ ProcessCaloHits()

◆ ProcessMCParticles()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_currentCaloHitListReplacement

◆ m_filteredCaloHitListName

◆ m_inputCaloHitListName

◆ m_instanceName

◆ m_maxCellLengthScale

◆ m_maxEventHits

◆ m_minCellLengthScale

◆ m_mipEquivalentCut

◆ m_onlyAvailableCaloHits

◆ m_outputCaloHitListNameU

◆ m_outputCaloHitListNameV

◆ m_outputCaloHitListNameW

◆ m_pPandora

◆ m_processedHits

◆ m_searchRegion1D

◆ m_type