TestBeamParticleCreationAlgorithm class. More...

#include "TestBeamParticleCreationAlgorithm.h"

Inheritance diagram for lar_content::TestBeamParticleCreationAlgorithm:

Public Member Functions
	TestBeamParticleCreationAlgorithm ()
	Constructor. More...

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...

bool	m_keepInteractionVertex
	Keep the vertex for the test beam particle at the interaction point. More...

bool	m_keepStartVertex
	Keep the vertex for the test beam particle at the position of hit at minimum z. More...

Detailed Description

TestBeamParticleCreationAlgorithm class.

Definition at line 19 of file TestBeamParticleCreationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::TestBeamParticleCreationAlgorithm::TestBeamParticleCreationAlgorithm ( )

Constructor.

Definition at line 20 of file TestBeamParticleCreationAlgorithm.cc.

                                                                      :
     m_keepInteractionVertex(true),
     m_keepStartVertex(false)
 {
 }

Member Function Documentation

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

private

Definition at line 158 of file TestBeamParticleCreationAlgorithm.cc.

References m_daughterVertexListName, m_keepInteractionVertex, m_keepStartVertex, m_parentPfoListName, m_parentVertexListName, m_showerPfoListName, and m_trackPfoListName.

 {
     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));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "KeepInteractionVertex", m_keepInteractionVertex));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "KeepStartVertex", m_keepStartVertex));
 
     if (m_keepInteractionVertex == m_keepStartVertex)
     {
         std::cout << "TestBeamParticleCreationAlgorithm::ReadSettings - Must persist exactly one vertex per test beam particle." << std::endl;
         return STATUS_CODE_INVALID_PARAMETER;
     }
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::TestBeamParticleCreationAlgorithm::Run ( )

private

Definition at line 28 of file TestBeamParticleCreationAlgorithm.cc.

References lar_content::LArPfoHelper::IsNeutrino(), m_parentPfoListName, max, SetupTestBeamPfo(), and SetupTestBeamVertex().

 {
     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 63 of file TestBeamParticleCreationAlgorithm.cc.

References lar_content::LArPfoHelper::GetCaloHits(), lar_content::LArPfoHelper::IsTrack(), m_parentPfoListName, m_showerPfoListName, m_trackPfoListName, and max.

Referenced by Run().

 {
     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 108 of file TestBeamParticleCreationAlgorithm.cc.

References lar_content::LArPfoHelper::GetVertex(), m_daughterVertexListName, m_keepStartVertex, and m_parentVertexListName.

Referenced by Run().

 {
     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;
     }
 
     if (m_keepStartVertex)
     {
         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::ReplaceCurrentList<Vertex>(*this, m_parentVertexListName));
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToPfo(*this, pTestBeamPfo, pTestBeamStartVertex));
     }
     else
     {
         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;
         }
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

std::string lar_content::TestBeamParticleCreationAlgorithm::m_daughterVertexListName

private

The daughter vertex list name.

Definition at line 59 of file TestBeamParticleCreationAlgorithm.h.

Referenced by ReadSettings(), and SetupTestBeamVertex().

bool lar_content::TestBeamParticleCreationAlgorithm::m_keepInteractionVertex

private

Keep the vertex for the test beam particle at the interaction point.

Definition at line 61 of file TestBeamParticleCreationAlgorithm.h.

Referenced by ReadSettings().

bool lar_content::TestBeamParticleCreationAlgorithm::m_keepStartVertex

private

Keep the vertex for the test beam particle at the position of hit at minimum z.

Definition at line 62 of file TestBeamParticleCreationAlgorithm.h.

Referenced by ReadSettings(), and SetupTestBeamVertex().

std::string lar_content::TestBeamParticleCreationAlgorithm::m_parentPfoListName

private

The parent pfo list name.

Definition at line 54 of file TestBeamParticleCreationAlgorithm.h.

Referenced by ReadSettings(), Run(), and SetupTestBeamPfo().

std::string lar_content::TestBeamParticleCreationAlgorithm::m_parentVertexListName

private

The parent vertex list name.

Definition at line 58 of file TestBeamParticleCreationAlgorithm.h.

Referenced by ReadSettings(), and SetupTestBeamVertex().

std::string lar_content::TestBeamParticleCreationAlgorithm::m_showerPfoListName

private

The shower pfo list name.

Definition at line 56 of file TestBeamParticleCreationAlgorithm.h.

Referenced by ReadSettings(), and SetupTestBeamPfo().

std::string lar_content::TestBeamParticleCreationAlgorithm::m_trackPfoListName

private

The track pfo list name.

Definition at line 55 of file TestBeamParticleCreationAlgorithm.h.

Referenced by ReadSettings(), and SetupTestBeamPfo().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArEventBuilding/TestBeamParticleCreationAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArEventBuilding/TestBeamParticleCreationAlgorithm.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation