gallery::EventNavigator Class Reference

#include <EventNavigator.h>

Public Member Functions
	EventNavigator (std::vector< std::string > const &iFileNames)
bool	isValid () const
bool	atEnd () const
void	toBegin ()
void	next ()
void	previous ()
void	goToEntry (long long entry)
void	nextFile ()
art::EventAuxiliary const &	eventAuxiliary () const
art::History const &	history () const
art::ProcessHistoryID const &	processHistoryID () const
art::ProcessHistory const &	processHistory () const
TFile *	getTFile () const
TTree *	getTTree () const
TBranch *	eventAuxiliaryBranch () const
long long	fileEntry () const
long long	entriesInCurrentFile () const
long long	eventEntry () const

Private Member Functions
void	initializeTTreePointers ()
void	initializeTBranchPointers ()

Private Attributes
std::vector< std::string >	fileNames_
long long	numberOfFiles_
long long	fileEntry_ {-1}
long long	firstFileWithEvent_ {}
long long	entriesInCurrentFile_ {}
long long	eventEntry_ {}
std::unique_ptr< TFile >	file_ {nullptr}
TTree *	eventsTree_ {nullptr}
TBranch *	eventAuxiliaryBranch_ {nullptr}
art::EventAuxiliary	eventAuxiliary_ {}
art::EventAuxiliary *	pEventAuxiliary_ {&eventAuxiliary_}
long long	previousEventAuxiliaryEntry_ {-1}
TTree *	eventHistoryTree_ {nullptr}
TBranch *	eventHistoryBranch_ {nullptr}
art::History	eventHistory_ {}
art::History *	pEventHistory_ {&eventHistory_}
long long	previousEventHistoryEntry_ {-1}
art::ProcessHistoryMap	historyMap_ {}

Detailed Description

Definition at line 26 of file EventNavigator.h.

Constructor & Destructor Documentation

gallery::EventNavigator::EventNavigator ( std::vector< std::string > const &  iFileNames )

explicit

Definition at line 15 of file EventNavigator.cc.

    : fileNames_{iFileNames}, numberOfFiles_(fileNames_.size())
  {
    if (fileNames_.empty()) {
      fileEntry_ = 0;
    } else {
      while (eventEntry_ == entriesInCurrentFile_ &&
             fileEntry_ != numberOfFiles_) {
        nextFile();
      }
      firstFileWithEvent_ = fileEntry_;
    }
    if (isValid()) {
      eventsTree_->LoadTree(eventEntry_);
    }
  }

Member Function Documentation

bool gallery::EventNavigator::atEnd ( ) const

inline

Definition at line 43 of file EventNavigator.h.

    {
      return fileEntry_ == numberOfFiles_;
    }

long long gallery::EventNavigator::entriesInCurrentFile ( ) const

inline

Definition at line 73 of file EventNavigator.h.

    {
      return entriesInCurrentFile_;
    }

art::EventAuxiliary const & gallery::EventNavigator::eventAuxiliary

(

)

const

Definition at line 136 of file EventNavigator.cc.

  {
    if (previousEventAuxiliaryEntry_ != eventEntry_) {
      eventAuxiliaryBranch_->GetEntry(eventEntry_);
      previousEventAuxiliaryEntry_ = eventEntry_;
    }
    return eventAuxiliary_;
  }

TBranch* gallery::EventNavigator::eventAuxiliaryBranch ( ) const

inline

Definition at line 62 of file EventNavigator.h.

    {
      return eventAuxiliaryBranch_;
    }

long long gallery::EventNavigator::eventEntry ( ) const

inline

Definition at line 78 of file EventNavigator.h.

    {
      return eventEntry_;
    }

long long gallery::EventNavigator::fileEntry ( ) const

inline

Definition at line 68 of file EventNavigator.h.

    {
      return fileEntry_;
    }

TFile * gallery::EventNavigator::getTFile

(

)

const

Definition at line 193 of file EventNavigator.cc.

  {
    return file_.get();
  }

TTree * gallery::EventNavigator::getTTree

(

)

const

Definition at line 199 of file EventNavigator.cc.

  {
    return eventsTree_;
  }

void gallery::EventNavigator::goToEntry

(

long long

entry

)

Definition at line 81 of file EventNavigator.cc.

  {
    eventEntry_ = entry;
    if (isValid()) {
      eventsTree_->LoadTree(eventEntry_);
    }
  }

art::History const & gallery::EventNavigator::history

(

)

const

Definition at line 146 of file EventNavigator.cc.

  {
    if (previousEventHistoryEntry_ != eventEntry_) {
      eventHistoryBranch_->GetEntry(eventEntry_);
      previousEventHistoryEntry_ = eventEntry_;
    }
    return eventHistory_;
  }

void gallery::EventNavigator::initializeTBranchPointers ( )

private

Definition at line 224 of file EventNavigator.cc.

  {
    eventAuxiliaryBranch_ = eventsTree_->GetBranch(
      art::BranchTypeToAuxiliaryBranchName(art::InEvent).c_str());

    if (eventAuxiliaryBranch_ == nullptr) {
      throwBranchNotFound(art::BranchTypeToAuxiliaryBranchName(art::InEvent));
    }
    eventAuxiliaryBranch_->SetAddress(&pEventAuxiliary_);

    eventHistoryBranch_ = eventHistoryTree_->GetBranch(
      art::rootNames::eventHistoryBranchName().c_str());

    if (eventHistoryBranch_ == nullptr) {
      throwBranchNotFound(art::rootNames::eventHistoryBranchName());
    }
    eventHistoryBranch_->SetAddress(&pEventHistory_);
  }

void gallery::EventNavigator::initializeTTreePointers ( )

private

Definition at line 205 of file EventNavigator.cc.

  {
    eventsTree_ = file_->Get<TTree>(art::rootNames::eventTreeName().c_str());
    if (eventsTree_ == nullptr) {
      throwTreeNotFound(art::rootNames::eventTreeName());
    }
    if (eventsTree_->GetEntries() < 0) {
      throw art::Exception(art::errors::LogicError)
        << "Unable to get the number of entries in events TTree.\n"
           "This might be a corrupted file.\n";
    }
    eventHistoryTree_ =
      file_->Get<TTree>(art::rootNames::eventHistoryTreeName().c_str());
    if (eventHistoryTree_ == nullptr) {
      throwTreeNotFound(art::rootNames::eventHistoryTreeName());
    }
  }

bool gallery::EventNavigator::isValid ( ) const

inline

Definition at line 36 of file EventNavigator.h.

    {
      return fileEntry_ != numberOfFiles_ &&
             eventEntry_ != entriesInCurrentFile_;
    }

void gallery::EventNavigator::next

(

)

Definition at line 47 of file EventNavigator.cc.

  {
    if (eventEntry_ != entriesInCurrentFile_) {
      // normal case, go to next event in same file
      ++eventEntry_;
    } else {
      // handle odd cases, calling next when already at the end
      // or after a call to nextFile() left us on a file with
      // no events. (Neither of these cases should occur in a
      // normal loop over events)
      nextFile();
    }
    // if we hit the end of the file go to the next file
    // also skip empty files
    while (eventEntry_ == entriesInCurrentFile_ &&
           fileEntry_ != numberOfFiles_) {
      nextFile();
    }
    if (isValid()) {
      eventsTree_->LoadTree(eventEntry_);
    }
  }

void gallery::EventNavigator::nextFile

(

)

Definition at line 90 of file EventNavigator.cc.

  {
    // Be careful with this function. If the next file is empty this
    // will leave it not pointing at a valid event.
    if (atEnd()) {
      throw art::Exception{art::errors::LogicError}
        << "Illegal call to EventNavigator::nextFile() when atEnd() is true";
    }

    if (file_) {
      std::cout << "Closing file, read " << file_->GetBytesRead()
                << " bytes in " << file_->GetReadCalls() << " transactions\n";
    }

    ++fileEntry_;
    if (atEnd()) {
      entriesInCurrentFile_ = 0;
      eventEntry_ = 0;
      file_ = nullptr;
      eventsTree_ = nullptr;
      eventAuxiliaryBranch_ = nullptr;
      eventHistoryTree_ = nullptr;
      eventHistoryBranch_ = nullptr;
      previousEventAuxiliaryEntry_ = -1;
      previousEventHistoryEntry_ = -1;
      historyMap_.clear();
      return;
    }
    file_.reset(TFile::Open(fileNames_[fileEntry_].c_str()));
    if (!file_ || file_->IsZombie()) {
      throw art::Exception(art::errors::FileOpenError)
        << "Failed opening file \'" << fileNames_[fileEntry_] << "\'";
    }
    std::cout << "Successfully opened file " << fileNames_[fileEntry_]
              << std::endl;
    initializeTTreePointers();
    initializeTBranchPointers();
    entriesInCurrentFile_ = eventsTree_->GetEntries();
    eventEntry_ = 0;
    previousEventAuxiliaryEntry_ = -1;
    previousEventHistoryEntry_ = -1;
    historyMap_.clear();
    return;
  }

void gallery::EventNavigator::previous

(

)

Definition at line 71 of file EventNavigator.cc.

  {
    // We will never get here is we're dealing with more than one file.
    --eventEntry_;
    if (isValid()) {
      eventsTree_->LoadTree(eventEntry_);
    }
  }

art::ProcessHistory const & gallery::EventNavigator::processHistory

(

)

const

Definition at line 166 of file EventNavigator.cc.

  {

    if (historyMap_.empty()) {

      std::unique_ptr<TTree> metaDataTree{
        file_->Get<TTree>(art::rootNames::metaDataTreeName().c_str())};

      if (!metaDataTree) {
        throwTreeNotFound(art::rootNames::metaDataTreeName());
      }

      auto pHistMapPtr = &historyMap_;
      TBranch* processHistoryBranch = metaDataTree->GetBranch(
        art::rootNames::metaBranchRootName<art::ProcessHistoryMap>());

      if (!processHistoryBranch) {
        throwBranchNotFound(
          art::rootNames::metaBranchRootName<art::ProcessHistoryMap>());
      }
      processHistoryBranch->SetAddress(&pHistMapPtr);
      processHistoryBranch->GetEntry(0);
    }
    return historyMap_[processHistoryID()];
  }

art::ProcessHistoryID const & gallery::EventNavigator::processHistoryID

(

)

const

Definition at line 156 of file EventNavigator.cc.

  {
    if (previousEventHistoryEntry_ != eventEntry_) {
      eventHistoryBranch_->GetEntry(eventEntry_);
      previousEventHistoryEntry_ = eventEntry_;
    }
    return eventHistory_.processHistoryID();
  }

void gallery::EventNavigator::toBegin

(

)

Definition at line 33 of file EventNavigator.cc.

  {
    if (fileEntry_ == firstFileWithEvent_) {
      eventEntry_ = 0;
      return;
    }
    fileEntry_ = firstFileWithEvent_ - 1;
    nextFile();
    if (isValid()) {
      eventsTree_->LoadTree(eventEntry_);
    }
  }

Member Data Documentation

long long gallery::EventNavigator::entriesInCurrentFile_ {}

private

Definition at line 92 of file EventNavigator.h.

art::EventAuxiliary gallery::EventNavigator::eventAuxiliary_ {}

mutableprivate

Definition at line 99 of file EventNavigator.h.

TBranch* gallery::EventNavigator::eventAuxiliaryBranch_ {nullptr}

private

Definition at line 98 of file EventNavigator.h.

long long gallery::EventNavigator::eventEntry_ {}

private

Definition at line 93 of file EventNavigator.h.

art::History gallery::EventNavigator::eventHistory_ {}

mutableprivate

Definition at line 105 of file EventNavigator.h.

TBranch* gallery::EventNavigator::eventHistoryBranch_ {nullptr}

private

Definition at line 104 of file EventNavigator.h.

TTree* gallery::EventNavigator::eventHistoryTree_ {nullptr}

private

Definition at line 103 of file EventNavigator.h.

TTree* gallery::EventNavigator::eventsTree_ {nullptr}

private

Definition at line 97 of file EventNavigator.h.

std::unique_ptr<TFile> gallery::EventNavigator::file_ {nullptr}

private

Definition at line 95 of file EventNavigator.h.

long long gallery::EventNavigator::fileEntry_ {-1}

private

Definition at line 89 of file EventNavigator.h.

std::vector<std::string> gallery::EventNavigator::fileNames_

private

Definition at line 87 of file EventNavigator.h.

long long gallery::EventNavigator::firstFileWithEvent_ {}

private

Definition at line 90 of file EventNavigator.h.

art::ProcessHistoryMap gallery::EventNavigator::historyMap_ {}

mutableprivate

Definition at line 109 of file EventNavigator.h.

long long gallery::EventNavigator::numberOfFiles_

private

Definition at line 88 of file EventNavigator.h.

art::EventAuxiliary* gallery::EventNavigator::pEventAuxiliary_ {&eventAuxiliary_}

private

Definition at line 100 of file EventNavigator.h.

art::History* gallery::EventNavigator::pEventHistory_ {&eventHistory_}

private

Definition at line 106 of file EventNavigator.h.

long long gallery::EventNavigator::previousEventAuxiliaryEntry_ {-1}

mutableprivate

Definition at line 101 of file EventNavigator.h.

long long gallery::EventNavigator::previousEventHistoryEntry_ {-1}

mutableprivate

Definition at line 107 of file EventNavigator.h.

---

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

• gallery/gallery/EventNavigator.h
• gallery/gallery/EventNavigator.cc