ClusterSplittingAlgorithm class. More...

#include <ClusterSplittingAlgorithm.h>

Inheritance diagram for lar_content::ClusterSplittingAlgorithm:

Protected Member Functions
virtual pandora::StatusCode	Run ()

virtual pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

pandora::StatusCode	RunUsingCurrentList () const
	Run the algorithm using the current cluster list as input. More...

virtual pandora::StatusCode	DivideCaloHits (const pandora::Cluster *const pCluster, pandora::CaloHitList &firstCaloHitList, pandora::CaloHitList &secondCaloHitList) const =0
	Divide calo hits in a cluster into two lists, each associated with a separate fragment cluster. More...

Private Member Functions
pandora::StatusCode	SplitCluster (const pandora::Cluster *const pCluster, pandora::ClusterList &clusterSplittingList) const
	Split cluster into two fragments. More...

Private Attributes
pandora::StringVector	m_inputClusterListNames
	The list of input cluster list names - if empty, use the current cluster list. More...

Detailed Description

ClusterSplittingAlgorithm class.

Definition at line 21 of file ClusterSplittingAlgorithm.h.

Member Function Documentation

virtual pandora::StatusCode lar_content::ClusterSplittingAlgorithm::DivideCaloHits	(	const pandora::Cluster *const	pCluster,
		pandora::CaloHitList &	firstCaloHitList,
		pandora::CaloHitList &	secondCaloHitList
	)		const

protectedpure virtual

Divide calo hits in a cluster into two lists, each associated with a separate fragment cluster.

Parameters

pCluster	address of the cluster
firstCaloHitList	the hits in the first fragment
secondCaloHitList	the hits in the second fragment

Implemented in lar_content::TwoDSlidingFitSplittingAlgorithm, and lar_content::LayerSplittingAlgorithm.

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

protectedvirtual

Reimplemented in lar_content::TwoDSlidingFitSplittingAlgorithm, lar_content::VertexSplittingAlgorithm, lar_content::KinkSplittingAlgorithm, and lar_content::LayerSplittingAlgorithm.

Definition at line 111 of file ClusterSplittingAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadVectorOfValues(xmlHandle, "InputClusterListNames", m_inputClusterListNames));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::ClusterSplittingAlgorithm::Run ( )

protectedvirtual

Definition at line 20 of file ClusterSplittingAlgorithm.cc.

 {
     if (m_inputClusterListNames.empty())
         return this->RunUsingCurrentList();
 
     std::string originalListName;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentListName<Cluster>(*this, originalListName));
 
     for (const std::string &clusterListName : m_inputClusterListNames)
     {
         const StatusCode listChangeStatusCode(PandoraContentApi::ReplaceCurrentList<Cluster>(*this, clusterListName));
 
         if (STATUS_CODE_NOT_FOUND == listChangeStatusCode)
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "ClusterSplittingAlgorithm: cluster list not found " << clusterListName << std::endl;
 
             continue;
         }
 
         if (STATUS_CODE_SUCCESS != listChangeStatusCode)
             return listChangeStatusCode;
 
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->RunUsingCurrentList());
     }
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Cluster>(*this, originalListName));
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::ClusterSplittingAlgorithm::RunUsingCurrentList ( ) const

protected

Run the algorithm using the current cluster list as input.

Definition at line 52 of file ClusterSplittingAlgorithm.cc.

 {
     const ClusterList *pClusterList = NULL;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pClusterList));
 
     ClusterList internalClusterList(pClusterList->begin(), pClusterList->end());
     internalClusterList.sort(LArClusterHelper::SortByNHits);
 
     for (ClusterList::iterator iter = internalClusterList.begin(); iter != internalClusterList.end(); ++iter)
     {
         const Cluster *const pCluster = *iter;
         ClusterList clusterSplittingList;
 
         if (STATUS_CODE_SUCCESS != this->SplitCluster(pCluster, clusterSplittingList))
             continue;
 
         internalClusterList.splice(internalClusterList.end(), clusterSplittingList);
         *iter = NULL;
     }
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::ClusterSplittingAlgorithm::SplitCluster	(	const pandora::Cluster *const	pCluster,
		pandora::ClusterList &	clusterSplittingList
	)		const

private

Split cluster into two fragments.

Parameters

pCluster	address of the cluster
clusterSplittingList	to receive the two cluster fragments

Definition at line 77 of file ClusterSplittingAlgorithm.cc.

 {
     // Split cluster into two CaloHit lists
     PandoraContentApi::Cluster::Parameters firstParameters, secondParameters;
 
     if (STATUS_CODE_SUCCESS != this->DivideCaloHits(pCluster, firstParameters.m_caloHitList, secondParameters.m_caloHitList))
         return STATUS_CODE_NOT_FOUND;
 
     if (firstParameters.m_caloHitList.empty() || secondParameters.m_caloHitList.empty())
         return STATUS_CODE_NOT_ALLOWED;
 
     // Begin cluster fragmentation operations
     const ClusterList clusterList(1, pCluster);
     std::string clusterListToSaveName, clusterListToDeleteName;
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::InitializeFragmentation(*this, clusterList, clusterListToDeleteName, clusterListToSaveName));
 
     // Create new clusters
     const Cluster *pFirstCluster(NULL), *pSecondCluster(NULL);
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::Create(*this, firstParameters, pFirstCluster));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::Create(*this, secondParameters, pSecondCluster));
 
     clusterSplittingList.push_back(pFirstCluster);
     clusterSplittingList.push_back(pSecondCluster);
 
     // End cluster fragmentation operations
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::EndFragmentation(*this, clusterListToSaveName, clusterListToDeleteName));
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

pandora::StringVector lar_content::ClusterSplittingAlgorithm::m_inputClusterListNames

private

The list of input cluster list names - if empty, use the current cluster list.

Definition at line 51 of file ClusterSplittingAlgorithm.h.

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

larpandoracontent/larpandoracontent/LArTwoDReco/LArClusterSplitting/ClusterSplittingAlgorithm.h
larpandoracontent/larpandoracontent/LArTwoDReco/LArClusterSplitting/ClusterSplittingAlgorithm.cc

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation