lar_content::HitAngleVertexSelectionAlgorithm Class Reference

HitAngleVertexSelectionAlgorithm class. More...

#include "HitAngleVertexSelectionAlgorithm.h"

Inheritance diagram for lar_content::HitAngleVertexSelectionAlgorithm:

Public Types
typedef std::vector< VertexScore >	VertexScoreList
typedef std::vector< SlidingFitData >	SlidingFitDataList
typedef std::vector< ShowerCluster >	ShowerClusterList
typedef KDTreeNodeInfoT< const pandora::CaloHit *, 2 >	HitKDNode2D
typedef std::vector< HitKDNode2D >	HitKDNode2DList
typedef KDTreeLinkerAlgo< const pandora::CaloHit *, 2 >	HitKDTree2D
typedef std::map< pandora::HitType, const pandora::ClusterList & >	ClusterListMap
	Map array of cluster lists for passing to tools. More...
typedef std::map< pandora::HitType, const SlidingFitDataList >	SlidingFitDataListMap
	Map of sliding fit data lists for passing to tools. More...
typedef std::map< pandora::HitType, const ShowerClusterList >	ShowerClusterListMap
	Map of shower cluster lists for passing to tools. More...
typedef std::map< pandora::HitType, const std::reference_wrapper< HitKDTree2D > >	KDTreeMap
	Map array of hit kd trees for passing to tools. More...
typedef MvaFeatureTool< const VertexSelectionBaseAlgorithm *const, const pandora::Vertex *const, const SlidingFitDataListMap &, const ClusterListMap &, const KDTreeMap &, const ShowerClusterListMap &, const float, float & >	VertexFeatureTool
	The base type for the vertex feature tools. More...

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

Protected Member Functions
virtual void	FilterVertexList (const pandora::VertexList *const pInputVertexList, HitKDTree2D &kdTreeU, HitKDTree2D &kdTreeV, HitKDTree2D &kdTreeW, pandora::VertexVector &filteredVertices) const
	Filter the input list of vertices to obtain a reduced number of vertex candidates. More...
virtual void	GetBeamConstants (const pandora::VertexVector &vertexVector, BeamConstants &beamConstants) const
	Get the beam score constants for a provided list of candidate vertices. More...
