PandoraApi class. More...

#include "PandoraApi.h"

Classes
class	Geometry
	Geometry class. More...

Public Types
typedef object_creation::CaloHit	CaloHit

typedef object_creation::MCParticle	MCParticle

typedef object_creation::Track	Track

Static Public Member Functions
static pandora::StatusCode	ProcessEvent (const pandora::Pandora &pandora)
	Process an event.

static pandora::StatusCode	ReadSettings (const pandora::Pandora &pandora, const std::string &xmlFileName)
	Read pandora settings.

static pandora::StatusCode	RegisterAlgorithmFactory (const pandora::Pandora &pandora, const std::string &algorithmType, pandora::AlgorithmFactory *const pAlgorithmFactory)
	Register an algorithm factory with pandora.

static pandora::StatusCode	RegisterAlgorithmToolFactory (const pandora::Pandora &pandora, const std::string &algorithmToolType, pandora::AlgorithmToolFactory *const pAlgorithmToolFactory)
	Register an algorithm tool factory with pandora.

static pandora::StatusCode	SetMCParentDaughterRelationship (const pandora::Pandora &pandora, const void const pParentAddress, const void const pDaughterAddress)
	Set parent-daughter mc particle relationship.

static pandora::StatusCode	SetTrackParentDaughterRelationship (const pandora::Pandora &pandora, const void const pParentAddress, const void const pDaughterAddress)
	Set parent-daughter track relationship.

static pandora::StatusCode	SetTrackSiblingRelationship (const pandora::Pandora &pandora, const void const pFirstSiblingAddress, const void const pSecondSiblingAddress)
	Set sibling track relationship.

static pandora::StatusCode	SetCaloHitToMCParticleRelationship (const pandora::Pandora &pandora, const void const pCaloHitParentAddress, const void const pMCParticleParentAddress, const float mcParticleWeight=1)
	Set calo hit to mc particle relationship.

static pandora::StatusCode	SetTrackToMCParticleRelationship (const pandora::Pandora &pandora, const void const pTrackParentAddress, const void const pMCParticleParentAddress, const float mcParticleWeight=1)
	Set track to mc particle relationship.

static pandora::StatusCode	GetCurrentPfoList (const pandora::Pandora &pandora, const pandora::PfoList *&pPfoList)
	Get the current pfo list.

static pandora::StatusCode	GetPfoList (const pandora::Pandora &pandora, const std::string &pfoListName, const pandora::PfoList *&pPfoList)
	Get a named pfo list.

static pandora::StatusCode	SetExternalParameters (const pandora::Pandora &pandora, const std::string &algorithmType, pandora::ExternalParameters *const pExternalParameters)
	Set the external parameters associated with an algorithm instance of a specific type. It is enforced that there be only a single instance of an externally-configured algorithm, per algorithm type, per Pandora instance.

static pandora::StatusCode	SetHitTypeGranularity (const pandora::Pandora &pandora, const pandora::HitType hitType, const pandora::Granularity granularity)
	Set the granularity level to be associated with a specified hit type.

static pandora::StatusCode	SetBFieldPlugin (const pandora::Pandora &pandora, pandora::BFieldPlugin *const pBFieldPlugin)
	Set the bfield plugin used by pandora.

static pandora::StatusCode	SetLArTransformationPlugin (const pandora::Pandora &pandora, pandora::LArTransformationPlugin *const pLArTransformationPlugin)
	Set the lar transformation plugin used by pandora.

static pandora::StatusCode	SetPseudoLayerPlugin (const pandora::Pandora &pandora, pandora::PseudoLayerPlugin *const pPseudoLayerPlugin)
	Set the pseudo layer plugin used by pandora.

static pandora::StatusCode	SetShowerProfilePlugin (const pandora::Pandora &pandora, pandora::ShowerProfilePlugin *const pShowerProfilePlugin)
	Set the shower profile plugin used by pandora.

static pandora::StatusCode	RegisterEnergyCorrectionPlugin (const pandora::Pandora &pandora, const std::string &name, const pandora::EnergyCorrectionType energyCorrectionType, pandora::EnergyCorrectionPlugin *const pEnergyCorrectionPlugin)
	Register an energy correction plugin.

static pandora::StatusCode	RegisterParticleIdPlugin (const pandora::Pandora &pandora, const std::string &name, pandora::ParticleIdPlugin *const pParticleIdPlugin)
	Register a particle id plugin.

static pandora::StatusCode	Reset (const pandora::Pandora &pandora)
	Reset pandora to process another event.

Detailed Description

PandoraApi class.

Definition at line 22 of file PandoraApi.h.

Class Documentation

◆ PandoraApi::Geometry

class PandoraApi::Geometry

Geometry class.

Definition at line 33 of file PandoraApi.h.

Class Members
typedef BoxGap	BoxGap
typedef ConcentricGap	ConcentricGap
typedef LArTPC	LArTPC
typedef LayerParameters	LayerParameters
typedef LineGap	LineGap
typedef SubDetector	SubDetector

Member Typedef Documentation

◆ CaloHit

typedef object_creation::CaloHit PandoraApi::CaloHit

Definition at line 26 of file PandoraApi.h.

◆ MCParticle

typedef object_creation::MCParticle PandoraApi::MCParticle

Definition at line 27 of file PandoraApi.h.

◆ Track

typedef object_creation::Track PandoraApi::Track

Definition at line 28 of file PandoraApi.h.

Member Function Documentation

◆ GetCurrentPfoList()

pandora::StatusCode PandoraApi::GetCurrentPfoList	(	const pandora::Pandora &	pandora,
		const pandora::PfoList *&	pPfoList
	)

static

Get the current pfo list.

Parameters

pandora	the pandora instance to get the objects from
pPfoList	to receive the address of the particle flow objects

Definition at line 84 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ GetPfoList()

pandora::StatusCode PandoraApi::GetPfoList	(	const pandora::Pandora &	pandora,
		const std::string &	pfoListName,
		const pandora::PfoList *&	pPfoList
	)

static

Get a named pfo list.

Parameters

pandora	the pandora instance to get the objects from
pfoListName	the name of the pfo list
pPfoList	to receive the address of the pfo list

Definition at line 92 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ ProcessEvent()

pandora::StatusCode PandoraApi::ProcessEvent ( const pandora::Pandora & pandora )

static

Process an event.

Parameters

pandora the pandora instance to process event

Definition at line 14 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ ReadSettings()

pandora::StatusCode PandoraApi::ReadSettings	(	const pandora::Pandora &	pandora,
		const std::string &	xmlFileName
	)

static

Read pandora settings.

Parameters

pandora	the pandora instance to run the algorithms initialize
xmlFileName	the name of the xml file containing the settings

Definition at line 21 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ RegisterAlgorithmFactory()

pandora::StatusCode PandoraApi::RegisterAlgorithmFactory	(	const pandora::Pandora &	pandora,
		const std::string &	algorithmType,
		pandora::AlgorithmFactory *const	pAlgorithmFactory
	)

static

Register an algorithm factory with pandora.

Parameters

pandora	the pandora instance to register the algorithm factory with
algorithmType	the type of algorithm that the factory will create
pAlgorithmFactory	the address of an algorithm factory instance

Definition at line 28 of file PandoraApi.cc.

◆ RegisterAlgorithmToolFactory()

pandora::StatusCode PandoraApi::RegisterAlgorithmToolFactory	(	const pandora::Pandora &	pandora,
		const std::string &	algorithmToolType,
		pandora::AlgorithmToolFactory *const	pAlgorithmToolFactory
	)

static

Register an algorithm tool factory with pandora.

Parameters

pandora	the pandora instance to register the algorithm tool factory with
algorithmTool	Type the type of algorithm tool that the factory will create
pAlgorithmToolFactory	the address of an algorithm tool factory instance

Definition at line 36 of file PandoraApi.cc.

◆ RegisterEnergyCorrectionPlugin()

pandora::StatusCode PandoraApi::RegisterEnergyCorrectionPlugin	(	const pandora::Pandora &	pandora,
		const std::string &	name,
		const pandora::EnergyCorrectionType	energyCorrectionType,
		pandora::EnergyCorrectionPlugin *const	pEnergyCorrectionPlugin
	)

