lar_content::EnergyKickFeatureTool Class Reference

EnergyKickFeatureTool class. More...

#include <EnergyKickFeatureTool.h>

Inheritance diagram for lar_content::EnergyKickFeatureTool:

Public Member Functions
	EnergyKickFeatureTool ()
	Default constructor. More...
void	Run (LArMvaHelper::MvaFeatureVector &featureVector, const VertexSelectionBaseAlgorithm *const pAlgorithm, const pandora::Vertex *const pVertex, const VertexSelectionBaseAlgorithm::SlidingFitDataListMap &slidingFitDataListMap, const VertexSelectionBaseAlgorithm::ClusterListMap &, const VertexSelectionBaseAlgorithm::KDTreeMap &, const VertexSelectionBaseAlgorithm::ShowerClusterListMap &, const float, float &)
	Run the tool. More...
Public Member Functions inherited from lar_content::MvaFeatureTool< Ts >
	MvaFeatureTool ()=default
	Default constructor. More...
virtual void	Run (MvaTypes::MvaFeatureVector &featureVector, Ts...args)=0
	Run the algorithm tool. More...

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
float	GetEnergyKickForView (const pandora::CartesianVector &vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &slidingFitDataList) const
	Get the energy kick feature for a given view. More...
void	IncrementEnergyKickParameters (const pandora::Cluster *const pCluster, const pandora::CartesianVector &clusterDisplacement, const pandora::CartesianVector &clusterDirection, float &totEnergyKick, float &totEnergy, float &totHitKick, unsigned int &totHits) const
	Increment the energy kick parameters for a given cluster. More...

Private Attributes
float	m_rOffset
	The r offset parameter in the energy score. More...
float	m_xOffset
	The x offset parameter in the energy score. More...

Additional Inherited Members
Public Types inherited from lar_content::MvaFeatureTool< Ts >
typedef std::vector< MvaFeatureTool< Ts... > * >	FeatureToolVector

Detailed Description

EnergyKickFeatureTool class.

Definition at line 19 of file EnergyKickFeatureTool.h.

Constructor & Destructor Documentation

lar_content::EnergyKickFeatureTool::EnergyKickFeatureTool

(

)

Default constructor.

Definition at line 20 of file EnergyKickFeatureTool.cc.

                                             : m_rOffset(10.f), m_xOffset(0.06f)
{
}

Member Function Documentation

float lar_content::EnergyKickFeatureTool::GetEnergyKickForView ( const pandora::CartesianVector &  vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &  slidingFitDataList  ) const

private

Get the energy kick feature for a given view.

Parameters

vertexPosition2D	the projection of the vertex position in this view
slidingFitDataList	the list of sliding fit data objects in this view

Returns

the energy kick feature

Definition at line 50 of file EnergyKickFeatureTool.cc.

{
    unsigned int totHits(0);
    bool useEnergy(true);
    float totEnergy(0.f), totEnergyKick(0.f), totHitKick(0.f);

    for (const VertexSelectionBaseAlgorithm::SlidingFitData &slidingFitData : slidingFitDataList)
    {
        const Cluster *const pCluster(slidingFitData.GetCluster());

        if (pCluster->GetElectromagneticEnergy() < std::numeric_limits<float>::epsilon())
            useEnergy = false;

        const CartesianVector vertexToMinLayer(slidingFitData.GetMinLayerPosition() - vertexPosition2D);
        const CartesianVector vertexToMaxLayer(slidingFitData.GetMaxLayerPosition() - vertexPosition2D);

        const bool minLayerClosest(vertexToMinLayer.GetMagnitudeSquared() < vertexToMaxLayer.GetMagnitudeSquared());
        const CartesianVector &clusterDisplacement((minLayerClosest) ? vertexToMinLayer : vertexToMaxLayer);
        const CartesianVector &clusterDirection((minLayerClosest) ? slidingFitData.GetMinLayerDirection() : slidingFitData.GetMaxLayerDirection());

        this->IncrementEnergyKickParameters(pCluster, clusterDisplacement, clusterDirection, totEnergyKick, totEnergy, totHitKick, totHits);
    }

    float energyKick(0.f);
    if (useEnergy && totEnergy > std::numeric_limits<float>::epsilon())
        energyKick = totEnergyKick / totEnergy;

    else if (!useEnergy && totHits > 0)
        energyKick = totHitKick / static_cast<float>(totHits);

    return energyKick;
}

void lar_content::EnergyKickFeatureTool::IncrementEnergyKickParameters ( const pandora::Cluster *const  pCluster, const pandora::CartesianVector &  clusterDisplacement, const pandora::CartesianVector &  clusterDirection, float &  totEnergyKick, float &  totEnergy, float &  totHitKick, unsigned int &  totHits  ) const

private

Increment the energy kick parameters for a given cluster.

Parameters

pCluster	address of the cluster
clusterDisplacement	the cluster displacement
clusterDirection	the cluster direction
totEnergyKick	the total energy kick
totEnergy	the total energy
totHitKick	the total hit kick
totHits	the total number of hits

Definition at line 86 of file EnergyKickFeatureTool.cc.

{
    const float impactParameter(clusterDisplacement.GetCrossProduct(clusterDirection).GetMagnitude());
    const float displacement(clusterDisplacement.GetMagnitude());

    totEnergyKick += pCluster->GetElectromagneticEnergy() * (impactParameter + m_xOffset) / (displacement + m_rOffset);
    totEnergy += pCluster->GetElectromagneticEnergy();

    totHitKick += static_cast<float>(pCluster->GetNCaloHits()) * (impactParameter + m_xOffset) / (displacement + m_rOffset);
    totHits += pCluster->GetNCaloHits();
}

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

private

Definition at line 101 of file EnergyKickFeatureTool.cc.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ROffset", m_rOffset));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "XOffset", m_xOffset));

    return STATUS_CODE_SUCCESS;
}

void lar_content::EnergyKickFeatureTool::Run	(	LArMvaHelper::MvaFeatureVector &	featureVector,
		const VertexSelectionBaseAlgorithm *const	pAlgorithm,
		const pandora::Vertex *const	pVertex,
		const VertexSelectionBaseAlgorithm::SlidingFitDataListMap &	slidingFitDataListMap,
		const VertexSelectionBaseAlgorithm::ClusterListMap &	,
		const VertexSelectionBaseAlgorithm::KDTreeMap &	,
		const VertexSelectionBaseAlgorithm::ShowerClusterListMap &	,
		const float	,
		float &
	)

Run the tool.

Parameters

pAlgorithm	address of the calling algorithm
pVertex	address of the vertex
slidingFitDataListMap	map of the sliding fit data lists

Returns

the energy kick feature

Definition at line 26 of file EnergyKickFeatureTool.cc.

{
    if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;

    float energyKick(0.f);

    energyKick += this->GetEnergyKickForView(
        LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), TPC_VIEW_U), slidingFitDataListMap.at(TPC_VIEW_U));

    energyKick += this->GetEnergyKickForView(
        LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), TPC_VIEW_V), slidingFitDataListMap.at(TPC_VIEW_V));

    energyKick += this->GetEnergyKickForView(
        LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), TPC_VIEW_W), slidingFitDataListMap.at(TPC_VIEW_W));

    featureVector.push_back(energyKick);
}

Member Data Documentation

float lar_content::EnergyKickFeatureTool::m_rOffset

private

The r offset parameter in the energy score.

Definition at line 68 of file EnergyKickFeatureTool.h.

float lar_content::EnergyKickFeatureTool::m_xOffset

private

The x offset parameter in the energy score.

Definition at line 69 of file EnergyKickFeatureTool.h.

---

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

• larpandoracontent/larpandoracontent/LArVertex/EnergyKickFeatureTool.h
• larpandoracontent/larpandoracontent/LArVertex/EnergyKickFeatureTool.cc