lar_content::ClearTracksTool Class Reference

ClearTracksTool class. More...

#include "ClearTracksTool.h"

Inheritance diagram for lar_content::ClearTracksTool:

Public Types
typedef ThreeDTransverseTracksAlgorithm::TensorType	TensorType
typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

Public Member Functions
	ClearTracksTool ()
	Default constructor. More...
bool	Run (ThreeDTransverseTracksAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
void	CreateThreeDParticles (ThreeDTransverseTracksAlgorithm *const pAlgorithm, const TensorType::ElementList &elementList, bool &particlesMade) const
	Create three dimensional particles for a given tensor element list. More...

Private Attributes
float	m_minMatchedFraction
	The min matched sampling point fraction for particle creation. More...
float	m_minXOverlapFraction
	The min x overlap fraction (in each view) for particle creation. More...

Detailed Description

ClearTracksTool class.

Definition at line 19 of file ClearTracksTool.h.

Member Typedef Documentation

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::TransverseTensorTool::IteratorList

inherited

Definition at line 128 of file ThreeDTransverseTracksAlgorithm.h.

typedef ThreeDTransverseTracksAlgorithm::TensorType lar_content::TransverseTensorTool::TensorType

inherited

Definition at line 127 of file ThreeDTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ClearTracksTool::ClearTracksTool

(

)

Default constructor.

Definition at line 17 of file ClearTracksTool.cc.

                                 :
    m_minMatchedFraction(0.9f),
    m_minXOverlapFraction(0.9f)
{
}

Member Function Documentation

void lar_content::ClearTracksTool::CreateThreeDParticles ( ThreeDTransverseTracksAlgorithm *const  pAlgorithm, const TensorType::ElementList &  elementList, bool &  particlesMade  ) const

private

Create three dimensional particles for a given tensor element list.

Parameters

pAlgorithm	address of the calling algorithm (ultimately responsible for the particles)
elementList	the tensor element list
particlesMade	receive boolean indicating whether particles have been made

Definition at line 41 of file ClearTracksTool.cc.

References lar_content::ThreeDBaseAlgorithm< T >::CreateThreeDParticles(), lar_content::ProtoParticle::m_clusterListU, lar_content::ProtoParticle::m_clusterListV, lar_content::ProtoParticle::m_clusterListW, m_minMatchedFraction, and m_minXOverlapFraction.

Referenced by Run().

{
    ProtoParticleVector protoParticleVector;

    for (TensorType::ElementList::const_iterator iter = elementList.begin(), iterEnd = elementList.end(); iter != iterEnd; ++iter)
    {
        if (iter->GetOverlapResult().GetMatchedFraction() < m_minMatchedFraction)
            continue;

        const XOverlap &xOverlap(iter->GetOverlapResult().GetXOverlap());

        if ((xOverlap.GetXSpanU() < std::numeric_limits<float>::epsilon()) || (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanU() < m_minXOverlapFraction))
            continue;

        if ((xOverlap.GetXSpanV() < std::numeric_limits<float>::epsilon()) || (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanV() < m_minXOverlapFraction))
            continue;

        if ((xOverlap.GetXSpanW() < std::numeric_limits<float>::epsilon()) || (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanW() < m_minXOverlapFraction))
            continue;

        ProtoParticle protoParticle;
        protoParticle.m_clusterListU.push_back(iter->GetClusterU());
        protoParticle.m_clusterListV.push_back(iter->GetClusterV());
        protoParticle.m_clusterListW.push_back(iter->GetClusterW());
        protoParticleVector.push_back(protoParticle);
    }

    particlesMade |= pAlgorithm->CreateThreeDParticles(protoParticleVector);
}

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

private

Definition at line 74 of file ClearTracksTool.cc.

References m_minMatchedFraction, and m_minXOverlapFraction.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
        "MinMatchedFraction", m_minMatchedFraction));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
        "MinXOverlapFraction", m_minXOverlapFraction));

    return STATUS_CODE_SUCCESS;
}

bool lar_content::ClearTracksTool::Run ( ThreeDTransverseTracksAlgorithm *const  pAlgorithm, TensorType &  overlapTensor  )

virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns

whether changes have been made by the tool

Implements lar_content::TransverseTensorTool.

Definition at line 25 of file ClearTracksTool.cc.

References CreateThreeDParticles(), and lar_content::OverlapTensor< T >::GetUnambiguousElements().

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

    bool particlesMade(false);

    TensorType::ElementList elementList;
    overlapTensor.GetUnambiguousElements(true, elementList);
    this->CreateThreeDParticles(pAlgorithm, elementList, particlesMade);

    return particlesMade;
}

Member Data Documentation

float lar_content::ClearTracksTool::m_minMatchedFraction

private

The min matched sampling point fraction for particle creation.

Definition at line 41 of file ClearTracksTool.h.

Referenced by CreateThreeDParticles(), and ReadSettings().

float lar_content::ClearTracksTool::m_minXOverlapFraction

private

The min x overlap fraction (in each view) for particle creation.

Definition at line 42 of file ClearTracksTool.h.

Referenced by CreateThreeDParticles(), and ReadSettings().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/ClearTracksTool.h
• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/ClearTracksTool.cc