lar_content::TransverseTrackHitsBaseTool Class Reference

TransverseTrackHitsBaseTool class. More...

#include "TransverseTrackHitsBaseTool.h"

Inheritance diagram for lar_content::TransverseTrackHitsBaseTool:

Public Types
typedef ThreeDHitCreationAlgorithm::ProtoHit	ProtoHit
typedef ThreeDHitCreationAlgorithm::ProtoHitVector	ProtoHitVector
typedef ThreeDHitCreationAlgorithm::TrajectorySample	TrajectorySample

Public Member Functions
virtual void	Run (ThreeDHitCreationAlgorithm *const pAlgorithm, const pandora::ParticleFlowObject *const pPfo, const pandora::CaloHitVector &inputTwoDHits, ProtoHitVector &protoHitVector)
	Run the algorithm tool. More...

Protected Types
typedef std::map< pandora::HitType, TwoDSlidingFitResult >	MatchedSlidingFitMap

Protected Member Functions
virtual void	GetTransverseTrackHit3D (const MatchedSlidingFitMap &matchedSlidingFitMap, ProtoHit &protoHit) const =0
	Get the three dimensional position using a provided two dimensional calo hit and sliding linear fits in the other two views. More...
virtual void	GetTrackHits3D (const pandora::CaloHitVector &inputTwoDHits, const MatchedSlidingFitMap &matchedSlidingFitMap, ProtoHitVector &protoHitVector) const
	Calculate 3D hits from an input list of 2D hits. More...
virtual void	AddTransverseChi2 (const MatchedSlidingFitMap &matchedSlidingFitMap, ProtoHit &protoHit) const
	Calculate an additional contribution to the chi-squared based on the steepness of the track. More...
virtual void	BuildSlidingFitMap (const pandora::ParticleFlowObject *const pPfo, MatchedSlidingFitMap &matchedSlidingFitMap) const
	Calculate sliding fit results for clusters from each view. More...
virtual pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
virtual void	GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianPointVector &fitPositionList1, const pandora::CartesianPointVector &fitPositionList2, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views. More...
virtual void	GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianVector &fitPosition1, const pandora::CartesianVector &fitPosition2, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views. More...
virtual void	GetBestPosition3D (const pandora::HitType hitType, const pandora::CartesianVector &fitPosition, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view. More...

Protected Attributes
unsigned int	m_minViews
	The minimum number of views required for building hits. More...
unsigned int	m_slidingFitWindow
	The layer window for the sliding linear fits. More...
double	m_sigmaX2
	The sigmaX squared value, for calculation of chi2 deltaX term. More...
double	m_chiSquaredCut
	The chi squared cut (accept only values below the cut value) More...

Private Member Functions
double	GetTransverseChi2 (const pandora::CartesianVector &position2D, const TwoDSlidingFitResult &fitResult) const
	Calculate an additional contribution to the chi-squared based on the steepness of the track. More...

Detailed Description

TransverseTrackHitsBaseTool class.

Definition at line 19 of file TransverseTrackHitsBaseTool.h.

Member Typedef Documentation

typedef std::map<pandora::HitType, TwoDSlidingFitResult> lar_content::TrackHitsBaseTool::MatchedSlidingFitMap

protectedinherited

Definition at line 35 of file TrackHitsBaseTool.h.

typedef ThreeDHitCreationAlgorithm::ProtoHit lar_content::HitCreationBaseTool::ProtoHit

inherited

Definition at line 24 of file HitCreationBaseTool.h.

typedef ThreeDHitCreationAlgorithm::ProtoHitVector lar_content::HitCreationBaseTool::ProtoHitVector

inherited

Definition at line 25 of file HitCreationBaseTool.h.

typedef ThreeDHitCreationAlgorithm::TrajectorySample lar_content::HitCreationBaseTool::TrajectorySample

inherited

Definition at line 26 of file HitCreationBaseTool.h.

Member Function Documentation

void lar_content::TransverseTrackHitsBaseTool::AddTransverseChi2 ( const MatchedSlidingFitMap &  matchedSlidingFitMap, ProtoHit &  protoHit  ) const

protectedvirtual

Calculate an additional contribution to the chi-squared based on the steepness of the track.

Parameters

matchedSlidingFitMap	map of sliding fit results from each view
protoHit	to receive the modified proto hit

Definition at line 43 of file TransverseTrackHitsBaseTool.cc.

References lar_content::ThreeDHitCreationAlgorithm::ProtoHit::GetChi2(), lar_content::ThreeDHitCreationAlgorithm::ProtoHit::GetParentCaloHit2D(), lar_content::ThreeDHitCreationAlgorithm::ProtoHit::GetPosition3D(), and lar_content::ThreeDHitCreationAlgorithm::ProtoHit::SetPosition3D().

{
    // TODO Develop a proper treatment of the |dz/dx| * sigmaX uncertainty
    double chiSquared(protoHit.GetChi2());
    const HitType inputHitType(protoHit.GetParentCaloHit2D()->GetHitType());
    const CartesianVector &inputPosition3D(protoHit.GetPosition3D());

    for (const MatchedSlidingFitMap::value_type &mapEntry : matchedSlidingFitMap)
    {
        if (mapEntry.first == inputHitType)
            continue;

        const CartesianVector inputPosition2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), inputPosition3D, mapEntry.first));
        chiSquared += this->GetTransverseChi2(inputPosition2D, mapEntry.second);
    }

    protoHit.SetPosition3D(inputPosition3D, chiSquared);
}

void lar_content::TrackHitsBaseTool::BuildSlidingFitMap ( const pandora::ParticleFlowObject *const  pPfo, MatchedSlidingFitMap &  matchedSlidingFitMap  ) const

protectedvirtualinherited

Calculate sliding fit results for clusters from each view.

Parameters

pPfo	the input particle flow object
matchedSlidingFitMap	the group of sliding fit results

Definition at line 57 of file TrackHitsBaseTool.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), lar_content::LArGeometryHelper::GetWirePitch(), lar_content::TrackHitsBaseTool::m_slidingFitWindow, and lar_content::LArClusterHelper::SortByNHits().

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

{
    const ClusterList &pfoClusterList(pPfo->GetClusterList());

    ClusterVector pfoClusterVector;
    pfoClusterVector.insert(pfoClusterVector.end(), pfoClusterList.begin(), pfoClusterList.end());
    std::sort(pfoClusterVector.begin(), pfoClusterVector.end(), LArClusterHelper::SortByNHits);

    for (const Cluster *const pCluster : pfoClusterVector)
    {
        const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));

        if (TPC_3D == hitType)
            continue;

        if (matchedSlidingFitMap.end() != matchedSlidingFitMap.find(hitType))
            continue;

        try
        {
            const float slidingFitPitch(LArGeometryHelper::GetWirePitch(this->GetPandora(), LArClusterHelper::GetClusterHitType(pCluster)));
            const TwoDSlidingFitResult slidingFitResult(pCluster, m_slidingFitWindow, slidingFitPitch);

            if (!matchedSlidingFitMap.insert(MatchedSlidingFitMap::value_type(hitType, slidingFitResult)).second)
                throw StatusCodeException(STATUS_CODE_FAILURE);
        }
        catch (StatusCodeException &statusCodeException)
        {
            if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
                throw statusCodeException;
        }
    }
}

virtual void lar_content::HitCreationBaseTool::GetBestPosition3D ( const pandora::HitType  hitType1, const pandora::HitType  hitType2, const pandora::CartesianPointVector &  fitPositionList1, const pandora::CartesianPointVector &  fitPositionList2, ProtoHit &  protoHit  ) const

protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters

hitType1	the hit type identifying the first view
hitType2	the hit type identifying the second view
fitPositionList1	the candidate sliding fit position in the first view
fitPositionList2	the candidate sliding fit position in the second view
protoHit	to receive the populated proto hit

Referenced by lar_content::ThreeViewShowerHitsTool::GetShowerHit3D(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

virtual void lar_content::HitCreationBaseTool::GetBestPosition3D ( const pandora::HitType  hitType1, const pandora::HitType  hitType2, const pandora::CartesianVector &  fitPosition1, const pandora::CartesianVector &  fitPosition2, ProtoHit &  protoHit  ) const

protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters

hitType1	the hit type identifying the first view
hitType2	the hit type identifying the second view
fitPosition1	the candidate sliding fit position in the first view
fitPosition2	the candidate sliding fit position in the second view
protoHit	to receive the populated proto hit

virtual void lar_content::HitCreationBaseTool::GetBestPosition3D ( const pandora::HitType  hitType, const pandora::CartesianVector &  fitPosition, ProtoHit &  protoHit  ) const

protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view.

Parameters

hitType	the hit type identifying the other view
fitPosition	the candidate sliding fit position in the other view
protoHit	to receive the populated proto hit

void lar_content::TransverseTrackHitsBaseTool::GetTrackHits3D ( const pandora::CaloHitVector &  inputTwoDHits, const MatchedSlidingFitMap &  matchedSlidingFitMap, ProtoHitVector &  protoHitVector  ) const

protectedvirtual

Calculate 3D hits from an input list of 2D hits.

Parameters

pAlgorithm	the hit creation algorithm
inputTwoDHits	the input vector of 2D hits
matchedSlidingFitMap	the group of sliding fit results
protoHitVector	to receive the new three dimensional proto hits

Implements lar_content::TrackHitsBaseTool.

Definition at line 21 of file TransverseTrackHitsBaseTool.cc.

References lar_content::ThreeDHitCreationAlgorithm::ProtoHit::GetChi2(), and lar_content::ThreeDHitCreationAlgorithm::ProtoHit::IsPositionSet().

{
    for (const CaloHit *const pCaloHit2D : inputTwoDHits)
    {
        try
        {
            ProtoHit protoHit(pCaloHit2D);
            this->GetTransverseTrackHit3D(matchedSlidingFitMap, protoHit);
            this->AddTransverseChi2(matchedSlidingFitMap, protoHit);

            if (protoHit.IsPositionSet() && (protoHit.GetChi2() < m_chiSquaredCut))
                protoHitVector.push_back(protoHit);
        }
        catch (StatusCodeException &)
        {
        }
    }
}

double lar_content::TransverseTrackHitsBaseTool::GetTransverseChi2 ( const pandora::CartesianVector &  position2D, const TwoDSlidingFitResult &  fitResult  ) const

private

Calculate an additional contribution to the chi-squared based on the steepness of the track.

Parameters

position2D	the calculated two dimensional position
fitResult	the sliding fit to the track

Definition at line 64 of file TransverseTrackHitsBaseTool.cc.

References lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerDirection(), lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerPosition(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerDirection(), and lar_content::TwoDSlidingFitResult::GetGlobalMinLayerPosition().

{
    const float minLayerX(fitResult.GetGlobalMinLayerPosition().GetX());
    const float maxLayerX(fitResult.GetGlobalMaxLayerPosition().GetX());

    const float minX(std::min(minLayerX, maxLayerX));
    const float maxX(std::max(minLayerX, maxLayerX));

    if (((position2D.GetX() - minX) > -std::numeric_limits<float>::epsilon()) && ((position2D.GetX() - maxX) < +std::numeric_limits<float>::epsilon()))
        return 0.;

    const float minLayerDistanceSquared((position2D - fitResult.GetGlobalMinLayerPosition()).GetMagnitudeSquared());
    const float maxLayerDistanceSquared((position2D - fitResult.GetGlobalMaxLayerPosition()).GetMagnitudeSquared());

    double px(0.), pz(0.);

    if (minLayerDistanceSquared < maxLayerDistanceSquared)
    {
        px = fitResult.GetGlobalMinLayerDirection().GetX();
        pz = fitResult.GetGlobalMinLayerDirection().GetZ();
    }
    else if (maxLayerDistanceSquared < minLayerDistanceSquared)
    {
        px = fitResult.GetGlobalMaxLayerDirection().GetX();
        pz = fitResult.GetGlobalMaxLayerDirection().GetZ();
    }

    if (std::fabs(px) > std::numeric_limits<double>::epsilon())
    {
        return (0.5 * (pz * pz) / (px * px)); // TODO: Figure out the appropriate scale factor
    }

    throw StatusCodeException(STATUS_CODE_NOT_FOUND);
}

virtual void lar_content::TransverseTrackHitsBaseTool::GetTransverseTrackHit3D ( const MatchedSlidingFitMap &  matchedSlidingFitMap, ProtoHit &  protoHit  ) const

protectedpure virtual

Get the three dimensional position using a provided two dimensional calo hit and sliding linear fits in the other two views.

Parameters

matchedSlidingFitMap	map of sliding fit results from each view
protoHit	to receive the populated proto hit

Implemented in lar_content::ClearTransverseTrackHitsTool, and lar_content::MultiValuedTransverseTrackHitsTool.

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

protectedvirtualinherited

Reimplemented from lar_content::HitCreationBaseTool.

Reimplemented in lar_content::LongitudinalTrackHitsBaseTool.

Definition at line 93 of file TrackHitsBaseTool.cc.

References lar_content::TrackHitsBaseTool::m_minViews, lar_content::TrackHitsBaseTool::m_slidingFitWindow, and lar_content::HitCreationBaseTool::ReadSettings().

Referenced by lar_content::LongitudinalTrackHitsBaseTool::ReadSettings().

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinViews", m_minViews));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitWindow", m_slidingFitWindow));

    return HitCreationBaseTool::ReadSettings(xmlHandle);
}

void lar_content::TrackHitsBaseTool::Run ( ThreeDHitCreationAlgorithm *const  pAlgorithm, const pandora::ParticleFlowObject *const  pPfo, const pandora::CaloHitVector &  inputTwoDHits, ProtoHitVector &  protoHitVector  )

virtualinherited

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
pPfo	the address of the pfo
inputTwoDHits	the vector of input two dimensional hits
protoHitVector	to receive the new three dimensional proto hits

Implements lar_content::HitCreationBaseTool.

Definition at line 31 of file TrackHitsBaseTool.cc.

References lar_content::TrackHitsBaseTool::BuildSlidingFitMap(), lar_content::TrackHitsBaseTool::GetTrackHits3D(), and lar_content::LArPfoHelper::IsTrack().

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

    try
    {
        if (!LArPfoHelper::IsTrack(pPfo))
            return;

        MatchedSlidingFitMap matchedSlidingFitMap;
        this->BuildSlidingFitMap(pPfo, matchedSlidingFitMap);

        if (matchedSlidingFitMap.size() < 2)
            return;

        this->GetTrackHits3D(inputTwoDHits, matchedSlidingFitMap, protoHitVector);
    }
    catch (StatusCodeException &)
    {
    }
}

Member Data Documentation

double lar_content::HitCreationBaseTool::m_chiSquaredCut

protectedinherited

The chi squared cut (accept only values below the cut value)

Definition at line 86 of file HitCreationBaseTool.h.

Referenced by lar_content::ShowerHitsBaseTool::GetShowerHits3D(), lar_content::LongitudinalTrackHitsBaseTool::GetTrackHits3D(), and lar_content::HitCreationBaseTool::ReadSettings().

unsigned int lar_content::TrackHitsBaseTool::m_minViews

protectedinherited

The minimum number of views required for building hits.

Definition at line 58 of file TrackHitsBaseTool.h.

Referenced by lar_content::TrackHitsBaseTool::ReadSettings().

double lar_content::HitCreationBaseTool::m_sigmaX2

protectedinherited

The sigmaX squared value, for calculation of chi2 deltaX term.

Definition at line 85 of file HitCreationBaseTool.h.

Referenced by lar_content::HitCreationBaseTool::ReadSettings(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

unsigned int lar_content::TrackHitsBaseTool::m_slidingFitWindow

protectedinherited

The layer window for the sliding linear fits.

Definition at line 59 of file TrackHitsBaseTool.h.

Referenced by lar_content::TrackHitsBaseTool::BuildSlidingFitMap(), and lar_content::TrackHitsBaseTool::ReadSettings().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArHitCreation/TransverseTrackHitsBaseTool.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArHitCreation/TransverseTrackHitsBaseTool.cc