PandoraContentApiImpl class. More...
#include "PandoraContentApiImpl.h"
Classes | |
| class | ReturnType |
| Return type adaptor. More... | |
Private Member Functions | |
| template<typename T > | |
| ReturnType< T >::Type * | GetManager () const |
| Manager type adaptor. | |
| template<typename OBJECT , typename METADATA > | |
| StatusCode | AlterMetadata (const OBJECT *const pObject, const METADATA &metadata) const |
| Alter the metadata information stored in an object. | |
| template<typename PARAMETERS , typename OBJECT > | |
| StatusCode | Create (const PARAMETERS ¶meters, const OBJECT *&pObject, const ObjectFactory< PARAMETERS, OBJECT > &factory) const |
| Create an object for pandora. | |
| const PandoraSettings * | GetSettings () const |
| Get the pandora settings instance. | |
| const GeometryManager * | GetGeometry () const |
| Get the pandora geometry instance. | |
| const PluginManager * | GetPlugins () const |
| Get the pandora plugin instance, providing access to user registered functions and calculators. | |
| StatusCode | RepeatEventPreparation () const |
| Repeat the event preparation stages, which are used to calculate properties of input objects for later use in algorithms. | |
| StatusCode | CreateAlgorithmTool (TiXmlElement *const pXmlElement, AlgorithmTool *&pAlgorithmTool) const |
| Create an algorithm tool instance, via one of the algorithm tool factories registered with pandora. This function is expected to be called whilst reading the settings for a parent algorithm. | |
| StatusCode | CreateDaughterAlgorithm (TiXmlElement *const pXmlElement, std::string &daughterAlgorithmName) const |
| Create an algorithm instance, via one of the algorithm factories registered with pandora. This function is expected to be called whilst reading the settings for a parent algorithm. | |
| StatusCode | RunAlgorithm (const std::string &algorithmName) const |
| Run an algorithm registered with pandora. | |
| StatusCode | RunClusteringAlgorithm (const Algorithm &algorithm, const std::string &clusteringAlgorithmName, const ClusterList *&pNewClusterList, std::string &newClusterListName) const |
| Run a clustering algorithm (an algorithm that will create new cluster objects) | |
| template<typename T > | |
| StatusCode | GetCurrentList (const T *&pT, std::string &listName) const |
| Get the current list. | |
| template<typename T > | |
| StatusCode | GetCurrentListName (std::string &listName) const |
| Get the current list name. | |
| template<typename T > | |
| StatusCode | ReplaceCurrentList (const Algorithm &algorithm, const std::string &newListName) const |
| Replace the current list with a pre-saved list; use this new list as a permanent replacement for the current list (will persist outside the current algorithm) | |
| template<typename T > | |
| StatusCode | DropCurrentList (const Algorithm &algorithm) const |
| Drop the current list, returning the current list to its default empty/null state. | |
| template<typename T > | |
| StatusCode | GetList (const std::string &listName, const T *&pT) const |
| Get a named list. | |
| template<typename T > | |
| StatusCode | RenameList (const std::string &oldListName, const std::string &newListName) const |
| Rename a saved list, altering its saved name from a specified old list name to a specified new list name. | |
| template<typename T > | |
| StatusCode | SaveList (const T &t, const std::string &newListName) const |
| Save a provided input object list under a new name. | |
| template<typename T > | |
| StatusCode | SaveList (const std::string &newListName) const |
| Save the current list in a list with the specified new name. Note that this will empty the list; the objects will all be moved to the new named list. | |
| template<typename T > | |
| StatusCode | SaveList (const std::string &oldListName, const std::string &newListName) const |
| Save a named list in a list with the specified new name. Note that this will empty the old list; the objects will all be moved to the new named list. | |
| template<typename T > | |
| StatusCode | SaveList (const std::string &newListName, const T &t) const |
| Save elements of the current list in a list with the specified new name. If all the objects in the current list are saved, this will empty the current list; the objects will all be moved to the new named list. | |
| template<typename T > | |
| StatusCode | SaveList (const std::string &oldListName, const std::string &newListName, const T &t) const |
| Save elements of a named list in a list with the specified new name. If all the objects in the old list are saved, this will empty the old list; the objects will all be moved to the new named list. | |
| template<typename T > | |
| StatusCode | TemporarilyReplaceCurrentList (const std::string &newListName) const |
| Temporarily replace the current list with another list, which may only be a temporary list. This switch will persist only for the duration of the algorithm and its daughters; unless otherwise specified, the current list will revert to the algorithm input list upon algorithm completion. | |
| template<typename T > | |
| StatusCode | CreateTemporaryListAndSetCurrent (const Algorithm &algorithm, const T *&pT, std::string &temporaryListName) const |
| Create a temporary list and set it to be the current list, enabling object creation. | |
| template<typename T > | |
| bool | IsAvailable (const T *const pT) const |
| Is object, or a list of objects, available as a building block. | |
| template<typename T > | |
| StatusCode | Delete (const T *const pT) const |
| Delete an object from the current list. | |
| template<typename T > | |
| StatusCode | Delete (const T *const pT, const std::string &listName) const |
| Delete an object from a specified list. | |
| template<typename T > | |
| StatusCode | AddToCluster (const Cluster *const pCluster, const T *const pT) const |
| Add a calo hit, or a list of calo hits, to a cluster. | |
| StatusCode | RemoveFromCluster (const Cluster *const pCluster, const CaloHit *const pCaloHit) const |
| Remove a calo hit from a cluster. Note this function will not remove the final calo hit from a cluster, and will instead return status code "not allowed" as a prompt to delete the cluster. | |
| template<typename T > | |
| StatusCode | AddIsolatedToCluster (const Cluster *const pCluster, const T *const pT) const |
| Add an isolated calo hit, or a list of isolated calo hits, to a cluster. An isolated calo hit is not counted as a regular calo hit: it contributes only towards the cluster energy and does not affect any other cluster properties. | |
| StatusCode | RemoveIsolatedFromCluster (const Cluster *const pCluster, const CaloHit *const pCaloHit) const |
| Remove an isolated calo hit from a cluster. Note this function will not remove the final calo hit from a cluster, and will instead return status code "not allowed" as a prompt to delete the cluster. | |
| StatusCode | Fragment (const CaloHit *const pOriginalCaloHit, const float fraction1, const CaloHit *&pDaughterCaloHit1, const CaloHit *&pDaughterCaloHit2, const ObjectFactory< object_creation::CaloHitFragment::Parameters, object_creation::CaloHitFragment::Object > &factory) const |
| Fragment a calo hit into two daughter calo hits, with a specified energy division. | |
| StatusCode | MergeFragments (const CaloHit *const pFragmentCaloHit1, const CaloHit *const pFragmentCaloHit2, const CaloHit *&pMergedCaloHit, const ObjectFactory< object_creation::CaloHitFragment::Parameters, object_creation::CaloHitFragment::Object > &factory) const |
| Merge two calo hit fragments, originally from the same parent hit, to form a new calo hit. | |
| StatusCode | AddTrackClusterAssociation (const Track *const pTrack, const Cluster *const pCluster) const |
| Add an association between a track and a cluster. | |
| StatusCode | RemoveTrackClusterAssociation (const Track *const pTrack, const Cluster *const pCluster) const |
| Remove an association between a track and a cluster. | |
| StatusCode | RemoveCurrentTrackClusterAssociations () const |
| Remove all track-cluster associations from objects in the current track and cluster lists. | |
| StatusCode | RemoveAllTrackClusterAssociations () const |
| Remove all associations between tracks and clusters. | |
| StatusCode | RepeatMCParticlePreparation () const |
| Repeat the mc particle preparation, performing pfo target identification and forming relationships with tracks/calo hits. | |
| StatusCode | RemoveAllMCParticleRelationships () const |
| Remove all mc particle relationships previously registered with the mc manager and linked to tracks/calo hits. | |
| StatusCode | MergeAndDeleteClusters (const Cluster *const pClusterToEnlarge, const Cluster *const pClusterToDelete) const |
| Merge two clusters in the current list, enlarging one cluster and deleting the second. | |
| StatusCode | MergeAndDeleteClusters (const Cluster *const pClusterToEnlarge, const Cluster *const pClusterToDelete, const std::string &enlargeListName, const std::string &deleteListName) const |
| Merge two clusters from two specified lists, enlarging one cluster and deleting the second. | |
| template<typename T > | |
| StatusCode | AddToPfo (const ParticleFlowObject *const pPfo, const T *const pT) const |
| Add a cluster to a particle flow object. | |
| template<typename T > | |
| StatusCode | RemoveFromPfo (const ParticleFlowObject *const pPfo, const T *const pT) const |
| Remove a cluster from a particle flow object. Note this function will not remove the final object (track or cluster) from a particle flow object, and will instead return status code "not allowed" as a prompt to delete the cluster. | |
| StatusCode | SetPfoParentDaughterRelationship (const ParticleFlowObject *const pParentPfo, const ParticleFlowObject *const pDaughterPfo) const |
| Set parent-daughter particle flow object relationship. | |
| StatusCode | RemovePfoParentDaughterRelationship (const ParticleFlowObject *const pParentPfo, const ParticleFlowObject *const pDaughterPfo) const |
| Remove parent-daughter particle flow object relationship. | |
| StatusCode | InitializeFragmentation (const Algorithm &algorithm, const ClusterList &inputClusterList, std::string &originalClustersListName, std::string &fragmentClustersListName) const |
| Initialize cluster fragmentation operations on clusters in the algorithm input list. This allows hits in a list of clusters (a subset of the algorithm input list) to be redistributed. | |
| StatusCode | EndFragmentation (const Algorithm &algorithm, const std::string &clusterListToSaveName, const std::string &clusterListToDeleteName) const |
| End cluster fragmentation operations on clusters in the algorithm input list. | |
| StatusCode | InitializeReclustering (const Algorithm &algorithm, const TrackList &inputTrackList, const ClusterList &inputClusterList, std::string &originalClustersListName) const |
| Initialize reclustering operations on clusters in the algorithm input list. This allows hits in a list of clusters (a subset of the algorithm input list) to be redistributed. | |
| StatusCode | EndReclustering (const Algorithm &algorithm, const std::string &selectedClusterListName) const |
| End reclustering operations on clusters in the algorithm input list. | |
| PandoraContentApiImpl (Pandora *const pPandora) | |
| Constructor. | |
| bool | IsAddToClusterAllowed (const Cluster *const pCluster, const CaloHit *const pCaloHit) const |
| Whether a proposed addition to a cluster is allowed. | |
| template<typename T > | |
| StatusCode | PrepareForDeletion (const T *const pT) const |
| Prepare an object, or a list of objects, for deletion. | |
| template<typename T > | |
| StatusCode | PrepareForReclusteringDeletion (const T *const pT) const |
| Prepare an object, or a list of objects, (formed as recluster candidates) for deletion. | |
| StatusCode | PreRunAlgorithm (Algorithm *const pAlgorithm) const |
| Perform necessary operations prior to algorithm execution, e.g. algorithm to manager handshakes. | |
| StatusCode | PostRunAlgorithm (Algorithm *const pAlgorithm) const |
| Perform necessary operations after algorithm execution, e.g. preparing temporaries for deletion. | |
Private Attributes | |
| Pandora * | m_pPandora |
| The pandora object to provide an interface to. | |
Friends | |
| class | Pandora |
| class | PandoraImpl |
| class | ::PandoraContentApi |
| template<typename PARAMETERS , typename METADATA , typename OBJECT > | |
| class | ::object_creation::ObjectCreationHelper |
Detailed Description
PandoraContentApiImpl class.
Definition at line 26 of file PandoraContentApiImpl.h.
Class Documentation
◆ pandora::PandoraContentApiImpl::ReturnType
| class pandora::PandoraContentApiImpl::ReturnType |
Constructor & Destructor Documentation
◆ PandoraContentApiImpl()
Constructor.
- Parameters
-
pPandora address of the pandora object to interface
Definition at line 609 of file PandoraContentApiImpl.cc.
Member Function Documentation
◆ AddIsolatedToCluster() [1/3]
◆ AddIsolatedToCluster() [2/3]
| StatusCode pandora::PandoraContentApiImpl::AddIsolatedToCluster | ( | const Cluster *const | pCluster, |
| const CaloHitList *const | pCaloHitList | ||
| ) | const |
◆ AddIsolatedToCluster() [3/3]
|
private |
Add an isolated calo hit, or a list of isolated calo hits, to a cluster. An isolated calo hit is not counted as a regular calo hit: it contributes only towards the cluster energy and does not affect any other cluster properties.
- Parameters
-
pCluster address of the cluster to modify pT address of the isolated calo hit, or list of isolated calo hits, to add
◆ AddToCluster() [1/3]
◆ AddToCluster() [2/3]
| StatusCode pandora::PandoraContentApiImpl::AddToCluster | ( | const Cluster *const | pCluster, |
| const CaloHitList *const | pCaloHitList | ||
| ) | const |
◆ AddToCluster() [3/3]
|
private |
Add a calo hit, or a list of calo hits, to a cluster.
- Parameters
-
pCluster address of the cluster to modify pT address of the calo hit, or list of calo hits, to add
◆ AddToPfo()
|
private |
Add a cluster to a particle flow object.
- Parameters
-
pPfo address of the particle flow object to modify pCluster address of the cluster to add
Definition at line 571 of file PandoraContentApiImpl.cc.
◆ AddTrackClusterAssociation()
|
private |
Add an association between a track and a cluster.
- Parameters
-
pTrack address of the track pCluster address of the cluster
Definition at line 486 of file PandoraContentApiImpl.cc.
◆ AlterMetadata() [1/5]
| StatusCode pandora::PandoraContentApiImpl::AlterMetadata | ( | const CaloHit *const | pObject, |
| const object_creation::CaloHit::Metadata & | metadata | ||
| ) | const |
◆ AlterMetadata() [2/5]
| StatusCode pandora::PandoraContentApiImpl::AlterMetadata | ( | const Cluster *const | pObject, |
| const object_creation::Cluster::Metadata & | metadata | ||
| ) | const |
◆ AlterMetadata() [3/5]
|
private |
Alter the metadata information stored in an object.
- Parameters
-
algorithm the algorithm calling this function pObject address of the object to modify metaData the metadata (only populated metadata fields will be propagated to the object)
Definition at line 95 of file PandoraContentApiImpl.cc.
◆ AlterMetadata() [4/5]
| StatusCode pandora::PandoraContentApiImpl::AlterMetadata | ( | const ParticleFlowObject *const | pObject, |
| const object_creation::ParticleFlowObject::Metadata & | metadata | ||
| ) | const |
◆ AlterMetadata() [5/5]
| StatusCode pandora::PandoraContentApiImpl::AlterMetadata | ( | const Vertex *const | pObject, |
| const object_creation::Vertex::Metadata & | metadata | ||
| ) | const |
◆ Create() [1/7]
| StatusCode pandora::PandoraContentApiImpl::Create | ( | const object_creation::CaloHit::Parameters & | parameters, |
| const CaloHit *& | pObject, | ||
| const pandora::ObjectFactory< object_creation::CaloHit::Parameters, object_creation::CaloHit::Object > & | factory | ||
| ) | const |
◆ Create() [2/7]
| StatusCode pandora::PandoraContentApiImpl::Create | ( | const object_creation::Cluster::Parameters & | parameters, |
| const Cluster *& | pCluster, | ||
| const pandora::ObjectFactory< object_creation::Cluster::Parameters, object_creation::Cluster::Object > & | factory | ||
| ) | const |
◆ Create() [3/7]
| StatusCode pandora::PandoraContentApiImpl::Create | ( | const object_creation::MCParticle::Parameters & | parameters, |
| const MCParticle *& | pObject, | ||
| const pandora::ObjectFactory< object_creation::MCParticle::Parameters, object_creation::MCParticle::Object > & | factory | ||
| ) | const |
◆ Create() [4/7]
| StatusCode pandora::PandoraContentApiImpl::Create | ( | const object_creation::ParticleFlowObject::Parameters & | pfoParameters, |
| const ParticleFlowObject *& | pPfo, | ||
| const pandora::ObjectFactory< object_creation::ParticleFlowObject::Parameters, object_creation::ParticleFlowObject::Object > & | factory | ||
| ) | const |
◆ Create() [5/7]
| StatusCode pandora::PandoraContentApiImpl::Create | ( | const object_creation::Track::Parameters & | parameters, |
| const Track *& | pObject, | ||
| const pandora::ObjectFactory< object_creation::Track::Parameters, object_creation::Track::Object > & | factory | ||
| ) | const |
◆ Create() [6/7]
| StatusCode pandora::PandoraContentApiImpl::Create | ( | const object_creation::Vertex::Parameters & | parameters, |
| const Vertex *& | pObject, | ||
| const pandora::ObjectFactory< object_creation::Vertex::Parameters, object_creation::Vertex::Object > & | factory | ||
| ) | const |
◆ Create() [7/7]
|
private |
Create an object for pandora.
- Parameters
-
parameters the object parameters pObject to receive the address of the object created factory the factory that performs the object allocation
Definition at line 167 of file PandoraContentApiImpl.cc.
◆ CreateAlgorithmTool()
|
private |
Create an algorithm tool instance, via one of the algorithm tool factories registered with pandora. This function is expected to be called whilst reading the settings for a parent algorithm.
- Parameters
-
pXmlElement address of the xml element describing the algorithm tool type and settings pAlgorithmTool to receive the address of the algorithm tool instance
Definition at line 202 of file PandoraContentApiImpl.cc.
◆ CreateDaughterAlgorithm()
|
private |
Create an algorithm instance, via one of the algorithm factories registered with pandora. This function is expected to be called whilst reading the settings for a parent algorithm.
- Parameters
-
pXmlElement address of the xml element describing the daughter algorithm type and settings daughterAlgorithmName to receive the name of the daughter algorithm instance
Definition at line 209 of file PandoraContentApiImpl.cc.
◆ CreateTemporaryListAndSetCurrent()
|
private |
Create a temporary list and set it to be the current list, enabling object creation.
- Parameters
-
algorithm the algorithm calling this function pT to receive the address of the temporary list temporaryListName to receive the temporary list name
Definition at line 374 of file PandoraContentApiImpl.cc.
◆ Delete() [1/5]
| StatusCode pandora::PandoraContentApiImpl::Delete | ( | const ClusterList *const | pT, |
| const std::string & | listName | ||
| ) | const |
◆ Delete() [2/5]
| StatusCode pandora::PandoraContentApiImpl::Delete | ( | const PfoList *const | pT, |
| const std::string & | listName | ||
| ) | const |
◆ Delete() [3/5]
|
private |
Delete an object from the current list.
- Parameters
-
pT address of the object, or a list of objects, to delete
Definition at line 725 of file PandoraContentApiImpl.cc.
◆ Delete() [4/5]
|
private |
Delete an object from a specified list.
- Parameters
-
pT address of the object, or a list of objects, to delete listName name of the list containing the object
Definition at line 735 of file PandoraContentApiImpl.cc.
◆ Delete() [5/5]
| StatusCode pandora::PandoraContentApiImpl::Delete | ( | const VertexList *const | pT, |
| const std::string & | listName | ||
| ) | const |
◆ DropCurrentList()
|
private |
Drop the current list, returning the current list to its default empty/null state.
- Parameters
-
algorithm the algorithm calling this function
Definition at line 298 of file PandoraContentApiImpl.cc.
◆ EndFragmentation()
|
private |
End cluster fragmentation operations on clusters in the algorithm input list.
- Parameters
-
algorithm the algorithm calling this function clusterListToSaveName the name of the list containing the clusters chosen to be saved (original or fragments) clusterListToDeleteName the name of the list containing the clusters chosen to be deleted (original or fragments)
Definition at line 780 of file PandoraContentApiImpl.cc.
◆ EndReclustering()
|
private |
End reclustering operations on clusters in the algorithm input list.
- Parameters
-
algorithm the algorithm calling this function selectedClusterListName the name of the list containing the chosen recluster candidates (or the original candidates)
Definition at line 815 of file PandoraContentApiImpl.cc.
◆ Fragment()
|
private |
Fragment a calo hit into two daughter calo hits, with a specified energy division.
- Parameters
-
pOriginalCaloHit address of the original calo hit, which will be deleted fraction1 the fraction of energy to be assigned to daughter fragment 1 pDaughterCaloHit1 to receive the address of daughter fragment 1 pDaughterCaloHit2 to receive the address of daughter fragment 2 factory to create the fragmented calo hits
Definition at line 470 of file PandoraContentApiImpl.cc.
◆ GetCurrentList()
|
private |
Get the current list.
- Parameters
-
pT to receive the address of the current list listName to receive the current list name
Definition at line 274 of file PandoraContentApiImpl.cc.
◆ GetCurrentListName()
|
private |
Get the current list name.
- Parameters
-
listName to receive the current list name
Definition at line 282 of file PandoraContentApiImpl.cc.
◆ GetGeometry()
|
private |
Get the pandora geometry instance.
- Returns
- the address of the pandora geometry instance
Definition at line 181 of file PandoraContentApiImpl.cc.
◆ GetList()
|
private |
Get a named list.
- Parameters
-
listName the name of the list pT to receive the address of the list
Definition at line 306 of file PandoraContentApiImpl.cc.
◆ GetManager()
|
private |
Manager type adaptor.
- Returns
- the address of the manager
◆ GetPlugins()
|
private |
Get the pandora plugin instance, providing access to user registered functions and calculators.
- Returns
- the address of the pandora plugin instance
Definition at line 188 of file PandoraContentApiImpl.cc.
◆ GetSettings()
|
private |
Get the pandora settings instance.
- Returns
- the address of the pandora settings instance
Definition at line 174 of file PandoraContentApiImpl.cc.
◆ InitializeFragmentation()
|
private |
Initialize cluster fragmentation operations on clusters in the algorithm input list. This allows hits in a list of clusters (a subset of the algorithm input list) to be redistributed.
- Parameters
-
algorithm the algorithm calling this function inputClusterList the input cluster list originalClustersListName to receive the name of the list in which the original clusters are stored fragmentClustersListName to receive the name of the list in which the fragment clusters are stored
Definition at line 764 of file PandoraContentApiImpl.cc.
◆ InitializeReclustering()
|
private |
Initialize reclustering operations on clusters in the algorithm input list. This allows hits in a list of clusters (a subset of the algorithm input list) to be redistributed.
- Parameters
-
algorithm the algorithm calling this function inputTrackList the input track list inputClusterList the input cluster list originalClustersListName to receive the name of the list in which the original clusters are stored
Definition at line 800 of file PandoraContentApiImpl.cc.
◆ IsAddToClusterAllowed()
|
private |
Whether a proposed addition to a cluster is allowed.
- Parameters
-
pCluster address of the cluster to modify pCaloHit address of the hit to add
- Returns
- boolean
Definition at line 616 of file PandoraContentApiImpl.cc.
◆ IsAvailable()
|
private |
Is object, or a list of objects, available as a building block.
- Parameters
-
pT address of the object
- Returns
- boolean
Definition at line 383 of file PandoraContentApiImpl.cc.
◆ MergeAndDeleteClusters() [1/2]
|
private |
Merge two clusters in the current list, enlarging one cluster and deleting the second.
- Parameters
-
pClusterToEnlarge address of the cluster to enlarge pClusterToDelete address of the cluster to delete
Definition at line 546 of file PandoraContentApiImpl.cc.
◆ MergeAndDeleteClusters() [2/2]
|
private |
Merge two clusters from two specified lists, enlarging one cluster and deleting the second.
- Parameters
-
pClusterToEnlarge address of the cluster to enlarge pClusterToDelete address of the cluster to delete enlargeListName name of the list containing the cluster to enlarge deleteListName name of the list containing the cluster to delete
Definition at line 555 of file PandoraContentApiImpl.cc.
◆ MergeFragments()
|
private |
Merge two calo hit fragments, originally from the same parent hit, to form a new calo hit.
- Parameters
-
pFragmentCaloHit1 address of calo hit fragment 1, which will be deleted pFragmentCaloHit2 address of calo hit fragment 2, which will be deleted pMergedCaloHit to receive the address of the merged calo hit factory to create the merged calo hit fragment
Definition at line 478 of file PandoraContentApiImpl.cc.
◆ PostRunAlgorithm()
|
private |
Perform necessary operations after algorithm execution, e.g. preparing temporaries for deletion.
- Parameters
-
pAlgorithm address of the algorithm
Definition at line 849 of file PandoraContentApiImpl.cc.
◆ PrepareForDeletion() [1/4]
| StatusCode pandora::PandoraContentApiImpl::PrepareForDeletion | ( | const ClusterList *const | pClusterList | ) | const |
◆ PrepareForDeletion() [2/4]
| StatusCode pandora::PandoraContentApiImpl::PrepareForDeletion | ( | const PfoList *const | pPfoList | ) | const |
◆ PrepareForDeletion() [3/4]
|
private |
Prepare an object, or a list of objects, for deletion.
- Parameters
-
pT address of the object, or list of objects, to prepare for deletion
Definition at line 647 of file PandoraContentApiImpl.cc.
◆ PrepareForDeletion() [4/4]
| StatusCode pandora::PandoraContentApiImpl::PrepareForDeletion | ( | const VertexList *const | pVertexList | ) | const |
◆ PrepareForReclusteringDeletion() [1/2]
| StatusCode pandora::PandoraContentApiImpl::PrepareForReclusteringDeletion | ( | const ClusterList *const | pClusterList | ) | const |
◆ PrepareForReclusteringDeletion() [2/2]
|
private |
Prepare an object, or a list of objects, (formed as recluster candidates) for deletion.
- Parameters
-
pT address of the object, or list of objects, to prepare for deletion
◆ PreRunAlgorithm()
|
private |
Perform necessary operations prior to algorithm execution, e.g. algorithm to manager handshakes.
- Parameters
-
pAlgorithm address of the algorithm
Definition at line 835 of file PandoraContentApiImpl.cc.
◆ RemoveAllMCParticleRelationships()
|
private |
Remove all mc particle relationships previously registered with the mc manager and linked to tracks/calo hits.
Definition at line 535 of file PandoraContentApiImpl.cc.
◆ RemoveAllTrackClusterAssociations()
|
private |
Remove all associations between tracks and clusters.
Definition at line 525 of file PandoraContentApiImpl.cc.
◆ RemoveCurrentTrackClusterAssociations()
|
private |
Remove all track-cluster associations from objects in the current track and cluster lists.
Definition at line 506 of file PandoraContentApiImpl.cc.
◆ RemoveFromCluster()
|
private |
Remove a calo hit from a cluster. Note this function will not remove the final calo hit from a cluster, and will instead return status code "not allowed" as a prompt to delete the cluster.
- Parameters
-
pCluster address of the cluster to modify pCaloHit address of the hit to remove
Definition at line 417 of file PandoraContentApiImpl.cc.
◆ RemoveFromPfo()
|
private |
Remove a cluster from a particle flow object. Note this function will not remove the final object (track or cluster) from a particle flow object, and will instead return status code "not allowed" as a prompt to delete the cluster.
- Parameters
-
pPfo address of the particle flow object to modify pCluster address of the cluster to remove
Definition at line 585 of file PandoraContentApiImpl.cc.
◆ RemoveIsolatedFromCluster()
|
private |
Remove an isolated calo hit from a cluster. Note this function will not remove the final calo hit from a cluster, and will instead return status code "not allowed" as a prompt to delete the cluster.
- Parameters
-
pCluster address of the cluster to modify pCaloHit address of the isolated hit to remove
Definition at line 457 of file PandoraContentApiImpl.cc.
◆ RemovePfoParentDaughterRelationship()
|
private |
Remove parent-daughter particle flow object relationship.
- Parameters
-
pParentPfo address of parent particle flow object pDaughterPfo address of daughter particle flow object
Definition at line 602 of file PandoraContentApiImpl.cc.
◆ RemoveTrackClusterAssociation()
|
private |
Remove an association between a track and a cluster.
- Parameters
-
pTrack address of the track pCluster address of the cluster
Definition at line 496 of file PandoraContentApiImpl.cc.
◆ RenameList()
|
private |
Rename a saved list, altering its saved name from a specified old list name to a specified new list name.
- Parameters
-
oldListName the old list name newListName the new list name
Definition at line 314 of file PandoraContentApiImpl.cc.
◆ RepeatEventPreparation()
|
private |
Repeat the event preparation stages, which are used to calculate properties of input objects for later use in algorithms.
Definition at line 195 of file PandoraContentApiImpl.cc.
◆ RepeatMCParticlePreparation()
|
private |
Repeat the mc particle preparation, performing pfo target identification and forming relationships with tracks/calo hits.
◆ ReplaceCurrentList()
|
private |
Replace the current list with a pre-saved list; use this new list as a permanent replacement for the current list (will persist outside the current algorithm)
- Parameters
-
algorithm the algorithm calling this function newListName the name of the replacement list
Definition at line 290 of file PandoraContentApiImpl.cc.
◆ RunAlgorithm()
|
private |
Run an algorithm registered with pandora.
- Parameters
-
algorithmName the algorithm name
Definition at line 216 of file PandoraContentApiImpl.cc.
◆ RunClusteringAlgorithm()
|
private |
Run a clustering algorithm (an algorithm that will create new cluster objects)
- Parameters
-
algorithm the algorithm calling this function clusteringAlgorithmName the name of the clustering algorithm to run pNewClusterList the address of the new cluster list populated newClusterListName the name of the new cluster list populated
Definition at line 260 of file PandoraContentApiImpl.cc.
◆ SaveList() [1/5]
|
private |
Save the current list in a list with the specified new name. Note that this will empty the list; the objects will all be moved to the new named list.
- Parameters
-
newListName the new list name
Definition at line 330 of file PandoraContentApiImpl.cc.
◆ SaveList() [2/5]
|
private |
Save elements of the current list in a list with the specified new name. If all the objects in the current list are saved, this will empty the current list; the objects will all be moved to the new named list.
- Parameters
-
newListName the new list name t a subset of the current object list - only objects in both this and the current list will be saved
Definition at line 348 of file PandoraContentApiImpl.cc.
◆ SaveList() [3/5]
|
private |
Save a named list in a list with the specified new name. Note that this will empty the old list; the objects will all be moved to the new named list.
- Parameters
-
oldListName the old list name newListName the new list name
Definition at line 340 of file PandoraContentApiImpl.cc.
◆ SaveList() [4/5]
|
private |
Save elements of a named list in a list with the specified new name. If all the objects in the old list are saved, this will empty the old list; the objects will all be moved to the new named list.
- Parameters
-
oldClusterListName the old cluster list name newClusterListName the new cluster list name t a subset of the old object list - only objects in both this and the old list will be saved
Definition at line 358 of file PandoraContentApiImpl.cc.
◆ SaveList() [5/5]
|
private |
Save a provided input object list under a new name.
- Parameters
-
t the provided input object list newListName the new list name
Definition at line 322 of file PandoraContentApiImpl.cc.
◆ SetPfoParentDaughterRelationship()
|
private |
Set parent-daughter particle flow object relationship.
- Parameters
-
pParentPfo address of parent particle flow object pDaughterPfo address of daughter particle flow object
Definition at line 595 of file PandoraContentApiImpl.cc.
◆ TemporarilyReplaceCurrentList()
|
private |
Temporarily replace the current list with another list, which may only be a temporary list. This switch will persist only for the duration of the algorithm and its daughters; unless otherwise specified, the current list will revert to the algorithm input list upon algorithm completion.
- Parameters
-
newListName the name of the replacement list
Definition at line 366 of file PandoraContentApiImpl.cc.
Friends And Related Symbol Documentation
◆ ::object_creation::ObjectCreationHelper
Definition at line 568 of file PandoraContentApiImpl.h.
◆ ::PandoraContentApi
|
friend |
Definition at line 567 of file PandoraContentApiImpl.h.
◆ Pandora
Definition at line 565 of file PandoraContentApiImpl.h.
◆ PandoraImpl
|
friend |
Definition at line 566 of file PandoraContentApiImpl.h.
Member Data Documentation
◆ m_pPandora
|
private |
The pandora object to provide an interface to.
Definition at line 563 of file PandoraContentApiImpl.h.
The documentation for this class was generated from the following files:
- PandoraSDK/include/Api/PandoraContentApiImpl.h
- PandoraSDK/src/Api/PandoraContentApiImpl.cc