static

Register an energy correction plugin.

Parameters

pandora	the pandora instance with which to register the energy correction plugin
name	the name/label associated with the energy correction plugin
energyCorrectionType	the energy correction type
pEnergyCorrectionPlugin	address of the energy correction plugin (will pass ownership to pandora)

Definition at line 143 of file PandoraApi.cc.

◆ RegisterParticleIdPlugin()

pandora::StatusCode PandoraApi::RegisterParticleIdPlugin	(	const pandora::Pandora &	pandora,
		const std::string &	name,
		pandora::ParticleIdPlugin *const	pParticleIdPlugin
	)

static

Register a particle id plugin.

Parameters

pandora	the pandora instance with which to register the particle id plugin
functionName	the name/label associated with the particle id plugin
pParticleIdPlugin	address of the particle id plugin (will pass ownership to pandora)

Definition at line 151 of file PandoraApi.cc.

◆ Reset()

pandora::StatusCode PandoraApi::Reset ( const pandora::Pandora & pandora )

static

Reset pandora to process another event.

Parameters

pandora the pandora instance to reset

Definition at line 159 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ SetBFieldPlugin()

pandora::StatusCode PandoraApi::SetBFieldPlugin	(	const pandora::Pandora &	pandora,
		pandora::BFieldPlugin *const	pBFieldPlugin
	)

static

Set the bfield plugin used by pandora.

Parameters

pandora	the pandora instance to register the bfield plugin with
pBFieldPlugin	address of the bfield plugin (will pass ownership to pandora)

Definition at line 115 of file PandoraApi.cc.

◆ SetCaloHitToMCParticleRelationship()

pandora::StatusCode PandoraApi::SetCaloHitToMCParticleRelationship	(	const pandora::Pandora &	pandora,
		const void *const	pCaloHitParentAddress,
		const void *const	pMCParticleParentAddress,
		const float	mcParticleWeight = `1`
	)

static

Set calo hit to mc particle relationship.

Parameters

pandora	the pandora instance to register the relationship with
pCaloHitParentAddress	address of calo hit in the user framework
pMCParticleParentAddress	address of mc particle in the user framework
mcParticleWeight	weighting to assign to the mc particle

Definition at line 68 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ SetExternalParameters()

pandora::StatusCode PandoraApi::SetExternalParameters	(	const pandora::Pandora &	pandora,
		const std::string &	algorithmType,
		pandora::ExternalParameters *const	pExternalParameters
	)

static

Set the external parameters associated with an algorithm instance of a specific type. It is enforced that there be only a single instance of an externally-configured algorithm, per algorithm type, per Pandora instance.

Parameters

pandora	the pandora instance
algorithmType	the algorithm type
pExternalParameters	the address of the external parameters instance

Definition at line 99 of file PandoraApi.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetHitTypeGranularity()

pandora::StatusCode PandoraApi::SetHitTypeGranularity	(	const pandora::Pandora &	pandora,
		const pandora::HitType	hitType,
		const pandora::Granularity	granularity
	)

static

Set the granularity level to be associated with a specified hit type.

Parameters

pandora	the pandora instance to register the hit type to granularity relationship
hitType	the specified hit type
granularity	the specified granularity

Definition at line 107 of file PandoraApi.cc.

◆ SetLArTransformationPlugin()

pandora::StatusCode PandoraApi::SetLArTransformationPlugin	(	const pandora::Pandora &	pandora,
		pandora::LArTransformationPlugin *const	pLArTransformationPlugin
	)

static

Set the lar transformation plugin used by pandora.

Parameters

pandora	the pandora instance to register the lar transformation plugin with
pLArTransformationPlugin	address of the lar transformation plugin (will pass ownership to pandora)

Definition at line 122 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ SetMCParentDaughterRelationship()

pandora::StatusCode PandoraApi::SetMCParentDaughterRelationship	(	const pandora::Pandora &	pandora,
		const void *const	pParentAddress,
		const void *const	pDaughterAddress
	)

static

