lar_content::EventReadingAlgorithm Class Reference

EventReadingAlgorithm class. More...

#include "EventReadingAlgorithm.h"

Inheritance diagram for lar_content::EventReadingAlgorithm:

Classes
class	ExternalEventReadingParameters
	External event reading parameters class. More...

Public Member Functions
	EventReadingAlgorithm ()
	Default constructor. More...
	~EventReadingAlgorithm ()
	Destructor. More...

Private Member Functions
pandora::StatusCode	Initialize ()
pandora::StatusCode	Run ()
void	MoveToNextEventFile ()
	Proceed to process next event file named in the input list. More...
pandora::StatusCode	ReplaceEventFileReader (const std::string &fileName)
	Replace the current event file reader with a new reader for the specified file. More...
pandora::FileType	GetFileType (const std::string &fileName) const
	Analyze a provided file name to extract the file type/extension. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
std::string	m_geometryFileName
	Name of the file containing geometry information. More...
std::string	m_eventFileName
	Name of the current file containing event information. More...
pandora::StringVector	m_eventFileNameVector
	Vector of file names to be processed. More...
unsigned int	m_skipToEvent
	Index of first event to consider in first input file. More...
bool	m_useLArCaloHits
	Whether to read lar calo hits, or standard pandora calo hits. More...
unsigned int	m_larCaloHitVersion
	LArCaloHit version for LArCaloHitFactory. More...
bool	m_useLArMCParticles
	Whether to read lar mc particles, or standard pandora mc particles. More...
unsigned int	m_larMCParticleVersion
	LArMCParticle version for LArMCParticleFactory. More...
pandora::FileReader *	m_pEventFileReader
	Address of the event file reader. More...

Detailed Description

EventReadingAlgorithm class.

Definition at line 30 of file EventReadingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::EventReadingAlgorithm::EventReadingAlgorithm

(

)

Default constructor.

Definition at line 26 of file EventReadingAlgorithm.cc.

                                             :
    m_skipToEvent(0),
    m_useLArCaloHits(true),
    m_larCaloHitVersion(1),
    m_useLArMCParticles(true),
    m_larMCParticleVersion(2),
    m_pEventFileReader(nullptr)
{
}

lar_content::EventReadingAlgorithm::~EventReadingAlgorithm

(

)

Destructor.

Definition at line 38 of file EventReadingAlgorithm.cc.

References m_pEventFileReader.

{
    delete m_pEventFileReader;
}

Member Function Documentation

FileType lar_content::EventReadingAlgorithm::GetFileType ( const std::string &  fileName ) const

private

Analyze a provided file name to extract the file type/extension.

Parameters

fileName

the file name

Returns

the file type

Definition at line 152 of file EventReadingAlgorithm.cc.

Referenced by Initialize(), and ReplaceEventFileReader().

{
    std::string fileExtension(fileName.substr(fileName.find_last_of(".")));
    std::transform(fileExtension.begin(), fileExtension.end(), fileExtension.begin(), ::tolower);

    if (std::string(".xml") == fileExtension)
    {
        return XML;
    }
    else if (std::string(".pndr") == fileExtension)
    {
        return BINARY;
    }
    else
    {
        std::cout << "EventReadingAlgorithm: Unknown file type specified " << fileName << std::endl;
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
    }
}

StatusCode lar_content::EventReadingAlgorithm::Initialize ( )

private

Definition at line 45 of file EventReadingAlgorithm.cc.

References GetFileType(), m_eventFileName, m_geometryFileName, m_pEventFileReader, m_skipToEvent, and ReplaceEventFileReader().

{
    if (!m_geometryFileName.empty())
    {
        const FileType geometryFileType(this->GetFileType(m_geometryFileName));

        if (BINARY == geometryFileType)
        {
            BinaryFileReader fileReader(this->GetPandora(), m_geometryFileName);
            PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, fileReader.ReadGeometry());
        }
        else if (XML == geometryFileType)
        {
            XmlFileReader fileReader(this->GetPandora(), m_geometryFileName);
            PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, fileReader.ReadGeometry());
        }
        else
        {
            return STATUS_CODE_FAILURE;
        }
    }

    if (!m_eventFileName.empty())
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->ReplaceEventFileReader(m_eventFileName));
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pEventFileReader->GoToEvent(m_skipToEvent));
    }

    return STATUS_CODE_SUCCESS;
}

