CheatingClusterCreationAlgorithm class. More...

#include "CheatingClusterCreationAlgorithm.h"

Inheritance diagram for lar_content::CheatingClusterCreationAlgorithm:

[legend]

Collaboration diagram for lar_content::CheatingClusterCreationAlgorithm:

[legend]

Public Member Functions
	CheatingClusterCreationAlgorithm ()
	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.

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 Types
typedef std::unordered_map< const pandora::MCParticle *, pandora::CaloHitList >	MCParticleToHitListMap

Private Member Functions
pandora::StatusCode	Run ()
	Run the algorithm.

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

void	GetMCParticleToHitListMap (MCParticleToHitListMap &mcParticleToHitListMap) const
	Create map between each (primary) MC particle and associated calo hits.

void	SimpleMCParticleCollection (const pandora::CaloHit *const pCaloHit, const LArMCParticleHelper::MCRelationMap &mcPrimaryMap, MCParticleToHitListMap &mcParticleToHitListMap) const
	Simple mc particle collection, using main mc particle associated with each calo hit.

bool	SelectMCParticlesForClustering (const pandora::MCParticle *const pMCParticle) const
	Check whether mc particle is of a type specified for inclusion in cheated clustering.

void	CreateClusters (const MCParticleToHitListMap &mcParticleToHitListMap) const
	Create clusters based on information in the mc particle to hit list map.

Private Attributes
bool	m_collapseToPrimaryMCParticles
	Whether to collapse mc particle hierarchies to primary particles.

std::string	m_mcParticleListName
	The mc particle list name, required if want to collapse mc particle hierarchy.

pandora::IntVector	m_particleIdList
	list of particle ids of MCPFOs to be selected

Detailed Description

CheatingClusterCreationAlgorithm class.

Definition at line 23 of file CheatingClusterCreationAlgorithm.h.

Member Typedef Documentation

◆ MCParticleToHitListMap

typedef std::unordered_map<const pandora::MCParticle *, pandora::CaloHitList> lar_content::CheatingClusterCreationAlgorithm::MCParticleToHitListMap

private

Definition at line 35 of file CheatingClusterCreationAlgorithm.h.

Constructor & Destructor Documentation

◆ CheatingClusterCreationAlgorithm()

lar_content::CheatingClusterCreationAlgorithm::CheatingClusterCreationAlgorithm ( )

Default constructor.

Definition at line 18 of file CheatingClusterCreationAlgorithm.cc.

Member Function Documentation

◆ CreateClusters()

void lar_content::CheatingClusterCreationAlgorithm::CreateClusters ( const MCParticleToHitListMap & mcParticleToHitListMap ) const

private

Create clusters based on information in the mc particle to hit list map.

Parameters

mcParticleToHitListMap the mc particle to hit list map

Definition at line 106 of file CheatingClusterCreationAlgorithm.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.

◆ GetMCParticleToHitListMap()

void lar_content::CheatingClusterCreationAlgorithm::GetMCParticleToHitListMap ( MCParticleToHitListMap & mcParticleToHitListMap ) const

private

Create map between each (primary) MC particle and associated calo hits.

Parameters

mcParticleToHitListMap to receive the mc particle to hit list map

Definition at line 35 of file CheatingClusterCreationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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::CheatingClusterCreationAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 147 of file CheatingClusterCreationAlgorithm.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 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()

StatusCode lar_content::CheatingClusterCreationAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 24 of file CheatingClusterCreationAlgorithm.cc.

Here is the call graph for this function:

◆ SelectMCParticlesForClustering()

bool lar_content::CheatingClusterCreationAlgorithm::SelectMCParticlesForClustering ( const pandora::MCParticle *const pMCParticle ) const

private

Check whether mc particle is of a type specified for inclusion in cheated clustering.

Parameters

pMCParticle the mc particle to hit list map

Returns: boolean

Definition at line 90 of file CheatingClusterCreationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SimpleMCParticleCollection()

void lar_content::CheatingClusterCreationAlgorithm::SimpleMCParticleCollection	(	const pandora::CaloHit *const	pCaloHit,
		const LArMCParticleHelper::MCRelationMap &	mcPrimaryMap,
		MCParticleToHitListMap &	mcParticleToHitListMap
	)		const

private

Simple mc particle collection, using main mc particle associated with each calo hit.

Parameters

pCaloHit	address of the calo hit
mcPrimaryMap	the mapping between mc particles and their parents
mcParticleToHitListMap	the mc particle to hit list map

Definition at line 67 of file CheatingClusterCreationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_collapseToPrimaryMCParticles

bool lar_content::CheatingClusterCreationAlgorithm::m_collapseToPrimaryMCParticles

private

Whether to collapse mc particle hierarchies to primary particles.

Definition at line 70 of file CheatingClusterCreationAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_mcParticleListName

std::string lar_content::CheatingClusterCreationAlgorithm::m_mcParticleListName

private

The mc particle list name, required if want to collapse mc particle hierarchy.

Definition at line 71 of file CheatingClusterCreationAlgorithm.h.

◆ m_particleIdList

pandora::IntVector lar_content::CheatingClusterCreationAlgorithm::m_particleIdList

private

list of particle ids of MCPFOs to be selected

Definition at line 73 of file CheatingClusterCreationAlgorithm.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_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/LArCheating/CheatingClusterCreationAlgorithm.h
LArContent/larpandoracontent/LArCheating/CheatingClusterCreationAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MCParticleToHitListMap

Constructor & Destructor Documentation

◆ CheatingClusterCreationAlgorithm()

Member Function Documentation

◆ CreateClusters()

◆ GetInstanceName()

◆ GetMCParticleToHitListMap()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ SelectMCParticlesForClustering()

◆ SimpleMCParticleCollection()

Member Data Documentation

◆ m_collapseToPrimaryMCParticles

◆ m_instanceName

◆ m_mcParticleListName

◆ m_particleIdList

◆ m_pPandora

◆ m_type