core::PostProcessorBase Class Reference

A generic tree-reading event-by-event processor. More...

#include <PostProcessorBase.hh>

Inheritance diagram for core::PostProcessorBase:

Public Member Functions
	PostProcessorBase ()
virtual	~PostProcessorBase ()
void	Run (std::vector< std::string > filelist)
void	Initialize (char *config=NULL, const std::string &output_fname="", unsigned n_workers=1)

Protected Member Functions
virtual void	ProcessEvent (const event::Event *event)=0
virtual void	ProcessSubRun (const SubRun *subrun)
virtual void	ProcessFileMeta (const FileMeta *filemeta)
virtual void	FileSetup (TFile *f, TTree *eventTree)
virtual void	FileCleanup (TTree *eventTree)
virtual void	Initialize (fhicl::ParameterSet *config=NULL)=0
virtual void	InitializeThread ()
virtual void	Finalize ()
unsigned	NWorkers ()
unsigned	WorkerID ()

Protected Attributes
ProviderManager *	fProviderManager
	Interface for provider access. More...
int	fConfigExperimentID

Private Member Functions
void	ProcessFile (const std::string &fname)

Private Attributes
unsigned	fNWorkers
std::vector< std::thread::id >	fThreadIDs

Detailed Description

A generic tree-reading event-by-event processor.

Definition at line 43 of file PostProcessorBase.hh.

Constructor & Destructor Documentation

core::PostProcessorBase::PostProcessorBase

(

)

Constructor

Definition at line 23 of file PostProcessorBase.cxx.

: fProviderManager(NULL), fConfigExperimentID(-1), fNWorkers(1) {}

core::PostProcessorBase::~PostProcessorBase ( )

virtual

Destructor

Definition at line 26 of file PostProcessorBase.cxx.

{}

Member Function Documentation

virtual void core::PostProcessorBase::FileCleanup ( TTree *  eventTree )

inlineprotectedvirtual

Any cleanup needed per file

Parameters

eventTree

the TTree associated with the sbncode event.

Reimplemented in ana::SBNOsc::Selection, ana::SBNOsc::Covariance, and ana::SBNOsc::Chi2Sensitivity.

Definition at line 95 of file PostProcessorBase.hh.

{}

virtual void core::PostProcessorBase::FileSetup ( TFile *  f, TTree *  eventTree  )

inlineprotectedvirtual

Setup anything needed per file

Parameters

f	the TFile being opened
eventTree	the TTree associated with the sbncode event. Use this TTree to set branch addresses for everything other than the sbncode event.

Files are guaranteed to be processed in the order they are specified on the command line for sbn-postprocess

Reimplemented in ana::SBNOsc::Selection, and ana::SBNOsc::Flatten.

Definition at line 88 of file PostProcessorBase.hh.

{}

virtual void core::PostProcessorBase::Finalize ( )

inlineprotectedvirtual

Perform user-level finalization. Called after all events have been processed.

Reimplemented in ana::SBNOsc::Selection, ana::SBNOsc::Covariance, ana::SBNOsc::Flatten, and ana::SBNOsc::Chi2Sensitivity.

Definition at line 112 of file PostProcessorBase.hh.

{}

void core::PostProcessorBase::Initialize	(	char *	config = NULL,
		const std::string &	output_fname = "",
		unsigned	n_workers = 1
	)

Perform user-level initialization.

Parameters

config

A configuration, as a JSON filename.

Definition at line 29 of file PostProcessorBase.cxx.

                                                                                                  {
  fhicl::ParameterSet* cfg = LoadConfig(config);
  if (cfg == NULL) cfg = new fhicl::ParameterSet;
  if (output_fname.size() != 0) cfg->put("OutputFile", output_fname);
  fConfigExperimentID = cfg->get("ExperimentID", -1);

  if (fConfigExperimentID >= 0) {
    fProviderManager = new ProviderManager((Experiment)fConfigExperimentID, "", false); 
  }

  fNWorkers = n_workers;

  Initialize(cfg);
}

virtual void core::PostProcessorBase::Initialize ( fhicl::ParameterSet *  config = NULL )

protectedpure virtual

Perform user-level initialization.

Parameters

config

A configuration, as a JSON object.

Implemented in ana::SBNOsc::Selection, ana::SBNOsc::Covariance, ana::SBNOsc::Flatten, and ana::SBNOsc::Chi2Sensitivity.

virtual void core::PostProcessorBase::InitializeThread ( )

inlineprotectedvirtual

Perform user-level initialization per-thread. Only called when multiple workers are specified on the command line.

Reimplemented in ana::SBNOsc::Flatten.

Definition at line 109 of file PostProcessorBase.hh.

{}

unsigned core::PostProcessorBase::NWorkers ( )

inlineprotected

Definition at line 117 of file PostProcessorBase.hh.

{ return fNWorkers; }

virtual void core::PostProcessorBase::ProcessEvent ( const event::Event *  event )

protectedpure virtual

Process one event.

Parameters

event

The sbncode event for the current event

Implemented in ana::SBNOsc::Selection, ana::SBNOsc::Covariance, ana::SBNOsc::Flatten, and ana::SBNOsc::Chi2Sensitivity.

void core::PostProcessorBase::ProcessFile ( const std::string &  fname )

private

Definition at line 44 of file PostProcessorBase.cxx.

                                                          {
  // get ROOT file
  TFile f(fname.c_str());
  if (f.IsZombie()) {
    std::cerr << "Failed openning file: " << fname << ". "
              << "Cleaning up and exiting." << std::endl;
    return;
  }

  TTree *event_tree = 0;
  event::Event *event = 0;

  TTree *subrun_tree = 0;
  SubRun *subrun = 0;
  
  TTree *filemeta_tree = 0;
  FileMeta *filemeta = 0;

  f.GetObject("sbnana", event_tree);
  event_tree->SetBranchAddress("events", &event);
  FileSetup(&f, event_tree);
  // process all events
  for (int event_ind = 0; event_ind < event_tree->GetEntries(); event_ind++) {
    event_tree->GetEntry(event_ind);
    ProcessEvent(event);
  }
  // process all subruns
  f.GetObject("sbnsubrun", subrun_tree);
  if (subrun_tree == NULL) {
    std::cerr << "Error: NULL subrun tree" << std::endl;
  }
  subrun_tree->SetBranchAddress("subruns", &subrun);

  for (int subrun_ind = 0; subrun_ind < subrun_tree->GetEntries(); subrun_ind++) {
    subrun_tree->GetEntry(subrun_ind);
    ProcessSubRun(subrun);
  }

  // process all the file meta-data
  f.GetObject("sbnfilemeta", filemeta_tree);
  if (filemeta_tree == NULL) {
    std::cerr << "Error: NULL filemeta tree" << std::endl;
  }
  filemeta_tree->SetBranchAddress("filemeta", &filemeta);
  for (int filemeta_ind = 0; filemeta_ind < filemeta_tree->GetEntries(); filemeta_ind++) {
    filemeta_tree->GetEntry(filemeta_ind);
    ProcessFileMeta(filemeta);
  } 

  FileCleanup(event_tree);
}

virtual void core::PostProcessorBase::ProcessFileMeta ( const FileMeta *  filemeta )

inlineprotectedvirtual

Reimplemented in ana::SBNOsc::Selection, and ana::SBNOsc::Flatten.

Definition at line 75 of file PostProcessorBase.hh.

{}

virtual void core::PostProcessorBase::ProcessSubRun ( const SubRun *  subrun )

inlineprotectedvirtual

Reimplemented in ana::SBNOsc::Selection, ana::SBNOsc::Covariance, ana::SBNOsc::Flatten, and ana::SBNOsc::Chi2Sensitivity.

Definition at line 73 of file PostProcessorBase.hh.

{}

void core::PostProcessorBase::Run

(

std::vector< std::string >

filelist

)

Run

Parameters

filelist

The list of files to be processed by this PostProcessor

Definition at line 104 of file PostProcessorBase.cxx.

                                                           {
  // single threaded
  if (fNWorkers == 1) {
    fThreadIDs.push_back(std::this_thread::get_id());
    for (auto const& fname: inputFiles) {
      ProcessFile(fname);
    } 
  }
  // multi-threaded
  else {
    fThreadIDs = std::vector<std::thread::id>(fNWorkers);
    std::atomic<unsigned> f_index = 0;
    std::atomic<unsigned> w_index = 0;
    std::vector<std::thread> workers;
    for (unsigned i = 0; i < fNWorkers; i++) {
      workers.emplace_back([&]() {
        // setup the mapping to thread indices
        unsigned this_index = w_index.fetch_add(1);
        fThreadIDs[this_index] = std::this_thread::get_id();
        InitializeThread();
        // start fetching files
        unsigned file_index = f_index.fetch_add(1);
        while (file_index < inputFiles.size()) {
          ProcessFile(inputFiles[file_index]);
          file_index = f_index.fetch_add(1);
        } 
      });
    }
    for (std::thread &w: workers) w.join();
  }

  if (fProviderManager != NULL) {
    delete fProviderManager;
    fProviderManager = NULL;
  }

  // teardown
  Finalize();
}

unsigned core::PostProcessorBase::WorkerID ( )

protected

Definition at line 96 of file PostProcessorBase.cxx.

                                     {
  std::thread::id this_id = std::this_thread::get_id();
  for (unsigned index = 0; index < fThreadIDs.size(); index++) {
    if (this_id == fThreadIDs[index]) return index;
  }
  assert(false);
}

Member Data Documentation

int core::PostProcessorBase::fConfigExperimentID

protected

Definition at line 115 of file PostProcessorBase.hh.

unsigned core::PostProcessorBase::fNWorkers

private

Definition at line 123 of file PostProcessorBase.hh.

ProviderManager* core::PostProcessorBase::fProviderManager

protected

Interface for provider access.

Definition at line 114 of file PostProcessorBase.hh.

std::vector<std::thread::id> core::PostProcessorBase::fThreadIDs

private

Definition at line 124 of file PostProcessorBase.hh.

---

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

• PostProcessorBase.hh
• PostProcessorBase.cxx