TestBeamParticleCreationAlgorithm class. More...

#include "TestBeamParticleCreationAlgorithm.h"

Inheritance diagram for lar_content::TestBeamParticleCreationAlgorithm:

Private Member Functions
pandora::StatusCode	Run ()

pandora::StatusCode	SetupTestBeamPfo (const pandora::Pfo const pNuPfo, const pandora::Pfo &pTestBeamPfo, pandora::CartesianVector &testBeamStartVertex) const
	Set up the test beam pfo. More...

pandora::StatusCode	SetupTestBeamVertex (const pandora::Pfo const pNuPfo, const pandora::Pfo const pTestBeamPfo, const pandora::CartesianVector &testBeamStartVertex) const
	Set up the test beam vertex. More...

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

Private Attributes
std::string	m_parentPfoListName
	The parent pfo list name. More...

std::string	m_trackPfoListName
	The track pfo list name. More...

std::string	m_showerPfoListName
	The shower pfo list name. More...

std::string	m_parentVertexListName
	The parent vertex list name. More...

std::string	m_daughterVertexListName
	The daughter vertex list name. More...

Detailed Description

TestBeamParticleCreationAlgorithm class.

Definition at line 19 of file TestBeamParticleCreationAlgorithm.h.

Member Function Documentation

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

private

Definition at line 149 of file TestBeamParticleCreationAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ParentPfoListName", m_parentPfoListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "TrackPfoListName", m_trackPfoListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ShowerPfoListName", m_showerPfoListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ParentVertexListName", m_parentVertexListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "DaughterVertexListName", m_daughterVertexListName));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::TestBeamParticleCreationAlgorithm::Run ( )

private

Definition at line 20 of file TestBeamParticleCreationAlgorithm.cc.

 {
     const PfoList *pParentNuPfoList(nullptr);
 
     if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, m_parentPfoListName, pParentNuPfoList))
     {
         if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
             std::cout << "TestBeamParticleCreationAlgorithm: pfo list " << m_parentPfoListName << " unavailable." << std::endl;
 
         return STATUS_CODE_SUCCESS;
     }
 
     PfoList neutrinoPfos;
 
     for (const Pfo *const pNuPfo : *pParentNuPfoList)
     {
         if (!LArPfoHelper::IsNeutrino(pNuPfo))
             continue;
 
         neutrinoPfos.push_back(pNuPfo);
 
         const Pfo *pTestBeamPfo(nullptr);
         CartesianVector testBeamStartVertex(std::numeric_limits<float>::max(), std::numeric_limits<float>::max(), std::numeric_limits<float>::max());
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->SetupTestBeamPfo(pNuPfo, pTestBeamPfo, testBeamStartVertex));
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->SetupTestBeamVertex(pNuPfo, pTestBeamPfo, testBeamStartVertex));
     }
 
     for (const Pfo *const pNuPfo : neutrinoPfos)
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete<Pfo>(*this, pNuPfo, m_parentPfoListName));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::TestBeamParticleCreationAlgorithm::SetupTestBeamPfo	(	const pandora::Pfo *const	pNuPfo,
		const pandora::Pfo *&	pTestBeamPfo,
		pandora::CartesianVector &	testBeamStartVertex
	)		const

private

Set up the test beam pfo.

Parameters

pNuPfo	the input neutrino-hypothesis pfo
pTestBeamPfo	to receive the output test-beam-hypothesis pfo
testBeamStartVertex	to receive the position of the test beam start-position vertex (position of hit at minimum z)

Returns: status code

Definition at line 55 of file TestBeamParticleCreationAlgorithm.cc.

 {
     pTestBeamPfo = nullptr;
     testBeamStartVertex = CartesianVector(std::numeric_limits<float>::max(), std::numeric_limits<float>::max(), std::numeric_limits<float>::max());
 
     for (const Pfo *const pNuDaughterPfo : pNuPfo->GetDaughterPfoList())
     {
         CaloHitList collectedHits;
         LArPfoHelper::GetCaloHits(pNuDaughterPfo, TPC_3D, collectedHits);
 
         for (const CaloHit *const pCaloHit : collectedHits)
         {
             if (pCaloHit->GetPositionVector().GetZ() < testBeamStartVertex.GetZ())
             {
                 testBeamStartVertex = pCaloHit->GetPositionVector();
                 pTestBeamPfo = pNuDaughterPfo;
             }
         }
     }
 
     if (!pTestBeamPfo)
         return STATUS_CODE_NOT_FOUND;
 
     for (const Pfo *const pNuDaughterPfo : pNuPfo->GetDaughterPfoList())
     {
         if (pNuDaughterPfo != pTestBeamPfo)
             PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SetPfoParentDaughterRelationship(*this, pTestBeamPfo, pNuDaughterPfo));
     }
 
     // Move test beam pfo to parent list from its initial track or shower list
     const std::string &originalListName(LArPfoHelper::IsTrack(pTestBeamPfo) ? m_trackPfoListName : m_showerPfoListName);
     PANDORA_RETURN_RESULT_IF(
         STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, originalListName, m_parentPfoListName, PfoList(1, pTestBeamPfo)));
 
     // Alter metadata: test beam score (1, if not previously set) and particle id (electron if primary pfo shower-like, else charged pion)
     PandoraContentApi::ParticleFlowObject::Metadata pfoMetadata;
     pfoMetadata.m_propertiesToAdd["IsTestBeam"] = 1.f;
     pfoMetadata.m_propertiesToAdd["TestBeamScore"] =
         (pNuPfo->GetPropertiesMap().count("TestBeamScore")) ? pNuPfo->GetPropertiesMap().at("TestBeamScore") : 1.f;
     pfoMetadata.m_particleId = (std::fabs(pTestBeamPfo->GetParticleId()) == E_MINUS) ? E_MINUS : PI_PLUS;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*this, pTestBeamPfo, pfoMetadata));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::TestBeamParticleCreationAlgorithm::SetupTestBeamVertex	(	const pandora::Pfo *const	pNuPfo,
		const pandora::Pfo *const	pTestBeamPfo,
		const pandora::CartesianVector &	testBeamStartVertex
	)		const

private

Set up the test beam vertex.

Parameters

pNuPfo	the input neutrino-hypothesis pfo
pTestBeamPfo	the input test-beam-hypothesis pfo
testBeamStartVertex	the input position of the test beam start-position vertex

Returns: status code

Definition at line 102 of file TestBeamParticleCreationAlgorithm.cc.

 {
     try
     {
         const Vertex *const pInitialVertex(LArPfoHelper::GetVertex(pTestBeamPfo));
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::RemoveFromPfo(*this, pTestBeamPfo, pInitialVertex));
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete<Vertex>(*this, pInitialVertex, m_daughterVertexListName));
     }
     catch (const StatusCodeException &)
     {
         std::cout << "TestBeamParticleCreationAlgorithm::SetupTestBeamVertex - Test beam particle has no initial vertex" << std::endl;
     }
 
     // Set start vertex
     std::string vertexListName;
     const VertexList *pVertexList(nullptr);
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pVertexList, vertexListName));
 
     PandoraContentApi::Vertex::Parameters parameters;
     parameters.m_position = testBeamStartVertex;
     parameters.m_vertexLabel = VERTEX_START;
     parameters.m_vertexType = VERTEX_3D;
     const Vertex *pTestBeamStartVertex(nullptr);
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Vertex::Create(*this, parameters, pTestBeamStartVertex));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Vertex>(*this, m_parentVertexListName));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToPfo(*this, pTestBeamPfo, pTestBeamStartVertex));
 
     // Retain interaction vertex
     try
     {
         const Vertex *const pNuVertex(LArPfoHelper::GetVertex(pNuPfo));
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::RemoveFromPfo(*this, pNuPfo, pNuVertex));
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToPfo(*this, pTestBeamPfo, pNuVertex));
         // ATTN This vertex already lives in m_parentVertexListName
     }
     catch (const StatusCodeException &)
     {
         std::cout << "TestBeamParticleCreationAlgorithm::SetupTestBeamVertex - Cannot transfer interaction vertex to test beam particle" << std::endl;
     }
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Vertex>(*this, m_parentVertexListName));
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

std::string lar_content::TestBeamParticleCreationAlgorithm::m_daughterVertexListName

private

The daughter vertex list name.

Definition at line 55 of file TestBeamParticleCreationAlgorithm.h.

std::string lar_content::TestBeamParticleCreationAlgorithm::m_parentPfoListName

private

The parent pfo list name.

Definition at line 50 of file TestBeamParticleCreationAlgorithm.h.

std::string lar_content::TestBeamParticleCreationAlgorithm::m_parentVertexListName

private

The parent vertex list name.

Definition at line 54 of file TestBeamParticleCreationAlgorithm.h.

std::string lar_content::TestBeamParticleCreationAlgorithm::m_showerPfoListName

private

The shower pfo list name.

Definition at line 52 of file TestBeamParticleCreationAlgorithm.h.

std::string lar_content::TestBeamParticleCreationAlgorithm::m_trackPfoListName

private

The track pfo list name.

Definition at line 51 of file TestBeamParticleCreationAlgorithm.h.

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArEventBuilding/TestBeamParticleCreationAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArEventBuilding/TestBeamParticleCreationAlgorithm.cc

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation