lar_content::NeutrinoPropertiesAlgorithm Class Reference

NeutrinoPropertiesAlgorithm class. More...

#include "NeutrinoPropertiesAlgorithm.h"

Inheritance diagram for lar_content::NeutrinoPropertiesAlgorithm:

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

Private Member Functions
pandora::StatusCode	Run ()
void	SetNeutrinoId (const pandora::ParticleFlowObject *const pNeutrinoPfo) const
	identifying the primary daughter of a neutrino pfo and set the particle id accordingly More...
unsigned int	GetNTwoDHitsInPfoChain (const pandora::ParticleFlowObject *const pPfo) const
	Get the number of two dimensional hits (TPC_VIEW_U, V or W) contained in clusters in a pfo and all its daughters. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
std::string	m_neutrinoPfoListName
	The name of the output neutrino pfo list. More...
bool	m_includeIsolatedHits
	Whether to include isolated hits when counting 2d hits in pfo chain. More...

Detailed Description

NeutrinoPropertiesAlgorithm class.

Definition at line 19 of file NeutrinoPropertiesAlgorithm.h.

Constructor & Destructor Documentation

lar_content::NeutrinoPropertiesAlgorithm::NeutrinoPropertiesAlgorithm

(

)

Default constructor.

Definition at line 21 of file NeutrinoPropertiesAlgorithm.cc.

                                                         :
    m_includeIsolatedHits(false)
{
}

Member Function Documentation

unsigned int lar_content::NeutrinoPropertiesAlgorithm::GetNTwoDHitsInPfoChain ( const pandora::ParticleFlowObject *const  pPfo ) const

private

Get the number of two dimensional hits (TPC_VIEW_U, V or W) contained in clusters in a pfo and all its daughters.

Parameters

pPfo	address of the pfo

Returns

the number of two dimensional hits

Definition at line 105 of file NeutrinoPropertiesAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), and m_includeIsolatedHits.

Referenced by SetNeutrinoId().

{
    unsigned int nTwoDHits(0);

    for (const Cluster *const pCluster : pPfo->GetClusterList())
    {
        const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));

        if ((TPC_VIEW_U == hitType) || (TPC_VIEW_V == hitType) || (TPC_VIEW_W == hitType))
        {
            nTwoDHits += pCluster->GetNCaloHits();

            if (m_includeIsolatedHits)
                nTwoDHits += pCluster->GetNIsolatedCaloHits();
        }
    }

    for (const ParticleFlowObject *const pDaughterPfo : pPfo->GetDaughterPfoList())
    {
        nTwoDHits += this->GetNTwoDHitsInPfoChain(pDaughterPfo);
    }

    return nTwoDHits;
}

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

private

Definition at line 132 of file NeutrinoPropertiesAlgorithm.cc.

References m_includeIsolatedHits, and m_neutrinoPfoListName.

{
    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,
        "IncludeIsolatedHits", m_includeIsolatedHits));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::NeutrinoPropertiesAlgorithm::Run ( )

private

Definition at line 28 of file NeutrinoPropertiesAlgorithm.cc.

References lar_content::LArPfoHelper::IsNeutrino(), m_neutrinoPfoListName, and SetNeutrinoId().

{
    const PfoList *pPfoList(nullptr);
    PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, m_neutrinoPfoListName, pPfoList));

    if (!pPfoList || pPfoList->empty())
    {
        if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
            std::cout << "NeutrinoPropertiesAlgorithm: unable to find pfo list " << m_neutrinoPfoListName << std::endl;

        return STATUS_CODE_SUCCESS;
    }

    // ATTN Enforces that only one pfo, of neutrino-type, be in the specified input list
    const ParticleFlowObject *const pNeutrinoPfo((1 == pPfoList->size()) ? *(pPfoList->begin()) : nullptr);

    if (!pNeutrinoPfo || !LArPfoHelper::IsNeutrino(pNeutrinoPfo))
        return STATUS_CODE_FAILURE;

    // ATTN At this (maybe unconventional) stage, remove any lone, placeholder neutrinos, with no daughter particles
    if (pNeutrinoPfo->GetDaughterPfoList().empty())
    {
        PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete(*this, pNeutrinoPfo, m_neutrinoPfoListName));
    }
    else
    {
        this->SetNeutrinoId(pNeutrinoPfo);
    }

    return STATUS_CODE_SUCCESS;
}

void lar_content::NeutrinoPropertiesAlgorithm::SetNeutrinoId ( const pandora::ParticleFlowObject *const  pNeutrinoPfo ) const

private

identifying the primary daughter of a neutrino pfo and set the particle id accordingly

Parameters

pNeutrinoPfo

address of the neutrino pfo

Definition at line 62 of file NeutrinoPropertiesAlgorithm.cc.

References GetNTwoDHitsInPfoChain(), and lar_content::LArPfoHelper::SortByNHits().

Referenced by Run().

{
    unsigned int nPrimaryTwoDHits(0);
    const ParticleFlowObject *pPrimaryDaughter(nullptr);

    PfoVector daughterPfoVector(pNeutrinoPfo->GetDaughterPfoList().begin(), pNeutrinoPfo->GetDaughterPfoList().end());
    std::sort(daughterPfoVector.begin(), daughterPfoVector.end(), LArPfoHelper::SortByNHits);

    for (const ParticleFlowObject *const pDaughterPfo : daughterPfoVector)
    {
        const unsigned int nTwoDHits(this->GetNTwoDHitsInPfoChain(pDaughterPfo));

        if (!pPrimaryDaughter || (nTwoDHits > nPrimaryTwoDHits))
        {
            nPrimaryTwoDHits = nTwoDHits;
            pPrimaryDaughter = pDaughterPfo;
        }
    }

    if (!pPrimaryDaughter)
        throw StatusCodeException(STATUS_CODE_FAILURE);

    PandoraContentApi::ParticleFlowObject::Metadata metadata;

    if (E_MINUS == std::abs(pPrimaryDaughter->GetParticleId()))
    {
        metadata.m_particleId = NU_E;
    }
    else if (MU_MINUS == std::abs(pPrimaryDaughter->GetParticleId()))
    {
        metadata.m_particleId = NU_MU;
    }

    if (metadata.m_particleId.IsInitialized())
    {
        metadata.m_charge = PdgTable::GetParticleCharge(metadata.m_particleId.Get());
        metadata.m_mass = PdgTable::GetParticleMass(metadata.m_particleId.Get());
        PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*this, pNeutrinoPfo, metadata));
    }
}

Member Data Documentation

bool lar_content::NeutrinoPropertiesAlgorithm::m_includeIsolatedHits

private

Whether to include isolated hits when counting 2d hits in pfo chain.

Definition at line 50 of file NeutrinoPropertiesAlgorithm.h.

Referenced by GetNTwoDHitsInPfoChain(), and ReadSettings().

std::string lar_content::NeutrinoPropertiesAlgorithm::m_neutrinoPfoListName

private

The name of the output neutrino pfo list.

Definition at line 48 of file NeutrinoPropertiesAlgorithm.h.

Referenced by ReadSettings(), and Run().

---

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

• larpandoracontent/v03_13_02/source/larpandoracontent/LArThreeDReco/LArEventBuilding/NeutrinoPropertiesAlgorithm.h
• larpandoracontent/v03_13_02/source/larpandoracontent/LArThreeDReco/LArEventBuilding/NeutrinoPropertiesAlgorithm.cc