void	GetClusterLists (const pandora::StringVector &inputClusterListNames, pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the cluster lists. More...
void	CalculateClusterSlidingFits (const pandora::ClusterList &inputClusterList, const unsigned int minClusterCaloHits, const unsigned int slidingFitWindow, SlidingFitDataList &slidingFitDataList) const
	Calculate the cluster sliding fits. More...
float	GetBeamDeweightingScore (const BeamConstants &beamConstants, const pandora::Vertex *const pVertex) const
	Get the beam deweighting score for a vertex. More...
bool	IsBeamModeOn () const
	Whether algorithm is running in beam mode, assuming neutrinos travel in positive z-direction. More...
float	GetVertexEnergy (const pandora::Vertex *const pVertex, const KDTreeMap &kdTreeMap) const
	Calculate the energy of a vertex candidate by summing values from all three planes. More...
float	VertexHitEnergy (const pandora::Vertex *const pVertex, const pandora::HitType hitType, HitKDTree2D &kdTree) const
	Finds the energy of the nearest hit to the vertex candidate in this view. More...

Private Member Functions
void	GetVertexScoreList (const pandora::VertexVector &vertexVector, const BeamConstants &beamConstants, HitKDTree2D &kdTreeU, HitKDTree2D &kdTreeV, HitKDTree2D &kdTreeW, VertexScoreList &vertexScoreList) const
	Get the vertex score list for a provided list of candidate vertices. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
VertexFeatureTool::FeatureToolVector	m_featureToolVector
	The feature tool map. More...

Detailed Description

HitAngleVertexSelectionAlgorithm class.

Definition at line 19 of file HitAngleVertexSelectionAlgorithm.h.

Member Typedef Documentation

typedef std::map<pandora::HitType, const pandora::ClusterList &> lar_content::VertexSelectionBaseAlgorithm::ClusterListMap

inherited

Map array of cluster lists for passing to tools.

Definition at line 227 of file VertexSelectionBaseAlgorithm.h.

typedef KDTreeNodeInfoT<const pandora::CaloHit *, 2> lar_content::VertexSelectionBaseAlgorithm::HitKDNode2D

inherited

Definition at line 223 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<HitKDNode2D> lar_content::VertexSelectionBaseAlgorithm::HitKDNode2DList

inherited

Definition at line 224 of file VertexSelectionBaseAlgorithm.h.

typedef KDTreeLinkerAlgo<const pandora::CaloHit *, 2> lar_content::VertexSelectionBaseAlgorithm::HitKDTree2D

inherited

Definition at line 225 of file VertexSelectionBaseAlgorithm.h.

typedef std::map<pandora::HitType, const std::reference_wrapper<HitKDTree2D> > lar_content::VertexSelectionBaseAlgorithm::KDTreeMap

inherited

Map array of hit kd trees for passing to tools.

Definition at line 230 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<ShowerCluster> lar_content::VertexSelectionBaseAlgorithm::ShowerClusterList

inherited

Definition at line 221 of file VertexSelectionBaseAlgorithm.h.

typedef std::map<pandora::HitType, const ShowerClusterList> lar_content::VertexSelectionBaseAlgorithm::ShowerClusterListMap

inherited

Map of shower cluster lists for passing to tools.

Definition at line 229 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<SlidingFitData> lar_content::VertexSelectionBaseAlgorithm::SlidingFitDataList

inherited

Definition at line 175 of file VertexSelectionBaseAlgorithm.h.

typedef std::map<pandora::HitType, const SlidingFitDataList> lar_content::VertexSelectionBaseAlgorithm::SlidingFitDataListMap

inherited

Map of sliding fit data lists for passing to tools.

Definition at line 228 of file VertexSelectionBaseAlgorithm.h.

typedef MvaFeatureTool<const VertexSelectionBaseAlgorithm *const, const pandora::Vertex *const, const SlidingFitDataListMap &, const ClusterListMap &, const KDTreeMap &, const ShowerClusterListMap &, const float, float &> lar_content::VertexSelectionBaseAlgorithm::VertexFeatureTool

inherited

The base type for the vertex feature tools.

Definition at line 234 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<VertexScore> lar_content::VertexSelectionBaseAlgorithm::VertexScoreList

inherited

Definition at line 82 of file VertexSelectionBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::HitAngleVertexSelectionAlgorithm::HitAngleVertexSelectionAlgorithm

(

)

Default constructor.

Definition at line 21 of file HitAngleVertexSelectionAlgorithm.cc.

{
}

Member Function Documentation

void lar_content::VertexSelectionBaseAlgorithm::CalculateClusterSlidingFits ( const pandora::ClusterList &  inputClusterList, const unsigned int  minClusterCaloHits, const unsigned int  slidingFitWindow, SlidingFitDataList &  slidingFitDataList  ) const

protectedinherited

Calculate the cluster sliding fits.

Parameters

inputClusterList	the input cluster list
minClusterCaloHits	the minimum number of cluster calo hits
slidingFitWindow	the sliding fit window
slidingFitDataList	the list of sliding fits to fill

Definition at line 120 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::LArGeometryHelper::GetWireZPitch(), and lar_content::LArClusterHelper::SortByNHits().

Referenced by lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::MvaVertexSelectionAlgorithm< T >::GetVertexScoreList().

{
    const float slidingFitPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));

    ClusterVector sortedClusters(inputClusterList.begin(), inputClusterList.end());
    std::sort(sortedClusters.begin(), sortedClusters.end(), LArClusterHelper::SortByNHits);

    for (const Cluster *const pCluster : sortedClusters)
    {
        if (pCluster->GetNCaloHits() < minClusterCaloHits)
            continue;

        // Make sure the window size is such that there are not more layers than hits (following TwoDSlidingLinearFit calculation).
        const unsigned int newSlidingFitWindow(
            std::min(static_cast<int>(pCluster->GetNCaloHits()), static_cast<int>(slidingFitPitch * slidingFitWindow)));
        slidingFitDataList.emplace_back(pCluster, newSlidingFitWindow, slidingFitPitch);
    }
}

void lar_content::VertexSelectionBaseAlgorithm::FilterVertexList ( const pandora::VertexList *const  pInputVertexList, HitKDTree2D &  kdTreeU, HitKDTree2D &  kdTreeV, HitKDTree2D &  kdTreeW, pandora::VertexVector &  filteredVertices  ) const

