lar_content::ThreeDChargeFeatureTool Class Reference

ThreeDChargeFeatureTool class for the calculation of charge-related features. More...

#include "TrackShowerIdFeatureTool.h"

Inheritance diagram for lar_content::ThreeDChargeFeatureTool:

Classes
class	VertexComparator
	VertexComparator class for comparison of two points wrt neutrino vertex position. More...

Public Types
typedef std::vector< MvaFeatureTool< Ts... > * >	FeatureToolVector
typedef std::map< std::string, MvaFeatureTool< Ts... > * >	FeatureToolMap

Public Member Functions
	ThreeDChargeFeatureTool ()
	Default constructor. More...
void	Run (LArMvaHelper::MvaFeatureVector &featureVector, const pandora::Algorithm *const pAlgorithm, const pandora::ParticleFlowObject *const pInputPfo)
void	Run (LArMvaHelper::MvaFeatureMap &featureMap, pandora::StringVector &featureOrder, const std::string &featureToolName, const pandora::Algorithm *const pAlgorithm, const pandora::ParticleFlowObject *const pInputPfo)
virtual void	Run (MvaTypes::MvaFeatureVector &featureVector, Ts...args)=0
	Run the algorithm tool. More...
virtual void	Run (MvaTypes::MvaFeatureMap &featureMap, pandora::StringVector &featureOrder, const std::string &featureToolName, Ts...)

Private Member Functions
void	CalculateChargeVariables (const pandora::Algorithm *const pAlgorithm, const pandora::Cluster *const pCluster, float &totalCharge, float &chargeSigma, float &chargeMean, float &endCharge)
	Calculation of the charge variables. More...
void	OrderCaloHitsByDistanceToVertex (const pandora::Algorithm *const pAlgorithm, const pandora::Cluster *const pCluster, pandora::CaloHitList &caloHitList)
	Function to order the calo hit list by distance to neutrino vertex. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
float	m_endChargeFraction
	Fraction of hits that will be considered to calculate end charge (default 10%) More...

Detailed Description

ThreeDChargeFeatureTool class for the calculation of charge-related features.

Definition at line 338 of file TrackShowerIdFeatureTool.h.

Member Typedef Documentation

template<typename... Ts>

typedef std::map<std::string, MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolMap

inherited

Definition at line 37 of file LArMvaHelper.h.

template<typename... Ts>

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

inherited

Definition at line 36 of file LArMvaHelper.h.

Constructor & Destructor Documentation

lar_content::ThreeDChargeFeatureTool::ThreeDChargeFeatureTool

(

)

Default constructor.

Definition at line 1066 of file TrackShowerIdFeatureTool.cc.

                                                 :
    m_endChargeFraction(0.1f)
{
}

Member Function Documentation

void lar_content::ThreeDChargeFeatureTool::CalculateChargeVariables ( const pandora::Algorithm *const  pAlgorithm, const pandora::Cluster *const  pCluster, float &  totalCharge, float &  chargeSigma, float &  chargeMean, float &  endCharge  )

private

Calculation of the charge variables.

Parameters

pAlgorithm,the	algorithm
pCluster	the cluster we are characterizing
totalCharge,to	receive the total charge
chargeSigma,to	receive the charge sigma
chargeMean,to	receive the charge mean
startCharge,to	receive the charge in the initial 10% hits
endCharge,to	receive the charge in the last 10% hits

Definition at line 1122 of file TrackShowerIdFeatureTool.cc.

References f, m_endChargeFraction, and OrderCaloHitsByDistanceToVertex().

Referenced by Run().

{
    totalCharge = 0.f;
    chargeSigma = 0.f;
    chargeMean = 0.f;
    endCharge = 0.f;

    CaloHitList orderedCaloHitList;
    this->OrderCaloHitsByDistanceToVertex(pAlgorithm, pCluster, orderedCaloHitList);

    FloatVector chargeVector;
    unsigned int hitCounter(0);
    const unsigned int nTotalHits(orderedCaloHitList.size());

    for (const CaloHit *const pCaloHit : orderedCaloHitList)
    {
        ++hitCounter;
        const float pCaloHitCharge(pCaloHit->GetInputEnergy());

        if (pCaloHitCharge >= 0.f)
        {
            totalCharge += pCaloHitCharge;
            chargeVector.push_back(pCaloHitCharge);

            if (hitCounter >= std::floor(static_cast<float>(nTotalHits) * (1.f - m_endChargeFraction)))
                endCharge += pCaloHitCharge;
        }
    }

    if (!chargeVector.empty())
    {
        chargeMean = totalCharge / static_cast<float>(chargeVector.size());

        for (const float charge : chargeVector)
            chargeSigma += (charge - chargeMean) * (charge - chargeMean);

        chargeSigma = std::sqrt(chargeSigma / static_cast<float>(chargeVector.size()));
    }
}

void lar_content::ThreeDChargeFeatureTool::OrderCaloHitsByDistanceToVertex ( const pandora::Algorithm *const  pAlgorithm, const pandora::Cluster *const  pCluster, pandora::CaloHitList &  caloHitList  )

private

Function to order the calo hit list by distance to neutrino vertex.

Parameters

pAlgorithm,the	algorithm
pCluster	the cluster we are characterizing
caloHitList	to receive the ordered calo hit list

Definition at line 1165 of file TrackShowerIdFeatureTool.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), and lar_content::LArGeometryHelper::ProjectPosition().

Referenced by CalculateChargeVariables().

{
    const VertexList *pVertexList(nullptr);
    (void)PandoraContentApi::GetCurrentList(*pAlgorithm, pVertexList);

    if (!pVertexList || pVertexList->empty())
        return;

    unsigned int nInteractionVertices(0);
    const Vertex *pInteractionVertex(nullptr);

    for (const Vertex *pVertex : *pVertexList)
    {
        if ((pVertex->GetVertexLabel() == VERTEX_INTERACTION) && (pVertex->GetVertexType() == VERTEX_3D))
        {
            ++nInteractionVertices;
            pInteractionVertex = pVertex;
        }
    }

    if (pInteractionVertex && (1 == nInteractionVertices))
    {
        const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
        const CartesianVector vertexPosition2D(LArGeometryHelper::ProjectPosition(pAlgorithm->GetPandora(), pInteractionVertex->GetPosition(), hitType));

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

        clusterCaloHitList.sort(ThreeDChargeFeatureTool::VertexComparator(vertexPosition2D));
        caloHitList.insert(caloHitList.end(), clusterCaloHitList.begin(), clusterCaloHitList.end());
    }
}

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

private

Definition at line 1201 of file TrackShowerIdFeatureTool.cc.

References m_endChargeFraction.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "EndChargeFraction", m_endChargeFraction));

    return STATUS_CODE_SUCCESS;
}

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

template<typename... Ts>

virtual void lar_content::MvaFeatureTool< Ts >::Run ( MvaTypes::MvaFeatureMap &  featureMap, pandora::StringVector &  featureOrder, const std::string &  featureToolName, Ts...    )

inlinevirtualinherited

Definition at line 51 of file LArMvaHelper.h.

    {
        (void)featureMap;
        (void)featureOrder;
        (void)featureToolName;
        return;
    };

void lar_content::ThreeDChargeFeatureTool::Run	(	LArMvaHelper::MvaFeatureVector &	featureVector,
		const pandora::Algorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pInputPfo
	)

Definition at line 1073 of file TrackShowerIdFeatureTool.cc.

References CalculateChargeVariables(), f, and lar_content::LArPfoHelper::GetClusters().

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

    float totalCharge(-1.f), chargeSigma(-1.f), chargeMean(-1.f), endCharge(-1.f);
    LArMvaHelper::MvaFeature charge1, charge2;

    ClusterList clusterListW;
    LArPfoHelper::GetClusters(pInputPfo, TPC_VIEW_W, clusterListW);

    if (!clusterListW.empty())
        this->CalculateChargeVariables(pAlgorithm, clusterListW.front(), totalCharge, chargeSigma, chargeMean, endCharge);

    if (chargeMean > std::numeric_limits<float>::epsilon())
        charge1 = chargeSigma / chargeMean;

    if (totalCharge > std::numeric_limits<float>::epsilon())
        charge2 = endCharge / totalCharge;

    featureVector.push_back(charge1);
    featureVector.push_back(charge2);
}

void lar_content::ThreeDChargeFeatureTool::Run	(	LArMvaHelper::MvaFeatureMap &	featureMap,
		pandora::StringVector &	featureOrder,
		const std::string &	featureToolName,
		const pandora::Algorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pInputPfo
	)

Member Data Documentation

float lar_content::ThreeDChargeFeatureTool::m_endChargeFraction

private

Fraction of hits that will be considered to calculate end charge (default 10%)

Definition at line 401 of file TrackShowerIdFeatureTool.h.

Referenced by CalculateChargeVariables(), and ReadSettings().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArTrackShowerId/TrackShowerIdFeatureTool.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArTrackShowerId/TrackShowerIdFeatureTool.cc