lar_content::ClearRemnantsTool Class Reference

ClearRemnantsTool class. More...

#include "ClearRemnantsTool.h"

Inheritance diagram for lar_content::ClearRemnantsTool:

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

Public Member Functions
bool	Run (ThreeDRemnantsAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...

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

Detailed Description

ClearRemnantsTool class.

Definition at line 19 of file ClearRemnantsTool.h.

Member Typedef Documentation

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

inherited

Definition at line 63 of file ThreeDRemnantsAlgorithm.h.

typedef ThreeDRemnantsAlgorithm::TensorType lar_content::RemnantTensorTool::TensorType

inherited

Definition at line 62 of file ThreeDRemnantsAlgorithm.h.

Member Function Documentation

void lar_content::ClearRemnantsTool::CreateThreeDParticles ( ThreeDRemnantsAlgorithm *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 34 of file ClearRemnantsTool.cc.

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

{
    ProtoParticleVector protoParticleVector;

    for (TensorType::ElementList::const_iterator iter = elementList.begin(), iterEnd = elementList.end(); iter != iterEnd; ++iter)
    {
        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::ClearRemnantsTool::ReadSettings ( const pandora::TiXmlHandle  xmlHandle )

private

Definition at line 53 of file ClearRemnantsTool.cc.

{
    return STATUS_CODE_SUCCESS;
}

bool lar_content::ClearRemnantsTool::Run ( ThreeDRemnantsAlgorithm *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::RemnantTensorTool.

Definition at line 18 of file ClearRemnantsTool.cc.

References 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;
}

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArShowerFragments/ClearRemnantsTool.h
• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArShowerFragments/ClearRemnantsTool.cc