protectedvirtualinherited

Filter the input list of vertices to obtain a reduced number of vertex candidates.

Parameters

pInputVertexList	the address of the input vertex list
kdTreeU	the kd tree for u hits
kdTreeV	the kd tree for v hits
kdTreeW	the kd tree for w hits
filteredVertices	to receive the filtered vertex list

Definition at line 40 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::KDTreeLinkerAlgo< DATA, DIM >::empty(), lar_content::VertexSelectionBaseAlgorithm::IsVertexInGap(), lar_content::VertexSelectionBaseAlgorithm::IsVertexOnHit(), lar_content::VertexSelectionBaseAlgorithm::m_isEmptyViewAcceptable, lar_content::VertexSelectionBaseAlgorithm::m_minVertexAcceptableViews, and lar_content::VertexSelectionBaseAlgorithm::SortByVertexZPosition().

Referenced by lar_content::VertexSelectionBaseAlgorithm::Run().

{
    for (const Vertex *const pVertex : *pInputVertexList)
    {
        unsigned int nAcceptableViews(0);

        if ((m_isEmptyViewAcceptable && kdTreeU.empty()) || this->IsVertexOnHit(pVertex, TPC_VIEW_U, kdTreeU) || this->IsVertexInGap(pVertex, TPC_VIEW_U))
            ++nAcceptableViews;

        if ((m_isEmptyViewAcceptable && kdTreeV.empty()) || this->IsVertexOnHit(pVertex, TPC_VIEW_V, kdTreeV) || this->IsVertexInGap(pVertex, TPC_VIEW_V))
            ++nAcceptableViews;

        if ((m_isEmptyViewAcceptable && kdTreeW.empty()) || this->IsVertexOnHit(pVertex, TPC_VIEW_W, kdTreeW) || this->IsVertexInGap(pVertex, TPC_VIEW_W))
            ++nAcceptableViews;

        if (nAcceptableViews >= m_minVertexAcceptableViews)
            filteredVertices.push_back(pVertex);
    }

    std::sort(filteredVertices.begin(), filteredVertices.end(), SortByVertexZPosition);
}

void lar_content::VertexSelectionBaseAlgorithm::GetBeamConstants ( const pandora::VertexVector &  vertexVector, BeamConstants &  beamConstants  ) const

protectedvirtualinherited

Get the beam score constants for a provided list of candidate vertices.

Parameters

vertexVector	the vertex vector
beamConstants	to receive the beam constants

Definition at line 65 of file VertexSelectionBaseAlgorithm.cc.

References f, lar_content::VertexSelectionBaseAlgorithm::m_beamMode, lar_content::VertexSelectionBaseAlgorithm::m_nDecayLengthsInZSpan, and lar_content::VertexSelectionBaseAlgorithm::BeamConstants::SetConstants().

Referenced by lar_content::VertexSelectionBaseAlgorithm::Run().

{
    if (!m_beamMode)
        return;

    if (vertexVector.empty())
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);

    float minZCoordinate(std::numeric_limits<float>::max()), maxZCoordinate(-std::numeric_limits<float>::max());

    for (const Vertex *const pVertex : vertexVector)
    {
        if (pVertex->GetPosition().GetZ() < minZCoordinate)
            minZCoordinate = pVertex->GetPosition().GetZ();

        if (pVertex->GetPosition().GetZ() > maxZCoordinate)
            maxZCoordinate = pVertex->GetPosition().GetZ();
    }

    const float zSpan(maxZCoordinate - minZCoordinate);
    const float decayConstant((zSpan < std::numeric_limits<float>::epsilon()) ? 0.f : (m_nDecayLengthsInZSpan / zSpan));
    beamConstants.SetConstants(minZCoordinate, decayConstant);
}

float lar_content::VertexSelectionBaseAlgorithm::GetBeamDeweightingScore ( const BeamConstants &  beamConstants, const pandora::Vertex *const  pVertex  ) const

inlineprotectedinherited

Get the beam deweighting score for a vertex.

Parameters

beamConstants	the beam constants
pVertex	address of the vertex

Returns

the score

Definition at line 419 of file VertexSelectionBaseAlgorithm.h.