void lar_content::EventReadingAlgorithm::MoveToNextEventFile ( )

private

Proceed to process next event file named in the input list.

Definition at line 99 of file EventReadingAlgorithm.cc.

References m_eventFileName, m_eventFileNameVector, m_pEventFileReader, and ReplaceEventFileReader().

Referenced by Run().

{
    if (m_eventFileNameVector.empty())
        throw StopProcessingException("All event files processed");

    m_eventFileName = m_eventFileNameVector.back();
    m_eventFileNameVector.pop_back();
    PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->ReplaceEventFileReader(m_eventFileName));

    try
    {
        m_pEventFileReader->ReadEvent();
    }
    catch (const StatusCodeException &)
    {
        this->MoveToNextEventFile();
    }
}

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

private

Definition at line 174 of file EventReadingAlgorithm.cc.

References m_eventFileName, lar_content::EventReadingAlgorithm::ExternalEventReadingParameters::m_eventFileNameList, m_eventFileNameVector, lar_content::EventReadingAlgorithm::ExternalEventReadingParameters::m_geometryFileName, m_geometryFileName, m_larCaloHitVersion, m_larMCParticleVersion, lar_content::EventReadingAlgorithm::ExternalEventReadingParameters::m_skipToEvent, m_skipToEvent, m_useLArCaloHits, and m_useLArMCParticles.

{
    ExternalEventReadingParameters *pExternalParameters(nullptr);

    if (this->ExternalParametersPresent())
    {
        pExternalParameters = dynamic_cast<ExternalEventReadingParameters *>(this->GetExternalParameters());

        if (!pExternalParameters)
            return STATUS_CODE_FAILURE;
    }

    if (pExternalParameters && !pExternalParameters->m_geometryFileName.empty())
    {
        m_geometryFileName = pExternalParameters->m_geometryFileName;
    }
    else
    {
        PANDORA_RETURN_RESULT_IF_AND_IF(
            STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "GeometryFileName", m_geometryFileName));
    }

    if (pExternalParameters && !pExternalParameters->m_eventFileNameList.empty())
    {
        XmlHelper::TokenizeString(pExternalParameters->m_eventFileNameList, m_eventFileNameVector, ":");
    }
    else
    {
        PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
            XmlHelper::ReadVectorOfValues(xmlHandle, "EventFileNameList", m_eventFileNameVector));
    }

    if (!m_eventFileNameVector.empty())
    {
        std::reverse(m_eventFileNameVector.begin(), m_eventFileNameVector.end());
        m_eventFileName = m_eventFileNameVector.back();
        m_eventFileNameVector.pop_back();
    }

    if (pExternalParameters && pExternalParameters->m_skipToEvent.IsInitialized())
    {
        m_skipToEvent = pExternalParameters->m_skipToEvent.Get();
    }
    else
    {
        PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SkipToEvent", m_skipToEvent));
    }

    if (m_geometryFileName.empty() && m_eventFileName.empty())
    {
        std::cout << "EventReadingAlgorithm - nothing to do; neither geometry nor event file specified." << std::endl;
        return STATUS_CODE_NOT_INITIALIZED;
    }

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseLArCaloHits", m_useLArCaloHits));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "LArCaloHitVersion", m_larCaloHitVersion));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "LArMCParticleVersion", m_larMCParticleVersion));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseLArMCParticles", m_useLArMCParticles));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::EventReadingAlgorithm::ReplaceEventFileReader ( const std::string &  fileName )

private

Replace the current event file reader with a new reader for the specified file.

Parameters

fileName

the file name

Definition at line 120 of file EventReadingAlgorithm.cc.

References GetFileType(), m_larCaloHitVersion, m_larMCParticleVersion, m_pEventFileReader, m_useLArCaloHits, and m_useLArMCParticles.

Referenced by Initialize(), and MoveToNextEventFile().

{
    delete m_pEventFileReader;
    m_pEventFileReader = nullptr;

    std::cout << "EventReadingAlgorithm: Processing event file: " << fileName << std::endl;
    const FileType eventFileType(this->GetFileType(fileName));

    if (BINARY == eventFileType)
    {
        m_pEventFileReader = new BinaryFileReader(this->GetPandora(), fileName);
    }
    else if (XML == eventFileType)
    {
        m_pEventFileReader = new XmlFileReader(this->GetPandora(), fileName);
    }
    else
    {
        return STATUS_CODE_FAILURE;
    }

    if (m_useLArCaloHits)
        m_pEventFileReader->SetFactory(new LArCaloHitFactory(m_larCaloHitVersion));

    if (m_useLArMCParticles)
        m_pEventFileReader->SetFactory(new LArMCParticleFactory(m_larMCParticleVersion));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::EventReadingAlgorithm::Run ( )

private

Definition at line 78 of file EventReadingAlgorithm.cc.

References m_eventFileName, m_pEventFileReader, and MoveToNextEventFile().

{
    if ((nullptr != m_pEventFileReader) && !m_eventFileName.empty())
    {
        try
        {
            m_pEventFileReader->ReadEvent();
        }
        catch (const StatusCodeException &)
        {
            this->MoveToNextEventFile();
        }

        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::RepeatEventPreparation(*this));
    }

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

std::string lar_content::EventReadingAlgorithm::m_eventFileName

private

Name of the current file containing event information.

Definition at line 82 of file EventReadingAlgorithm.h.

Referenced by Initialize(), MoveToNextEventFile(), ReadSettings(), and Run().

pandora::StringVector lar_content::EventReadingAlgorithm::m_eventFileNameVector

private

Vector of file names to be processed.

Definition at line 83 of file EventReadingAlgorithm.h.

Referenced by MoveToNextEventFile(), and ReadSettings().

std::string lar_content::EventReadingAlgorithm::m_geometryFileName

private

Name of the file containing geometry information.

Definition at line 81 of file EventReadingAlgorithm.h.

Referenced by Initialize(), and ReadSettings().

unsigned int lar_content::EventReadingAlgorithm::m_larCaloHitVersion

private

LArCaloHit version for LArCaloHitFactory.

Definition at line 87 of file EventReadingAlgorithm.h.

Referenced by ReadSettings(), and ReplaceEventFileReader().

unsigned int lar_content::EventReadingAlgorithm::m_larMCParticleVersion

private

LArMCParticle version for LArMCParticleFactory.

Definition at line 89 of file EventReadingAlgorithm.h.

Referenced by ReadSettings(), and ReplaceEventFileReader().

pandora::FileReader* lar_content::EventReadingAlgorithm::m_pEventFileReader

private

Address of the event file reader.

Definition at line 91 of file EventReadingAlgorithm.h.

Referenced by Initialize(), MoveToNextEventFile(), ReplaceEventFileReader(), Run(), and ~EventReadingAlgorithm().

unsigned int lar_content::EventReadingAlgorithm::m_skipToEvent

private

Index of first event to consider in first input file.

Definition at line 85 of file EventReadingAlgorithm.h.

Referenced by Initialize(), and ReadSettings().

bool lar_content::EventReadingAlgorithm::m_useLArCaloHits

private

Whether to read lar calo hits, or standard pandora calo hits.

Definition at line 86 of file EventReadingAlgorithm.h.

Referenced by ReadSettings(), and ReplaceEventFileReader().

bool lar_content::EventReadingAlgorithm::m_useLArMCParticles

private

Whether to read lar mc particles, or standard pandora mc particles.

Definition at line 88 of file EventReadingAlgorithm.h.

Referenced by ReadSettings(), and ReplaceEventFileReader().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArPersistency/EventReadingAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArPersistency/EventReadingAlgorithm.cc