ClusteringParentAlgorithm class. More...

#include <ClusteringParentAlgorithm.h>

Inheritance diagram for lar_content::ClusteringParentAlgorithm:

Public Member Functions
	ClusteringParentAlgorithm ()
	Default constructor. More...

Private Member Functions
pandora::StatusCode	Run ()

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

Private Attributes
std::string	m_clusteringAlgorithmName
	The name of the clustering algorithm to run. More...

std::string	m_associationAlgorithmName
	The name of the topological association algorithm to run. More...

std::string	m_inputCaloHitListName
	The name of the input calo hit list, containing the hits to be clustered. More...

bool	m_replaceCurrentCaloHitList
	Whether to permanently replace the original calo hit list as the "current" list upon completion. More...

std::string	m_clusterListName
	The name under which to save the new cluster list. More...

bool	m_replaceCurrentClusterList
	Whether to subsequently use the new cluster list as the "current" list. More...

Detailed Description

ClusteringParentAlgorithm class.

Definition at line 19 of file ClusteringParentAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ClusteringParentAlgorithm::ClusteringParentAlgorithm ( )

Default constructor.

Definition at line 18 of file ClusteringParentAlgorithm.cc.

                                                      : m_replaceCurrentCaloHitList(false), m_replaceCurrentClusterList(true)
 {
 }

Member Function Documentation

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

private

Definition at line 76 of file ClusteringParentAlgorithm.cc.

 {
     // Daughter algorithm parameters
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithm(*this, xmlHandle, "ClusterFormation", m_clusteringAlgorithmName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ProcessAlgorithm(*this, xmlHandle, "ClusterAssociation", m_associationAlgorithmName));
 
     // Input parameters: name of input calo hit list and whether it should persist as the current list after algorithm has finished
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "InputCaloHitListName", m_inputCaloHitListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ReplaceCurrentCaloHitList", m_replaceCurrentCaloHitList));
 
     // Output parameters: name of output cluster list and whether it should subsequently be used as the current list
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ClusterListName", m_clusterListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ReplaceCurrentClusterList", m_replaceCurrentClusterList));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::ClusteringParentAlgorithm::Run ( )

private

Definition at line 24 of file ClusteringParentAlgorithm.cc.

 {
     // If specified, change the current calo hit list, i.e. the input to the clustering algorithm
     std::string originalCaloHitListName;
 
     if (!m_inputCaloHitListName.empty())
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentListName<CaloHit>(*this, originalCaloHitListName));
         const StatusCode statusCode(PandoraContentApi::ReplaceCurrentList<CaloHit>(*this, m_inputCaloHitListName));
 
         if (STATUS_CODE_NOT_FOUND == statusCode)
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "ClusteringParentAlgorithm: calohit list not found " << m_inputCaloHitListName << std::endl;
 
             return STATUS_CODE_SUCCESS;
         }
 
         if (STATUS_CODE_SUCCESS != statusCode)
             return statusCode;
     }
 
     // Run the initial cluster formation algorithm
     const ClusterList *pClusterList = NULL;
     std::string newClusterListName;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::RunClusteringAlgorithm(*this, m_clusteringAlgorithmName, pClusterList, newClusterListName));
 
     // Run the topological association algorithms to modify clusters
     if (!pClusterList->empty() && !m_associationAlgorithmName.empty())
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::RunDaughterAlgorithm(*this, m_associationAlgorithmName));
 
     // Save the new cluster list
     if (!pClusterList->empty())
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Cluster>(*this, m_clusterListName));
 
         if (m_replaceCurrentClusterList)
             PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Cluster>(*this, m_clusterListName));
     }
 
     // Unless specified, return current calo hit list to that when algorithm started
     if (!m_replaceCurrentCaloHitList && !m_inputCaloHitListName.empty())
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<CaloHit>(*this, originalCaloHitListName));
     }
 
     return STATUS_CODE_SUCCESS;
 }