APRILContentApi class. More...

#include <APRILContentApi.h>

Classes
class	CaloHitMetadata
	CaloHitMetadata class. More...

Static Public Member Functions
static pandora::StatusCode	AlterMetadata (const pandora::Algorithm &algorithm, const april_content::CaloHit *const pCaloHit, const CaloHitMetadata &caloHitMetadata)
	Alter calo hit meta data. More...

static bool	IsConnected (const april_content::CaloHit const pCaloHit1, const april_content::CaloHit const pCaloHit2)
	Whether the two calo hits are connected (backward or forward directions) More...

static bool	IsConnected (const april_content::CaloHit const pCaloHit1, const april_content::CaloHit const pCaloHit2, april_content::ConnectorDirection direction)
	Whether the two calo hits are connected in the given direction. More...

static pandora::StatusCode	FindConnector (const april_content::CaloHit const pCaloHit1, const april_content::CaloHit const pCaloHit2, const april_content::Connector *&pConnector)
	Find a connector that links the two calo hits. More...

static pandora::StatusCode	FindConnector (const april_content::CaloHit const pCaloHit1, const april_content::CaloHit const pCaloHit2, april_content::ConnectorDirection direction, const april_content::Connector *&pConnector)
	Find a connector that links the two calo hits in a given direction. More...

static bool	HasAnyConnection (const april_content::CaloHit *const pCaloHit)
	Whether the calo hit has at least one connection. More...

static const april_content::ConnectorList &	GetConnectorList (const april_content::CaloHit *const pCaloHit)
	Get the global connector list (backward and forward) of the calo hit. More...

static const april_content::ConnectorList &	GetConnectorList (const april_content::CaloHit *const pCaloHit, april_content::ConnectorDirection direction)
	Get the connector list of a calo hit for a given direction. More...

static bool	IsSeed (const april_content::CaloHit *const pCaloHit)
	Whether the calo hit is a seed calo hit in the tree. More...

static bool	IsLeaf (const april_content::CaloHit *const pCaloHit)
	Whether the calo hit is a leaf calo hit in the tree. More...

static pandora::StatusCode	Connect (const april_content::CaloHit const pCaloHit1, const april_content::CaloHit const pCaloHit2, april_content::ConnectorDirection direction, float referenceLength=1.f, unsigned int creationStage=-1)
	Connect the two calo hits in a given direction. More...

static pandora::StatusCode	Connect (const april_content::CaloHit const pCaloHit1, const april_content::CaloHit const pCaloHit2, april_content::ConnectorDirection direction, const april_content::Connector *&pConnector, float referenceLength=1.f, unsigned int creationStage=-1)
	Connect the two calo hits in a given direction. More...

static pandora::StatusCode	RemoveConnectionBetween (const april_content::CaloHit const pCaloHit1, const april_content::CaloHit const pCaloHit2)
	Remove and delete the connection between the two calo hits. More...

static pandora::StatusCode	RemoveAndDeleteConnector (const april_content::Connector *const pConnector)
	Remove the connection between the two calo hits and delete the connector. More...

static pandora::StatusCode	RemoveAndDeleteAllConnections (const april_content::CaloHit *const pCaloHit)
	Remove and delete all the connections of the calo hit. More...

static pandora::StatusCode	Tag (const april_content::CaloHit *const pCaloHit, april_content::HitTag tag, bool value)
	Set the calo hit tag. More...

static bool	IsTagged (const april_content::CaloHit *const pCaloHit, april_content::HitTag tag)
	Whether the calo hit has been tagged. More...

static pandora::StatusCode	ResetTags (const april_content::CaloHit *const pCaloHit)
	Reset the calo hit tags. More...

static pandora::StatusCode	InitializeReclustering (const pandora::Algorithm &algorithm, const pandora::TrackList &inputTrackList, const pandora::ClusterList &inputClusterList, std::string &originalClustersListName)
	Initialize APRIL re-clustering. Save calo hit meta data and create a new one for each calo hit. More...

static pandora::StatusCode	RunReclusteringAlgorithm (const pandora::Algorithm &algorithm, const std::string &clusteringAlgorithmName, const pandora::ClusterList *&pNewClusterList, std::string &newClusterListName)
	Run a re-clustering algorithm. Must be called only to run a clustering algorithm in a re-clustering process. More...

static pandora::StatusCode	PostRunReclusteringAlgorithm (const pandora::Algorithm &algorithm, const std::string &clusterListName)
	Function to call just after a re-clustering algorithm and potential association algorithms. More...

static pandora::StatusCode	EndReclustering (const pandora::Algorithm &algorithm, const std::string &selectedClusterListName)
	End the re-clustering procedure. More...

static pandora::StatusCode	Create (const pandora::Algorithm &algorithm, PandoraContentApi::Cluster::Parameters clusterParameters, const pandora::Cluster *&pCluster)

static pandora::StatusCode	CreateAPRILCluster (const pandora::Algorithm &algorithm, PandoraContentApi::Cluster::Parameters clusterParameters, const pandora::Cluster *&pCluster)

static pandora::StatusCode	AddToCluster (const pandora::Algorithm &algorithm, const pandora::Cluster const pCluster, const pandora::CaloHitList const pCaloHitList)

static pandora::StatusCode	MergeAndDeleteClusters (const pandora::Algorithm &algorithm, const pandora::Cluster const pClusterToEnlarge, const pandora::Cluster pClusterToDelete)

static pandora::StatusCode	RemoveFromCluster (const pandora::Algorithm &algorithm, const pandora::Cluster const pCluster, const pandora::CaloHit const pCaloHit)

static pandora::StatusCode	RemoveConnector (const april_content::Connector *const pConnector)

template<typename T >
static T *	Modifiable (const T *const pT)
	Alter the object (const_cast<T*>) for internal modification through the API. More...

Static Private Attributes
static april_content::ClusterFactory	m_clusterFactory
	Remove the connection. Destructor not called, the connector responsibility is forwarded to the caller. More...

Detailed Description

APRILContentApi class.

Member Function Documentation

pandora::StatusCode APRILContentApi::AlterMetadata	(	const pandora::Algorithm &	algorithm,
		const april_content::CaloHit *const	pCaloHit,
		const CaloHitMetadata &	caloHitMetadata
	)

static

Alter calo hit meta data.

Parameters

algorithm	to access internal content
pCaloHit	to modify
caloHitMetadata	the input meta data

pandora::StatusCode APRILContentApi::Connect	(	const april_content::CaloHit *const	pCaloHit1,
		const april_content::CaloHit *const	pCaloHit2,
		april_content::ConnectorDirection	direction,
		float	referenceLength = `1.f`,
		unsigned int	creationStage = `-1`
	)

static

Connect the two calo hits in a given direction.

Parameters

pCaloHit1	the first calo hit to connect
pCaloHit2	the second calo hit to connect
direction	the direction of the connection (FORWARD_DIRECTION means that pCaloHit1 will be the "from")
referenceLength	the reference length assigned to the connector

pandora::StatusCode APRILContentApi::Connect	(	const april_content::CaloHit *const	pCaloHit1,
		const april_content::CaloHit *const	pCaloHit2,
		april_content::ConnectorDirection	direction,
		const april_content::Connector *&	pConnector,
		float	referenceLength = `1.f`,
		unsigned int	creationStage = `-1`
	)

static

Connect the two calo hits in a given direction.

Parameters

pCaloHit1	the first calo hit to connect
pCaloHit2	the second calo hit to connect
direction	the direction of the connection (FORWARD_DIRECTION means that pCaloHit1 will be the "from")
pConnector	the connector address to receive
referenceLength	the reference length assigned to the connector

pandora::StatusCode APRILContentApi::EndReclustering	(	const pandora::Algorithm &	algorithm,
		const std::string &	selectedClusterListName
	)

static

End the re-clustering procedure.

Parameters

algorithm	the parent algorithm that run the re-clustering
selectedClusterListName	the name of the selected cluster list

pandora::StatusCode APRILContentApi::FindConnector	(	const april_content::CaloHit *const	pCaloHit1,
		const april_content::CaloHit *const	pCaloHit2,
		const april_content::Connector *&	pConnector
	)

static

Find a connector that links the two calo hits.

Parameters

pCaloHit1	the first calo hit
pCaloHit2	the second calo hit
pConnector	the connector address to receive

pandora::StatusCode APRILContentApi::FindConnector	(	const april_content::CaloHit *const	pCaloHit1,
		const april_content::CaloHit *const	pCaloHit2,
		april_content::ConnectorDirection	direction,
		const april_content::Connector *&	pConnector
	)

static

Find a connector that links the two calo hits in a given direction.

Parameters

pCaloHit1	the first calo hit
pCaloHit2	the second calo hit
direction	the direction in which the two calo hits are connected
pConnector	the connector address to receive

const april_content::ConnectorList & APRILContentApi::GetConnectorList ( const april_content::CaloHit *const pCaloHit )

static

Get the global connector list (backward and forward) of the calo hit.

Parameters

pCaloHit the calo hit to get the connector list

Returns: ConnectorList the connector list (std::set<const Connector*>)

const april_content::ConnectorList & APRILContentApi::GetConnectorList	(	const april_content::CaloHit *const	pCaloHit,
		april_content::ConnectorDirection	direction
	)

static

Get the connector list of a calo hit for a given direction.

Parameters

pCaloHit	the calo hit to get the connector list
direction	the direction of the connector list

Returns: ConnectorList the connector list (std::set<const Connector*>)

bool APRILContentApi::HasAnyConnection ( const april_content::CaloHit *const pCaloHit )

static

Whether the calo hit has at least one connection.

Parameters

pCaloHit the calo hit to test

Returns: boolean

pandora::StatusCode APRILContentApi::InitializeReclustering	(	const pandora::Algorithm &	algorithm,
		const pandora::TrackList &	inputTrackList,
		const pandora::ClusterList &	inputClusterList,
		std::string &	originalClustersListName
	)

static

Initialize APRIL re-clustering. Save calo hit meta data and create a new one for each calo hit.

Parameters

algorithm	the parent algorithm that initializes the re-clustering
inputTrackList	the list of tracks used for re-clustering
inputClusterList	the list of cluster used for re-clustering
originalClustersListName	the list of the original cluster to receive

bool APRILContentApi::IsConnected	(	const april_content::CaloHit *const	pCaloHit1,
		const april_content::CaloHit *const	pCaloHit2
	)

static

Whether the two calo hits are connected (backward or forward directions)

Parameters

pCaloHit1	the first calo hit
pCaloHit2	the second calo hit

Returns: boolean

bool APRILContentApi::IsConnected	(	const april_content::CaloHit *const	pCaloHit1,
		const april_content::CaloHit *const	pCaloHit2,
		april_content::ConnectorDirection	direction
	)

static

Whether the two calo hits are connected in the given direction.

Parameters

pCaloHit1	the first calo hit
pCaloHit2	the second calo hit
direction	the direction in which the calo hits may be connected

Returns: boolean

bool APRILContentApi::IsLeaf ( const april_content::CaloHit *const pCaloHit )

static

Whether the calo hit is a leaf calo hit in the tree.

Parameters

pCaloHit the calo hit to test

Returns: boolean

bool APRILContentApi::IsSeed ( const april_content::CaloHit *const pCaloHit )

static

Whether the calo hit is a seed calo hit in the tree.

Parameters

pCaloHit the calo hit to test

Returns: boolean

bool APRILContentApi::IsTagged	(	const april_content::CaloHit *const	pCaloHit,
		april_content::HitTag	tag
	)

static

Whether the calo hit has been tagged.

Parameters

pCaloHit	the calo hit to test
tag	the reconstruction tag to test

Returns: boolean

template<typename T >

template april_content::Connector * APRILContentApi::Modifiable ( const T *const pT )

static

Alter the object (const_cast<T*>) for internal modification through the API.

Parameters

pT	the object to alter

Returns: T* the altered object

pandora::StatusCode APRILContentApi::PostRunReclusteringAlgorithm	(	const pandora::Algorithm &	algorithm,
		const std::string &	clusterListName
	)

static

Function to call just after a re-clustering algorithm and potential association algorithms.

Parameters

algorithm	the parent algorithm that run the re-clustering algorithm
clusterListName	the name of the cluster list

pandora::StatusCode APRILContentApi::RemoveAndDeleteAllConnections ( const april_content::CaloHit *const pCaloHit )

static

Remove and delete all the connections of the calo hit.

Parameters

pCaloHit the calo hit to remove all connections

pandora::StatusCode APRILContentApi::RemoveAndDeleteConnector ( const april_content::Connector *const pConnector )

static

Remove the connection between the two calo hits and delete the connector.

Parameters

pConnector the connector to remove and delete

pandora::StatusCode APRILContentApi::RemoveConnectionBetween	(	const april_content::CaloHit *const	pCaloHit1,
		const april_content::CaloHit *const	pCaloHit2
	)

static

Remove and delete the connection between the two calo hits.

Parameters

pCaloHit1	the first calo hit to disconnect
pCaloHit2	the second calo hit to disconnect

pandora::StatusCode APRILContentApi::ResetTags ( const april_content::CaloHit *const pCaloHit )

static

Reset the calo hit tags.

Parameters

pCaloHit the calo hit to reset tags

pandora::StatusCode APRILContentApi::RunReclusteringAlgorithm	(	const pandora::Algorithm &	algorithm,
		const std::string &	clusteringAlgorithmName,
		const pandora::ClusterList *&	pNewClusterList,
		std::string &	newClusterListName
	)

static

Run a re-clustering algorithm. Must be called only to run a clustering algorithm in a re-clustering process.

Parameters

algorithm	the parent algorithm running the (re)clustering algorithm
clusteringAlgorithmName	the name of the clustering algorithm
pNewClusterList	the list of created clusters to receive
newClusterListName	the cluster list name to receive

pandora::StatusCode APRILContentApi::Tag	(	const april_content::CaloHit *const	pCaloHit,
		april_content::HitTag	tag,
		bool	value
	)

static

Set the calo hit tag.

Parameters

pCaloHit	the calo hit to tag
tag	the reconstruction tag to apply
value	the tag value to assign

Member Data Documentation

april_content::ClusterFactory APRILContentApi::m_clusterFactory

staticprivate

Remove the connection. Destructor not called, the connector responsibility is forwarded to the caller.

Parameters

pConnector the connector to remove

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

APRILContent/include/APRILApi/APRILContentApi.h
APRILContent/src/APRILApi/APRILContentApi.cc

Classes

Static Public Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation