lar_content::GlobalAsymmetryFeatureTool Class Reference

GlobalAsymmetryFeatureTool class. More...

#include "GlobalAsymmetryFeatureTool.h"

Inheritance diagram for lar_content::GlobalAsymmetryFeatureTool:

Public Types
typedef std::vector< MvaFeatureTool< Ts... > * >	FeatureToolVector

Public Member Functions
	GlobalAsymmetryFeatureTool ()
	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...
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	GetGlobalAsymmetryForView (const pandora::CartesianVector &vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &slidingFitDataList) const
	Get the global asymmetry feature for a given view. More...
void	IncrementAsymmetryParameters (const float weight, const pandora::CartesianVector &clusterDirection, pandora::CartesianVector &localWeightedDirectionSum) const
	Increment the asymmetry parameters. More...
float	CalculateGlobalAsymmetry (const bool useEnergyMetrics, const pandora::CartesianVector &vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &slidingFitDataList, const pandora::CartesianVector &localWeightedDirectionSum) const
	Calculate the global asymmetry feature. More...

Private Attributes
float	m_maxAsymmetryDistance
	The max distance between cluster (any hit) and vertex to calculate asymmetry score. More...

Detailed Description

GlobalAsymmetryFeatureTool class.

Definition at line 19 of file GlobalAsymmetryFeatureTool.h.

Member Typedef Documentation

template<typename... Ts>

typedef std::vector<MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolVector

inherited

Definition at line 30 of file LArMvaHelper.h.

Constructor & Destructor Documentation

lar_content::GlobalAsymmetryFeatureTool::GlobalAsymmetryFeatureTool

(

)

Default constructor.

Definition at line 19 of file GlobalAsymmetryFeatureTool.cc.

                                                       :
    m_maxAsymmetryDistance(5.f)
{
}

Member Function Documentation

float lar_content::GlobalAsymmetryFeatureTool::CalculateGlobalAsymmetry ( const bool  useEnergyMetrics, const pandora::CartesianVector &  vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &  slidingFitDataList, const pandora::CartesianVector &  localWeightedDirectionSum  ) const

private

Calculate the global asymmetry feature.

Parameters

useEnergyMetrics	whether to use energy-based metrics instead of hit-counting-based metrics
vertexPosition2D	the vertex position in this view
slidingFitDataList	the list of sliding fit data objects
localWeightedDirectionSum	the local event axis

Returns

the global asymmetry feature

Definition at line 102 of file GlobalAsymmetryFeatureTool.cc.

References f, and lar_content::LArClusterHelper::SortHitsByPosition().

Referenced by GetGlobalAsymmetryForView().

{
    // Project every hit onto local event axis direction and record side of the projected vtx position on which it falls
    float beforeVtxHitEnergy(0.f), afterVtxHitEnergy(0.f);
    unsigned int beforeVtxHitCount(0), afterVtxHitCount(0);

    const CartesianVector localWeightedDirection(localWeightedDirectionSum.GetUnitVector());
    const float evtProjectedVtxPos(vertexPosition2D.GetDotProduct(localWeightedDirection));

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

        CaloHitList caloHitList;
        pCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);

        CaloHitVector caloHitVector(caloHitList.begin(), caloHitList.end());
        std::sort(caloHitVector.begin(), caloHitVector.end(), LArClusterHelper::SortHitsByPosition);

        for (const CaloHit *const pCaloHit : caloHitVector)
        {
            if (pCaloHit->GetPositionVector().GetDotProduct(localWeightedDirection) < evtProjectedVtxPos)
            {
                beforeVtxHitEnergy += pCaloHit->GetElectromagneticEnergy();
                ++beforeVtxHitCount;
            }

            else
            {
                afterVtxHitEnergy += pCaloHit->GetElectromagneticEnergy();
                ++afterVtxHitCount;
            }
        }
    }

    // Use energy metrics if possible, otherwise fall back on hit counting.
    const float totHitEnergy(beforeVtxHitEnergy + afterVtxHitEnergy);
    const unsigned int totHitCount(beforeVtxHitCount + afterVtxHitCount);

    if (useEnergyMetrics)
        return std::fabs((afterVtxHitEnergy - beforeVtxHitEnergy)) / totHitEnergy;

    if (0 == totHitCount)
        throw StatusCodeException(STATUS_CODE_FAILURE);

    return std::fabs((static_cast<float>(afterVtxHitCount) - static_cast<float>(beforeVtxHitCount))) / static_cast<float>(totHitCount);
}

float lar_content::GlobalAsymmetryFeatureTool::GetGlobalAsymmetryForView ( const pandora::CartesianVector &  vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &  slidingFitDataList  ) const

private

Get the global asymmetry feature for a given view.

Parameters

vertexPosition2D	the vertex position projected into this view
slidingFitDataList	the list of sliding fit data objects for this view

Returns

the global asymmetry feature

Definition at line 49 of file GlobalAsymmetryFeatureTool.cc.

References CalculateGlobalAsymmetry(), f, lar_content::LArClusterHelper::GetClosestDistance(), IncrementAsymmetryParameters(), and m_maxAsymmetryDistance.

Referenced by Run().

{
    bool useEnergy(true);
    CartesianVector energyWeightedDirectionSum(0.f, 0.f, 0.f), hitWeightedDirectionSum(0.f, 0.f, 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 &clusterDirection((minLayerClosest) ? slidingFitData.GetMinLayerDirection() : slidingFitData.GetMaxLayerDirection());

        if ((LArClusterHelper::GetClosestDistance(vertexPosition2D, pCluster) < m_maxAsymmetryDistance))
        {
            this->IncrementAsymmetryParameters(pCluster->GetElectromagneticEnergy(), clusterDirection, energyWeightedDirectionSum);
            this->IncrementAsymmetryParameters(static_cast<float>(pCluster->GetNCaloHits()), clusterDirection, hitWeightedDirectionSum);
        }
    }

    const CartesianVector &localWeightedDirectionSum(useEnergy ? energyWeightedDirectionSum : hitWeightedDirectionSum);

    if (localWeightedDirectionSum.GetMagnitudeSquared() < std::numeric_limits<float>::epsilon())
        return 0.f;

    return this->CalculateGlobalAsymmetry(useEnergy, vertexPosition2D, slidingFitDataList, localWeightedDirectionSum);
}

void lar_content::GlobalAsymmetryFeatureTool::IncrementAsymmetryParameters ( const float  weight, const pandora::CartesianVector &  clusterDirection, pandora::CartesianVector &  localWeightedDirectionSum  ) const

private

Increment the asymmetry parameters.

Parameters

weight	the weight to assign to this vector
clusterDirection	the direction of the cluster
localWeightedDirectionSum	the current energy-weighted local cluster direction vector

Definition at line 85 of file GlobalAsymmetryFeatureTool.cc.

References f, and weight.

Referenced by GetGlobalAsymmetryForView().

{
    // If the new axis direction is at an angle of greater than 90 deg to the current axis direction, flip it 180 degs.
    CartesianVector newDirection(clusterDirection);

    if (localWeightedDirectionSum.GetMagnitudeSquared() > std::numeric_limits<float>::epsilon())
    {
        if (localWeightedDirectionSum.GetCosOpeningAngle(clusterDirection) < 0.f)
            newDirection *= -1.f;
    }

    localWeightedDirectionSum += newDirection * weight;
}

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

private

Definition at line 153 of file GlobalAsymmetryFeatureTool.cc.

References m_maxAsymmetryDistance.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
        "MaxAsymmetryDistance", m_maxAsymmetryDistance));

    return STATUS_CODE_SUCCESS;
}

void lar_content::GlobalAsymmetryFeatureTool::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 global asymmetry feature

Definition at line 26 of file GlobalAsymmetryFeatureTool.cc.

References f, GetGlobalAsymmetryForView(), and lar_content::LArGeometryHelper::ProjectPosition().

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

    float globalAsymmetry(0.f);

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

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

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

    featureVector.push_back(globalAsymmetry);
}

template<typename... Ts>

virtual void lar_content::MvaFeatureTool< Ts >::Run ( MvaTypes::MvaFeatureVector &  featureVector, Ts...  args  )

pure virtualinherited

Run the algorithm tool.

Parameters

featureVector	the vector of features to append
args	arguments to pass to the tool

Member Data Documentation

float lar_content::GlobalAsymmetryFeatureTool::m_maxAsymmetryDistance

private

The max distance between cluster (any hit) and vertex to calculate asymmetry score.

Definition at line 75 of file GlobalAsymmetryFeatureTool.h.

Referenced by GetGlobalAsymmetryForView(), and ReadSettings().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArVertex/GlobalAsymmetryFeatureTool.h
• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArVertex/GlobalAsymmetryFeatureTool.cc