References lar_content::VertexSelectionBaseAlgorithm::BeamConstants::GetDecayConstant(), and lar_content::VertexSelectionBaseAlgorithm::BeamConstants::GetMinZCoordinate().

Referenced by lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::TrainedVertexSelectionAlgorithm::PopulateVertexFeatureInfoMap().

{
    const float vertexMinZ(std::max(pVertex->GetPosition().GetZ(), beamConstants.GetMinZCoordinate()));
    return (beamConstants.GetMinZCoordinate() - vertexMinZ) * beamConstants.GetDecayConstant();
}

void lar_content::VertexSelectionBaseAlgorithm::GetClusterLists ( const pandora::StringVector &  inputClusterListNames, pandora::ClusterList &  clusterListU, pandora::ClusterList &  clusterListV, pandora::ClusterList &  clusterListW  ) const

protectedinherited

Get the cluster lists.

Parameters

inputClusterListNames	the input cluster list names
clusterListU	the U-view cluster list to populate
clusterListV	the V-view cluster list to populate
clusterListW	the W-view cluster list to populate

Definition at line 91 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType().

Referenced by lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::MvaVertexSelectionAlgorithm< T >::GetVertexScoreList().

{
    for (const std::string &clusterListName : inputClusterListNames)
    {
        const ClusterList *pClusterList(NULL);
        PANDORA_THROW_RESULT_IF_AND_IF(
            STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, clusterListName, pClusterList));

        if (!pClusterList || pClusterList->empty())
        {
            if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                std::cout << "EnergyKickVertexSelectionAlgorithm: unable to find cluster list " << clusterListName << std::endl;

            continue;
        }

        const HitType hitType(LArClusterHelper::GetClusterHitType(*(pClusterList->begin())));

        if ((TPC_VIEW_U != hitType) && (TPC_VIEW_V != hitType) && (TPC_VIEW_W != hitType))
            throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

        ClusterList &clusterList((TPC_VIEW_U == hitType) ? clusterListU : (TPC_VIEW_V == hitType) ? clusterListV : clusterListW);
        clusterList.insert(clusterList.end(), pClusterList->begin(), pClusterList->end());
    }
}

float lar_content::VertexSelectionBaseAlgorithm::GetVertexEnergy ( const pandora::Vertex *const  pVertex, const KDTreeMap &  kdTreeMap  ) const

protectedinherited

Calculate the energy of a vertex candidate by summing values from all three planes.

Parameters

pVertex	the address of the vertex
kdTreeMap	the map of 2D hit kd trees

Returns

the summed vertex energy

Definition at line 243 of file VertexSelectionBaseAlgorithm.cc.

References f, lar_content::VertexSelectionBaseAlgorithm::IsVertexInGap(), and lar_content::VertexSelectionBaseAlgorithm::VertexHitEnergy().

Referenced by lar_content::TrainedVertexSelectionAlgorithm::PopulateVertexFeatureInfoMap().

{
    float totalEnergy(0.f);

    if (!this->IsVertexInGap(pVertex, TPC_VIEW_U))
        totalEnergy += this->VertexHitEnergy(pVertex, TPC_VIEW_U, kdTreeMap.at(TPC_VIEW_U));

    if (!this->IsVertexInGap(pVertex, TPC_VIEW_V))
        totalEnergy += this->VertexHitEnergy(pVertex, TPC_VIEW_V, kdTreeMap.at(TPC_VIEW_V));

    if (!this->IsVertexInGap(pVertex, TPC_VIEW_W))
        totalEnergy += this->VertexHitEnergy(pVertex, TPC_VIEW_W, kdTreeMap.at(TPC_VIEW_W));

    return totalEnergy;
}

void lar_content::HitAngleVertexSelectionAlgorithm::GetVertexScoreList ( const pandora::VertexVector &  vertexVector, const BeamConstants &  beamConstants, HitKDTree2D &  kdTreeU, HitKDTree2D &  kdTreeV, HitKDTree2D &  kdTreeW, VertexScoreList &  vertexScoreList  ) const

privatevirtual

Get the vertex score list for a provided list of candidate vertices.

Parameters

vertexVector	the vertex vector
beamConstants	the beam constants
kdTreeU	the kd tree for u hits
kdTreeV	the kd tree for v hits
kdTreeW	the kd tree for w hits
vertexScoreList	to receive the vertex score list

Implements lar_content::VertexSelectionBaseAlgorithm.

Definition at line 27 of file HitAngleVertexSelectionAlgorithm.cc.

References f, and Get.

{
    const KDTreeMap kdTreeMap{{TPC_VIEW_U, kdTreeU}, {TPC_VIEW_V, kdTreeV}, {TPC_VIEW_W, kdTreeW}};

    float bestFastScore(0.f);
    for (const Vertex *const pVertex : vertexVector)
    {
        const float beamDeweightingScore(this->IsBeamModeOn() ? std::exp(this->GetBeamDeweightingScore(beamConstants, pVertex)) : 1.f);

        const float rPhiScore(LArMvaHelper::CalculateFeaturesOfType<RPhiFeatureTool>(m_featureToolVector, this, pVertex,
            SlidingFitDataListMap(), ClusterListMap(), kdTreeMap, ShowerClusterListMap(), beamDeweightingScore, bestFastScore)
                                  .at(0)
                                  .Get());

        vertexScoreList.emplace_back(pVertex, beamDeweightingScore * rPhiScore);
    }
}

bool lar_content::VertexSelectionBaseAlgorithm::IsBeamModeOn ( ) const

inlineprotectedinherited

Whether algorithm is running in beam mode, assuming neutrinos travel in positive z-direction.

Returns

boolean

Definition at line 427 of file VertexSelectionBaseAlgorithm.h.

References lar_content::VertexSelectionBaseAlgorithm::m_beamMode.

Referenced by lar_content::TrainedVertexSelectionAlgorithm::AddEventFeaturesToVector(), lar_content::TrainedVertexSelectionAlgorithm::AddVertexFeaturesToVector(), lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::TrainedVertexSelectionAlgorithm::PopulateVertexFeatureInfoMap().

{
    return m_beamMode;
}

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

private

Definition at line 49 of file HitAngleVertexSelectionAlgorithm.cc.

{
    AlgorithmToolVector algorithmToolVector;
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle, "FeatureTools", algorithmToolVector));

    for (AlgorithmTool *const pAlgorithmTool : algorithmToolVector)
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, LArMvaHelper::AddFeatureToolToVector(pAlgorithmTool, m_featureToolVector));

    return VertexSelectionBaseAlgorithm::ReadSettings(xmlHandle);
}

float lar_content::VertexSelectionBaseAlgorithm::VertexHitEnergy ( const pandora::Vertex *const  pVertex, const pandora::HitType  hitType, HitKDTree2D &  kdTree  ) const

protectedinherited

Finds the energy of the nearest hit to the vertex candidate in this view.

Parameters

pVertex	the address of the vertex
hitType	the relevant hit type
kdTree	the kd tree of 2D hits

Returns

the energy of the nearest hit

Definition at line 261 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::build_2d_kd_search_region(), energy, lar_content::VertexSelectionBaseAlgorithm::m_maxOnHitDisplacement, lar_content::LArGeometryHelper::ProjectPosition(), and lar_content::KDTreeLinkerAlgo< DATA, DIM >::search().

Referenced by lar_content::VertexSelectionBaseAlgorithm::GetVertexEnergy().

{
    const CartesianVector vertexPosition2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), hitType));
    KDTreeBox searchRegionHits = build_2d_kd_search_region(vertexPosition2D, m_maxOnHitDisplacement, m_maxOnHitDisplacement);

    HitKDNode2DList foundHits;
    kdTree.search(searchRegionHits, foundHits);

    float dr(std::numeric_limits<float>::max());
    float energy(0);

    for (auto hit : foundHits)
    {
        const float diff = (vertexPosition2D - hit.data->GetPositionVector()).GetMagnitude();
        if (diff < dr)
        {
            dr = diff;
            energy = hit.data->GetElectromagneticEnergy();
        }
    }
    return energy;
}

Member Data Documentation

VertexFeatureTool::FeatureToolVector lar_content::HitAngleVertexSelectionAlgorithm::m_featureToolVector

private

The feature tool map.

Definition at line 33 of file HitAngleVertexSelectionAlgorithm.h.

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArVertex/HitAngleVertexSelectionAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArVertex/HitAngleVertexSelectionAlgorithm.cc