RbTupleManager Class Reference

Class to manage histograms defined in registered modules. More...

#include <RbTuple.h>

Collaboration diagram for RbTupleManager:

Public Member Functions
	RbTupleManager (int nprocess, const char *filename, const char *workdir=".")
	Constructor to use hadd()
void	init (int nprocess, const char *filename, const char *workdir=".")
	Global initialization.
void	register_module (Module *)
	Functions called by analysis modules in mother process.
int	begin (int pid)
	Function called by HistoManager module for the first event.
int	terminate ()
	Function called by HistoManager module at the end.
int	dump ()
	Function to dump histograms/tuples to the file.
int	hadd (bool deleteflag=true)
	Functions to add up all histogram files.
const std::vector< Module * > &	getHistDefiningModules () const
	Return the list of modules that have defined histograms.

Static Public Member Functions
static RbTupleManager &	Instance ()
	Access to singleton.

Private Attributes
std::vector< Module * >	m_histdefs
	registered HistoModules.
int	m_nproc {0}
	Number of parallel processes.
std::string	m_filename
	Name of histogram output file.
std::string	m_workdir
	Name of working directory.
TFile *	m_root {nullptr}
	Histogram output file.

Static Private Attributes
static RbTupleManager *	s_instance = nullptr
	singleton instance.

Detailed Description

Class to manage histograms defined in registered modules.

Definition at line 29 of file RbTuple.h.

Constructor & Destructor Documentation

RbTupleManager()

RbTupleManager	(	int	nprocess,
		const char *	filename,
		const char *	workdir = "."
	)

Constructor to use hadd()

Definition at line 34 of file RbTuple.cc.

                                                                              :
  m_nproc(nproc), m_filename(file), m_workdir(workdir)
{
}

Member Function Documentation

begin()

int begin

(

int

pid

)

Function called by HistoManager module for the first event.

Definition at line 89 of file RbTuple.cc.

{
  if (m_nproc > 0) {
    std::string fileNamePlusId = m_workdir + "/" +
                                 m_filename + '.' + std::to_string(procid);
    m_root = new TFile(fileNamePlusId.c_str(), "update");
    //    printf("RbTupleManager: histo file opened for process %d (pid=%d)\n",
    //           procid, getpid());
    B2INFO("RbTupleManager: histogram file opened."
           << LogVar("process", procid)
           << LogVar("pid", getpid()));
  } else {
    m_root = new TFile(m_filename.c_str(), "recreate");
    //    printf("RbTupleManager: initialized for single-process\n");
    B2INFO("RbTupleManager: initialized for single process.");
  }
  if (m_root == nullptr) return -1;
  //  printf ( "RbTupleManager::TFile opened\n" );
 
  for (auto& mod : m_histdefs) {
    auto* hmod = (HistoModule*) mod;
    hmod->defineHisto();
  }
 
  //  printf ( "RbTupleManager::Histograms defined in proc %d\n", procid );
 
  return 0;
}

dump()

int dump

(

)

Function to dump histograms/tuples to the file.

Definition at line 129 of file RbTuple.cc.

{
  if (m_root != nullptr) {
    m_root->Write();
  }
  return 0;
}

getHistDefiningModules()

const std::vector< Module * > & getHistDefiningModules ( ) const

inline

Return the list of modules that have defined histograms.

Definition at line 66 of file RbTuple.h.

    {
      return m_histdefs;
    }

hadd()

int hadd

(

bool

deleteflag = true

)

Functions to add up all histogram files.

Definition at line 138 of file RbTuple.cc.

