lar_content::RandomFigureOfMeritTool Class Reference

RandomFigureOfMeritTool class. More...

#include "RandomFigureOfMeritTool.h"

Inheritance diagram for lar_content::RandomFigureOfMeritTool:

Public Member Functions
	RandomFigureOfMeritTool ()
	Default constructor. More...
	~RandomFigureOfMeritTool ()=default
	Default destructor. More...
pandora::StatusCode	GetPfosToRecluster (const pandora::PfoList *pPfos, pandora::PfoList &pfosToRecluster)
	Identify pfos for which an attempt at 3D reclustering should be made. More...
pandora::StatusCode	CalcClusteringFom (const pandora::ClusterList &clusters, float &fom)
	Calculate a measure of the goodness of a clustering. More...

Private Member Functions
float	GetRandomFom ()
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
float	m_maxFomToRecluster
	threshold figure of merit for reclustering a pfo More...

Detailed Description

RandomFigureOfMeritTool class.

Definition at line 20 of file RandomFigureOfMeritTool.h.

Constructor & Destructor Documentation

lar_content::RandomFigureOfMeritTool::RandomFigureOfMeritTool

(

)

Default constructor.

Definition at line 18 of file RandomFigureOfMeritTool.cc.

                                                 :
    m_maxFomToRecluster{0.5f}
{
}

lar_content::RandomFigureOfMeritTool::~RandomFigureOfMeritTool ( )

default

Default destructor.

Member Function Documentation

StatusCode lar_content::RandomFigureOfMeritTool::CalcClusteringFom ( const pandora::ClusterList &  clusters, float &  fom  )

virtual

Calculate a measure of the goodness of a clustering.

Parameters

clusters	input list of clusters
fom	output value of the clustering goodness, the figure of merit

Implements lar_content::ThreeDReclusteringFigureOfMeritBaseTool.

Definition at line 43 of file RandomFigureOfMeritTool.cc.

References GetRandomFom().

{
    fom = GetRandomFom();

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::RandomFigureOfMeritTool::GetPfosToRecluster ( const pandora::PfoList *  pPfos, pandora::PfoList &  pfosToRecluster  )

virtual

Identify pfos for which an attempt at 3D reclustering should be made.

Parameters

pPfos	input list of all pfos
pfosToRecluster	output list of pfos that should be reclustered

Implements lar_content::ThreeDReclusteringFigureOfMeritBaseTool.

Definition at line 25 of file RandomFigureOfMeritTool.cc.

References GetRandomFom(), and m_maxFomToRecluster.

{
    if (!pfosToRecluster.empty())
        return STATUS_CODE_FAILURE;

    for (const Pfo *const pPfo : *pPfos)
    {
        if (pPfo->GetNClusters() == 0)
            continue;
        if (GetRandomFom() < m_maxFomToRecluster)
            pfosToRecluster.emplace_back(pPfo);
    }

    return STATUS_CODE_SUCCESS;
}

float lar_content::RandomFigureOfMeritTool::GetRandomFom ( )

inlineprivate

Definition at line 47 of file RandomFigureOfMeritTool.h.

Referenced by CalcClusteringFom(), and GetPfosToRecluster().

{
    return static_cast<float>(rand()) / static_cast<float>(RAND_MAX);
}

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

private

Definition at line 52 of file RandomFigureOfMeritTool.cc.

References m_maxFomToRecluster.

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MaxFomToRecluster", m_maxFomToRecluster));

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

float lar_content::RandomFigureOfMeritTool::m_maxFomToRecluster

private

threshold figure of merit for reclustering a pfo

Definition at line 42 of file RandomFigureOfMeritTool.h.

Referenced by GetPfosToRecluster(), and ReadSettings().

---

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

• larpandoracontent/v04_15_01/source/larpandoracontent/LArReclustering/LArExample/RandomFigureOfMeritTool.h
• larpandoracontent/v04_15_01/source/larpandoracontent/LArReclustering/LArExample/RandomFigureOfMeritTool.cc