lar_content::NeutrinoCreationAlgorithm Class Reference

NeutrinoCreationAlgorithm class. More...

#include "NeutrinoCreationAlgorithm.h"

Inheritance diagram for lar_content::NeutrinoCreationAlgorithm:

Public Member Functions
	NeutrinoCreationAlgorithm ()
	Default constructor. More...

Private Member Functions
pandora::StatusCode	Run ()
pandora::StatusCode	ForceSingleEmptyNeutrino () const
	Force creation of a single neutrino, with no vertex, regardless of number of input vertices. More...
void	FillDefaultNeutrinoParameters (PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Fill provided pfo parameters with default/dummy values for later refinement. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
std::string	m_vertexListName
	The name of the neutrino vertex list. More...
std::string	m_neutrinoPfoListName
	The name of the neutrino pfo list. More...
bool	m_forceSingleEmptyNeutrino
	Whether to force creation of a single neutrino, with no vertex, regardless of number of input vertices. More...

Detailed Description

NeutrinoCreationAlgorithm class.

Definition at line 19 of file NeutrinoCreationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::NeutrinoCreationAlgorithm::NeutrinoCreationAlgorithm

(

)

Default constructor.

Definition at line 22 of file NeutrinoCreationAlgorithm.cc.

                                                     :
    m_forceSingleEmptyNeutrino(false)
{
}

Member Function Documentation

void lar_content::NeutrinoCreationAlgorithm::FillDefaultNeutrinoParameters ( PandoraContentApi::ParticleFlowObject::Parameters &  pfoParameters ) const

private

Fill provided pfo parameters with default/dummy values for later refinement.

Parameters

pfoParameters

the pfo parameters

Definition at line 102 of file NeutrinoCreationAlgorithm.cc.

References f.

Referenced by ForceSingleEmptyNeutrino(), and Run().

{
    pfoParameters.m_particleId = NU_MU;
    pfoParameters.m_charge = PdgTable::GetParticleCharge(pfoParameters.m_particleId.Get());
    pfoParameters.m_mass = PdgTable::GetParticleMass(pfoParameters.m_particleId.Get());
    pfoParameters.m_energy = 0.f;
    pfoParameters.m_momentum = CartesianVector(0.f, 0.f, 0.f);
    pfoParameters.m_propertiesToAdd["IsNeutrino"] = 1.f;
}

StatusCode lar_content::NeutrinoCreationAlgorithm::ForceSingleEmptyNeutrino ( ) const

private

Force creation of a single neutrino, with no vertex, regardless of number of input vertices.

Definition at line 78 of file NeutrinoCreationAlgorithm.cc.

References FillDefaultNeutrinoParameters(), and m_neutrinoPfoListName.

Referenced by Run().

{
    std::string neutrinoPfoListName;
    const PfoList *pNeutrinoPfoList(nullptr);
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pNeutrinoPfoList,
        neutrinoPfoListName));

    PandoraContentApi::ParticleFlowObject::Parameters pfoParameters;
    this->FillDefaultNeutrinoParameters(pfoParameters);

    const ParticleFlowObject *pNeutrinoPfo(nullptr);
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::Create(*this, pfoParameters, pNeutrinoPfo));

    if ((!pNeutrinoPfoList) || pNeutrinoPfoList->empty())
        throw StatusCodeException(STATUS_CODE_FAILURE);

    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Pfo>(*this, m_neutrinoPfoListName));
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Pfo>(*this, m_neutrinoPfoListName));

    return STATUS_CODE_SUCCESS;
}

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

private

Definition at line 114 of file NeutrinoCreationAlgorithm.cc.

References m_forceSingleEmptyNeutrino, m_neutrinoPfoListName, and m_vertexListName.

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle,
        "InputVertexListName", m_vertexListName));

    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle,
        "NeutrinoPfoListName", m_neutrinoPfoListName));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
        "ForceSingleEmptyNeutrino", m_forceSingleEmptyNeutrino));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::NeutrinoCreationAlgorithm::Run ( )

private

Definition at line 29 of file NeutrinoCreationAlgorithm.cc.

References FillDefaultNeutrinoParameters(), ForceSingleEmptyNeutrino(), m_forceSingleEmptyNeutrino, m_neutrinoPfoListName, and m_vertexListName.

{
    if (m_forceSingleEmptyNeutrino)
        return this->ForceSingleEmptyNeutrino();

    const VertexList *pVertexList(nullptr);
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, m_vertexListName,
        pVertexList));

    if (!pVertexList || pVertexList->empty())
    {
        if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
            std::cout << "NeutrinoCreationAlgorithm: unable to find vertex list " << m_vertexListName << std::endl;

        return STATUS_CODE_SUCCESS;
    }

    std::string neutrinoPfoListName;
    const PfoList *pNeutrinoPfoList(nullptr);
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pNeutrinoPfoList,
        neutrinoPfoListName));

    for (VertexList::const_iterator vIter = pVertexList->begin(), vIterEnd = pVertexList->end(); vIter != vIterEnd; ++vIter)
    {
        const Vertex *const pVertex = *vIter;

        if (VERTEX_3D != pVertex->GetVertexType())
            throw StatusCodeException(STATUS_CODE_FAILURE);

        // ATTN Placeholder properties to be set by a later neutrino properties algorithm
        PandoraContentApi::ParticleFlowObject::Parameters pfoParameters;
        this->FillDefaultNeutrinoParameters(pfoParameters);
        pfoParameters.m_vertexList.push_back(pVertex);

        const ParticleFlowObject *pNeutrinoPfo(nullptr);
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::Create(*this, pfoParameters, pNeutrinoPfo));
    }

    if ((!pNeutrinoPfoList) || pNeutrinoPfoList->empty())
        throw StatusCodeException(STATUS_CODE_FAILURE);

    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Pfo>(*this, m_neutrinoPfoListName));
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Pfo>(*this, m_neutrinoPfoListName));

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

bool lar_content::NeutrinoCreationAlgorithm::m_forceSingleEmptyNeutrino

private

Whether to force creation of a single neutrino, with no vertex, regardless of number of input vertices.

Definition at line 47 of file NeutrinoCreationAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::NeutrinoCreationAlgorithm::m_neutrinoPfoListName

private

The name of the neutrino pfo list.

Definition at line 45 of file NeutrinoCreationAlgorithm.h.

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

std::string lar_content::NeutrinoCreationAlgorithm::m_vertexListName

private

The name of the neutrino vertex list.

Definition at line 44 of file NeutrinoCreationAlgorithm.h.

Referenced by ReadSettings(), and Run().

---

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

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