{
  // No need to call this function when nprocess=0
  if (m_nproc == 0) {
    //    if ( m_root != NULL ) terminate();
    return 0;
  }
 
  B2INFO("RbTupleManager: hadd started.");
 
  // Set up merger with output file
  TFileMerger merger(false, false);
  if (!merger.OutputFile(m_filename.c_str())) {
    B2ERROR("RbTupleManager: error on opening the output file."
            << LogVar("file name", m_filename));
    return -1;
  }
 
  // Open current directory
  //  std::string dir = ".";
  std::string dir = m_workdir;
  DIR* dp;
  struct dirent* dirp;
  if ((dp = opendir(dir.c_str())) == nullptr) {
    B2ERROR("RbTubleManager: error on opening the directory."
            << LogVar("directory", dir));
    return errno;
  }
 
  std::vector<std::string> filenames;
  // Scan the directory and register all histogram files
  //  std::string compfile = dir + "/" + m_filename + ".";
  std::string compfile = m_filename + ".";
  B2INFO(LogVar("compfile", compfile));
  while ((dirp = readdir(dp)) != nullptr) {
    std::string curfile = std::string(dirp->d_name);
    //    printf("Checking %s with compfile%s\n", curfile.c_str(), compfile.c_str());
    if (curfile.compare(0, compfile.size(), compfile) == 0) {
      printf("RbTupleManager:: adding  file =%s\n", curfile.c_str());
      merger.AddFile((m_workdir + "/" + curfile).c_str());
      filenames.push_back(m_workdir + "/" + curfile);
    }
  }
  closedir(dp);
 
  // Do Merge
  if (!merger.Merge()) {
    //    printf ( "RbTupleManager:: error to merge files\n" );
    B2ERROR("RbTupleManager: error on merging files.");
    return -1;
  }
 
  if (deleteflag) {
    // Delete temporary files
    vector<string>::iterator it;
    for (it = filenames.begin(); it != filenames.end(); ++it) {
      string& hfile = *it;
      unlink(hfile.c_str());
    }
  }
 
  B2INFO("RbTupleManager: histogram files are added.");
 
  return 0;
}

init()

void init	(	int	nprocess,
		const char *	filename,
		const char *	workdir = "."
	)

Global initialization.

Definition at line 49 of file RbTuple.cc.

{
  m_filename = filename;
  m_nproc = nprocess;
  m_workdir = workdir;
 
  if (ProcHandler::EvtProcID() == -1 && m_nproc > 0) {
 
    // should be called only from main
    // Open current directory
    std::string dir = m_workdir;
    DIR* dp;
    struct dirent* dirp;
    if ((dp = opendir(dir.c_str())) == nullptr) {
      B2ERROR("Error on opening the directory."
              << LogVar("directory", dir));
      return;
    }
 
    // Scan the directory and delete temporary files
    std::string compfile = m_filename + ".";
    while ((dirp = readdir(dp)) != nullptr) {
      std::string curfile = std::string(dirp->d_name);
      if (curfile.compare(0, compfile.size(), compfile) == 0) {
        //        unlink(curfile.c_str());
        unlink((m_workdir + "/" + curfile).c_str());
      }
    }
    closedir(dp);
    B2INFO("RbTupleManager: old temporary histogram files deleted.");
  }
}

Instance()

RbTupleManager & Instance ( )

static

Access to singleton.

Definition at line 40 of file RbTuple.cc.

{
  if (!s_instance) {
    s_instance = new RbTupleManager;
  }
  return *s_instance;
}

register_module()

void register_module

(

Module *

mod

)

Functions called by analysis modules in mother process.

Definition at line 83 of file RbTuple.cc.

{
  m_histdefs.push_back(mod);
}

terminate()

int terminate

(

)

Function called by HistoManager module at the end.

Definition at line 118 of file RbTuple.cc.

{
  if (m_root != nullptr) {
    m_root->Write();
    m_root->Close();
    delete m_root;
    m_root = nullptr;
  }
  return 0;
}

Member Data Documentation

m_filename

std::string m_filename

private

Name of histogram output file.

Definition at line 76 of file RbTuple.h.

m_histdefs

std::vector<Module*> m_histdefs

private

registered HistoModules.

Definition at line 74 of file RbTuple.h.

m_nproc

int m_nproc {0}

private

Number of parallel processes.

Definition at line 75 of file RbTuple.h.

m_root

TFile* m_root {nullptr}

private

Histogram output file.

Definition at line 78 of file RbTuple.h.

m_workdir

std::string m_workdir

private

Name of working directory.

Definition at line 77 of file RbTuple.h.

s_instance

RbTupleManager * s_instance = nullptr

staticprivate

singleton instance.

Definition at line 72 of file RbTuple.h.

---

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

• framework/pcore/include/RbTuple.h
• framework/pcore/src/RbTuple.cc