Set parent-daughter mc particle relationship.

Parameters

pandora	the pandora instance to register the relationship with
pParentAddress	address of parent mc particle in the user framework
pDaughterAddress	address of daughter mc particle in the user framework

Definition at line 44 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ SetPseudoLayerPlugin()

pandora::StatusCode PandoraApi::SetPseudoLayerPlugin	(	const pandora::Pandora &	pandora,
		pandora::PseudoLayerPlugin *const	pPseudoLayerPlugin
	)

static

Set the pseudo layer plugin used by pandora.

Parameters

pandora	the pandora instance to register the pseudo layer plugin with
pPseudoLayerPlugin	address of the pseudo layer plugin (will pass ownership to pandora)

Definition at line 129 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ SetShowerProfilePlugin()

pandora::StatusCode PandoraApi::SetShowerProfilePlugin	(	const pandora::Pandora &	pandora,
		pandora::ShowerProfilePlugin *const	pShowerProfilePlugin
	)

static

Set the shower profile plugin used by pandora.

Parameters

pandora	the pandora instance to register the shower profile plugin with
pPseudoLayerPlugin	address of the pseudo layer plugin (will pass ownership to pandora)

Definition at line 136 of file PandoraApi.cc.

◆ SetTrackParentDaughterRelationship()

pandora::StatusCode PandoraApi::SetTrackParentDaughterRelationship	(	const pandora::Pandora &	pandora,
		const void *const	pParentAddress,
		const void *const	pDaughterAddress
	)

static

Set parent-daughter track relationship.

Parameters

pandora	the pandora instance to register the relationship with
pParentAddress	address of parent track in the user framework
pDaughterAddress	address of daughter track in the user framework

Definition at line 52 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ SetTrackSiblingRelationship()

pandora::StatusCode PandoraApi::SetTrackSiblingRelationship	(	const pandora::Pandora &	pandora,
		const void *const	pFirstSiblingAddress,
		const void *const	pSecondSiblingAddress
	)

static

Set sibling track relationship.

Parameters

pandora	the pandora instance to register the relationship with
pFirstSiblingAddress	address of first sibling track in the user framework
pSecondSiblingAddress	address of second sibling track in the user framework

Definition at line 60 of file PandoraApi.cc.

Here is the caller graph for this function:

◆ SetTrackToMCParticleRelationship()

pandora::StatusCode PandoraApi::SetTrackToMCParticleRelationship	(	const pandora::Pandora &	pandora,
		const void *const	pTrackParentAddress,
		const void *const	pMCParticleParentAddress,
		const float	mcParticleWeight = `1`
	)

static

Set track to mc particle relationship.

Parameters

pandora	the pandora instance to register the relationship with
pTrackParentAddress	address of track in the user framework
pMCParticleParentAddress	address of mc particle in the user framework
mcParticleWeight	weighting to assign to the mc particle

Definition at line 76 of file PandoraApi.cc.

Here is the caller graph for this function:

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

PandoraSDK/include/Api/PandoraApi.h
PandoraSDK/src/Api/PandoraApi.cc

Classes

Public Types

Static Public Member Functions

Detailed Description

Class Documentation

◆ PandoraApi::Geometry

Member Typedef Documentation

◆ CaloHit

◆ MCParticle

◆ Track

Member Function Documentation

◆ GetCurrentPfoList()

◆ GetPfoList()

◆ ProcessEvent()

◆ ReadSettings()

◆ RegisterAlgorithmFactory()

◆ RegisterAlgorithmToolFactory()

◆ RegisterEnergyCorrectionPlugin()

◆ RegisterParticleIdPlugin()

◆ Reset()

◆ SetBFieldPlugin()

◆ SetCaloHitToMCParticleRelationship()

◆ SetExternalParameters()

◆ SetHitTypeGranularity()

◆ SetLArTransformationPlugin()

◆ SetMCParentDaughterRelationship()

◆ SetPseudoLayerPlugin()

◆ SetShowerProfilePlugin()

◆ SetTrackParentDaughterRelationship()

◆ SetTrackSiblingRelationship()

◆ SetTrackToMCParticleRelationship()