QwRootFile Class Reference

A wrapper class for a ROOT file or memory mapped file. More...

#include <QwRootFile.h>

Public Member Functions
	QwRootFile (const TString &run_label)
	Constructor with run label. More...
virtual	~QwRootFile ()
	Destructor. More...
void	ProcessOptions (QwOptions &options)
	Process the configuration options. More...
Bool_t	IsRootFile () const
	Is the ROOT file active? More...
Bool_t	IsMapFile () const
	Is the map file active? More...
void	ConstructIndices (const std::string &from, const std::string &to, bool reverse=true)
	Construct indices from one tree to another tree. More...
template<class T >
void	ConstructTreeBranches (const std::string &name, const std::string &desc, T &object, const std::string &prefix="")
	Construct the tree branches of a generic object. More...
template<class T >
void	FillTreeBranches (const std::string &name, const T &object)
	Fill the tree branches of a generic object by tree name. More...
template<class T >
void	FillTreeBranches (const T &object)
	Fill the tree branches of a generic object by type only. More...
template<class T >
Int_t	WriteParamFileList (const TString &name, T &object)
template<class T >
void	ConstructHistograms (const std::string &name, T &object)
	Construct the histograms of a generic object. More...
template<class T >
void	FillHistograms (T &object)
	Fill histograms of the subsystem array. More...
void	NewTree (const std::string &name, const std::string &desc)
	Create a new tree with name and description. More...
TTree *	GetTree (const std::string &name)
	Get the tree with name. More...
Int_t	FillTree (const std::string &name)
	Fill the tree with name. More...
Int_t	FillTrees ()
	Fill all registered trees. More...
void	PrintTrees () const
	Print registered trees. More...
void	PrintDirs () const
	Print registered histogram directories. More...
template<class T >
Int_t	WriteObject (const T *obj, const char *name, Option_t *option="", Int_t bufsize=0)
	Write any object to the ROOT file (only valid for TFile) More...
void	Update ()
void	Print ()
void	ls ()
void	Map ()
void	Close ()
Bool_t	cd (const char *path=0)
TDirectory *	mkdir (const char *name, const char *title="")
Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)

Static Public Member Functions
static void	DefineOptions (QwOptions &options)
	Define the configuration options. More...
static void	SetDefaultRootFileStem (const std::string &stem)
	Set default ROOT file stem. More...

Private Member Functions
	QwRootFile ()
	Private default constructor. More...
Bool_t	HasAnyFilled (void)
	Search for non-empty trees or histograms in the file. More...
Bool_t	HasAnyFilled (TDirectory *d)
void	DisableTree (const TString &regexp)
	Add regexp to list of disabled trees names. More...
bool	IsTreeDisabled (const std::string &name)
	Does this tree name match a disabled tree name? More...
void	DisableHisto (const TString &regexp)
	Add regexp to list of disabled histogram directories. More...
bool	IsHistoDisabled (const std::string &name)
	Does this histogram directory match a disabled histogram directory? More...
bool	HasTreeByName (const std::string &name)
	Is a tree registered for this name. More...
template<class T >
bool	HasTreeByType (const T &object)
	Is a tree registered for this type. More...
template<class T >
bool	HasTreeByAddr (const T &object)
	Is a tree registered for this object. More...
bool	HasDirByName (const std::string &name)
	Is a tree registered for this name. More...
template<class T >
bool	HasDirByType (const T &object)
	Is a directory registered for this type. More...

Private Attributes
TFile *	fRootFile
	ROOT file. More...
TString	fRootFileStem
	ROOT file stem. More...
TString	fPermanentName
Bool_t	fMakePermanent
TMapFile *	fMapFile
	Map file. More...
Bool_t	fEnableMapFile
Int_t	fUpdateInterval
Int_t	fCompressionLevel
Int_t	fBasketSize
Int_t	fAutoFlush
Int_t	fAutoSave
std::vector< TPRegexp >	fDisabledTrees
	List of excluded trees. More...
std::vector< TPRegexp >	fDisabledHistos
std::map< const std::string, std::vector< QwRootTree * > >	fTreeByName
	Tree names, addresses, and types. More...
std::map< const void *, std::vector< QwRootTree * > >	fTreeByAddr
std::map< const type_info *, std::vector< QwRootTree * > >	fTreeByType
std::map< const std::string, TDirectory * >	fDirsByName
	Directories. More...
std::map< const std::string, std::vector< std::string > >	fDirsByType
UInt_t	fNumMpsEventsToSkip
	Prescaling of events written to tree. More...
UInt_t	fNumMpsEventsToSave
UInt_t	fNumHelEventsToSkip
UInt_t	fNumHelEventsToSave
UInt_t	fCircularBufferSize
UInt_t	fCurrentEvent

Static Private Attributes
static std::string	fDefaultRootFileStem = "Qweak_"
	Default ROOT file stem. More...
static const Long64_t	kMaxTreeSize = 100000000000LL
	Maximum tree size. More...
static const Int_t	kMaxMapFileSize = 0x10000000

Detailed Description

A wrapper class for a ROOT file or memory mapped file.

This class functions as a wrapper around a ROOT TFile or a TMapFile. The common inheritance of both is only TObject, so there is a lot that we have to wrap (rather than inherit). Theoretically you could have both a TFile and a TMapFile represented by an object of this class at the same time, but that is untested.

The functionality of writing to the file is done by templated functions. The objects that are passed to these functions have to provide the following functions:

• ConstructHistograms, FillHistograms
• ConstructBranchAndVector, FillTreeVector

The class keeps track of the registered tree names, and the types of objects that have branches constructed in those trees (via QwRootTree). In most cases it should be possible to just call FillTreeBranches with only the object, although in rare cases this could be ambiguous.

The proper way to register a tree is by either calling ConstructTreeBranches of NewTree first. Then FillTreeBranches will fill the vector, and FillTree will actually fill the tree. FillTree should be called only once.

Definition at line 281 of file QwRootFile.h.

Constructor & Destructor Documentation

QwRootFile::QwRootFile

(

const TString &

run_label

)

Constructor with run label.

Constructor with relative filename

Definition at line 17 of file QwRootFile.cc.

References QwLog::endl(), fCompressionLevel, fEnableMapFile, fMapFile, fPermanentName, fRootFile, fRootFileStem, QwOptions::GetArgc(), QwOptions::GetArgv(), getenv_safe_TString(), gQwOptions, kMaxMapFileSize, ProcessOptions(), QwError, QwMessage, and WriteObject().

  : fRootFile(0), fMakePermanent(0),
    fMapFile(0), fEnableMapFile(kFALSE),
    fUpdateInterval(400)
{
  // Process the configuration options
  ProcessOptions(gQwOptions);
  
  // Check for the memory-mapped file flag
  if (fEnableMapFile) {
    
    TString mapfilename = "/dev/shm/";
    
    // if( host_name.Contains("cdaql4") and (not user_name.CompareTo("cdaq", TString::kExact)) ) {
    //   mapfilename = "/local/scratch/qweak/";
    // }
    // else {
    //   mapfilename = getenv_safe_TString("QW_ROOTFILES");
    // }

    mapfilename += "/QwMemMapFile.map";

    fMapFile = TMapFile::Create(mapfilename,"RECREATE", kMaxMapFileSize, "RealTime Producer File");

    if (not fMapFile) {
      QwError << "Memory-mapped file " << mapfilename
              << " could not be opened!" << QwLog::endl;
      return;
    }

    QwMessage << "================== RealTime Producer Memory Map File =================" << QwLog::endl;
    fMapFile->Print();
    QwMessage << "======================================================================" << QwLog::endl;

  } else {

    //TString rootfilename = getenv_safe_TString("QW_ROOTFILES");
    TString hostname = gSystem -> HostName();
    TString rootfilename;
    TString localRootFileName = gSystem->Getenv("QW_ROOTFILES_LOCAL");

//     std::cout << "---------------------------------------------------------------------------------" << std::endl;
//     printf("\n\n\n\n\n\n");
//     printf("%s %s \n", hostname.Data(), localRootFileName.Data());
//     printf("\n\n\n\n\n\n");
//     std::cout << "---------------------------------------------------------------------------------" << std::endl;
//     //    if( localRootFileName.CompareTo("") == 0 ) {
    if (localRootFileName.IsNull()) {
        rootfilename = getenv_safe_TString("QW_ROOTFILES");
    } else {
        rootfilename = localRootFileName;
    }
//     std::cout << "---------------------------------------------------------------------------------" << std::endl;
//     printf("\n\n\n\n\n\n");
//     printf("%s %s \n", hostname.Data(), localRootFileName.Data());
//     printf("\n\n\n\n\n\n");
//     std::cout << "---------------------------------------------------------------------------------" << std::endl;


    // Use a probably-unique temporary file name.
    pid_t pid = getpid();

    fPermanentName = rootfilename
      + Form("/%s%s.root", fRootFileStem.Data(), run_label.Data());
    rootfilename += Form("/%s%s.%s.%d.root",
       fRootFileStem.Data(), run_label.Data(),
       hostname.Data(), pid);
    fRootFile = new TFile(rootfilename, "RECREATE", "QWeak ROOT file");
    if (! fRootFile) {
      QwError << "ROOT file " << rootfilename
              << " could not be opened!" << QwLog::endl;
      return;
    }

    TString run_condition_name = Form("%s_condition", run_label.Data());
    TList *run_cond_list = (TList*) fRootFile -> FindObjectAny(run_condition_name);
    if (not run_cond_list) {
      QwRunCondition run_condition(
          gQwOptions.GetArgc(),
          gQwOptions.GetArgv(),
          run_condition_name
      );

      fRootFile -> WriteObject(
          run_condition.Get(),
          run_condition.GetName()
      );
    }

    fRootFile->SetCompressionLevel(fCompressionLevel);
  }
}

Here is the call graph for this function:

QwRootFile::~QwRootFile ( )

virtual

Destructor.

Destructor

Definition at line 114 of file QwRootFile.cc.

References QwLog::endl(), fMakePermanent, fMapFile, fPermanentName, fRootFile, fTreeByName, HasAnyFilled(), QwMessage, and QwWarning.

{
  // Keep the file on disk if any trees or histograms have been filled.
  // Also respect any other requests to keep the file around.
  if (!fMakePermanent) fMakePermanent = HasAnyFilled();

  // Close the map file
  if (fMapFile) {
    fMapFile->Close();
    // TMapFiles may not be deleted
    fMapFile = 0;
  }

  // Close the ROOT file.
  // Rename if permanence is requested, remove otherwise
  if (fRootFile) {
    TString rootfilename = fRootFile->GetName();

    fRootFile->Close();
    delete fRootFile;
    fRootFile = 0;

    int err;
    const char* action;
    if (fMakePermanent) {
      action = " rename ";
      err = rename( rootfilename.Data(), fPermanentName.Data() );
    } else {
      action = " remove ";
      err = remove( rootfilename.Data() );
    }
    // It'd be proper to "extern int errno" and strerror() here,
    // but that doesn't seem very C++-ish.
    if (err) {
      QwWarning << "Couldn't" << action << rootfilename << QwLog::endl;
    } else {
      QwMessage << "Was able to" << action << rootfilename << QwLog::endl;
      QwMessage << "Root file is " << fPermanentName << QwLog::endl;
    }
  }

  // Delete Qweak ROOT trees
  std::map< const std::string, std::vector<QwRootTree*> >::iterator map_iter;
  std::vector<QwRootTree*>::iterator vec_iter;
  for (map_iter = fTreeByName.begin(); map_iter != fTreeByName.end(); map_iter++) {
    for (vec_iter = map_iter->second.begin(); vec_iter != map_iter->second.end(); vec_iter++) {
      delete *vec_iter;
    }
  }
}

Here is the call graph for this function:

QwRootFile::QwRootFile ( )

private

Private default constructor.

Member Function Documentation

Bool_t QwRootFile::cd ( const char *  path = 0 )

inline

Definition at line 422 of file QwRootFile.h.

References fMapFile, and fRootFile.

Referenced by ConstructTreeBranches(), and NewTree().

                                    {
      Bool_t status = kTRUE;
      if (fMapFile)  status &= fMapFile->cd(path);
      if (fRootFile) status &= fRootFile->cd(path);
      return status;
    }

Here is the caller graph for this function:

void QwRootFile::Close ( )

inline

Definition at line 416 of file QwRootFile.h.

References fMakePermanent, fMapFile, fRootFile, and HasAnyFilled().

Referenced by main().

                  {
      if (!fMakePermanent) fMakePermanent = HasAnyFilled();
      if (fMapFile) fMapFile->Close();  if (fRootFile) fRootFile->Close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

void QwRootFile::ConstructHistograms	(	const std::string &	name,
		T &	object
	)

Construct the histograms of a generic object.

Construct the histogram of a generic object

Parameters

name	Name for histogram directory
object	Subsystem array

Definition at line 706 of file QwRootFile.h.

References QwLog::endl(), fDirsByName, fDirsByType, fMapFile, fRootFile, IsHistoDisabled(), and QwMessage.

Referenced by main().

{
  // Return if we do not want this histogram information
  if (IsHistoDisabled(name)) return;

  // Create the histograms in a directory
  if (fRootFile) {
    std::string type = typeid(object).name();
    fDirsByName[name] = fRootFile->GetDirectory("/")->mkdir(name.c_str());
    fDirsByType[type].push_back(name);
    object.ConstructHistograms(fDirsByName[name]);
  }

  // No support for directories in a map file
  if (fMapFile) {
    QwMessage << "QwRootFile::ConstructHistograms::detectors address "
        << &object  
        << " and its name " << name 
        << QwLog::endl;
    
    std::string type = typeid(object).name();
    fDirsByName[name] = fMapFile->GetDirectory()->mkdir(name.c_str());
    fDirsByType[type].push_back(name);
    //object.ConstructHistograms(fDirsByName[name]);
    object.ConstructHistograms();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwRootFile::ConstructIndices ( const std::string &  from, const std::string &  to, bool  reverse = true  )

inline

Construct indices from one tree to another tree.

Construct the indices from one tree to another tree, and optionally in reverse as well.

Parameters

from	Name of tree where index will be created
to	Name of tree to which index will point
reverse	Flag to create indices in both direction

Definition at line 574 of file QwRootFile.h.

References fTreeByName, and IsTreeDisabled().

Referenced by main().

{
  // Return if we do not want this tree information
  if (IsTreeDisabled(from)) return;
  if (IsTreeDisabled(to)) return;

  // If the trees are defined
  if (fTreeByName.count(from) > 0 && fTreeByName.count(to) > 0) {

    // Construct index from the first tree to the second tree
    fTreeByName[from].front()->ConstructIndexTo(fTreeByName[to].front());

    // Construct index from the second tree back to the first tree
    if (reverse)
      fTreeByName[to].front()->ConstructIndexTo(fTreeByName[from].front());
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

void QwRootFile::ConstructTreeBranches	(	const std::string &	name,
		const std::string &	desc,
		T &	object,
		const std::string &	prefix = ""
	)

Construct the tree branches of a generic object.

Construct the tree branches of a generic object

Parameters

name	Name for tree
desc	Description for tree
object	Subsystem array
prefix	Prefix for the tree

Definition at line 600 of file QwRootFile.h.

References cd(), fAutoFlush, fAutoSave, fBasketSize, fCircularBufferSize, fEnableMapFile, fNumHelEventsToSave, fNumHelEventsToSkip, fNumMpsEventsToSave, fNumMpsEventsToSkip, fTreeByAddr, fTreeByName, fTreeByType, IsTreeDisabled(), kMaxTreeSize, QwRootTree::SetAutoFlush(), QwRootTree::SetAutoSave(), QwRootTree::SetBasketSize(), QwRootTree::SetCircular(), QwRootTree::SetMaxTreeSize(), and QwRootTree::SetPrescaling().

Referenced by main().

{
  // Return if we do not want this tree information
  if (IsTreeDisabled(name)) return;

  // Pointer to new tree
  QwRootTree* tree = 0;

  // If the tree does not exist yet, create it
  if (fTreeByName.count(name) == 0) {

    // Go to top level directory
    this->cd();

    // New tree with name, description, object, prefix
    tree = new QwRootTree(name, desc, object, prefix);

    // Settings only relevant for new trees
    if (name == "Mps_Tree")
      tree->SetPrescaling(fNumMpsEventsToSave, fNumMpsEventsToSkip);
    else if (name == "Hel_Tree")
      tree->SetPrescaling(fNumHelEventsToSave, fNumHelEventsToSkip);

    #if ROOT_VERSION_CODE >= ROOT_VERSION(5,26,00)
    tree->SetAutoFlush(fAutoFlush);
    #endif
    tree->SetAutoSave(fAutoSave);
    tree->SetBasketSize(fBasketSize);
    tree->SetMaxTreeSize(kMaxTreeSize);

    if (fEnableMapFile && fCircularBufferSize > 0)
      tree->SetCircular(fCircularBufferSize);

  } else {

    // New tree based on existing tree
    tree = new QwRootTree(fTreeByName[name].front(), object, prefix);
  }

   // Add the branches to the list of trees by name, object, type
  const void* addr = static_cast<const void*>(&object);
  const type_info* type = &typeid(object);
  fTreeByName[name].push_back(tree);
  fTreeByAddr[addr].push_back(tree);
  fTreeByType[type].push_back(tree);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwRootFile::DefineOptions ( QwOptions &  options )

static

Define the configuration options.

Defines configuration options using QwOptions functionality.

Parameters

options

Options object

Definition at line 169 of file QwRootFile.cc.

References QwOptions::AddOptions(), default_bool_value, and fDefaultRootFileStem.

Referenced by QwOptions::DefineOptions().

{
  // Define the ROOT filename stem
  options.AddOptions("Default options")
    ("rootfile-stem", po::value<std::string>()->default_value(fDefaultRootFileStem),
     "stem of the output ROOT filename");

  // Define the memory map option
  options.AddOptions()
    ("enable-mapfile", po::value<bool>()->default_bool_value(false),
     "enable output to memory-mapped file");

  // Define the histogram and tree options
  options.AddOptions("ROOT output options")
    ("disable-trees", po::value<bool>()->default_bool_value(false),
     "disable output to all trees");
  options.AddOptions("ROOT output options")
    ("disable-histos", po::value<bool>()->default_bool_value(false),
     "disable output to all histograms");

  // Define the helicity window versus helicity pattern options
  options.AddOptions("ROOT output options")
    ("disable-mps-tree", po::value<bool>()->default_bool_value(false),
     "disable helicity window output");
  options.AddOptions("ROOT output options")
    ("disable-hel-tree", po::value<bool>()->default_bool_value(false),
     "disable helicity pattern output");
  options.AddOptions("ROOT output options")
    ("disable-burst-tree", po::value<bool>()->default_bool_value(false),
     "disable burst tree");
  options.AddOptions("ROOT output options")
    ("disable-slow-tree", po::value<bool>()->default_bool_value(false),
     "disable slow control tree");

  // Define the tree output prescaling options
  options.AddOptions("ROOT output options")
    ("num-mps-accepted-events", po::value<int>()->default_value(0),
     "number of accepted consecutive MPS events");
  options.AddOptions("ROOT output options")
    ("num-mps-discarded-events", po::value<int>()->default_value(0),
     "number of discarded consecutive MPS events");
  options.AddOptions("ROOT output options")
    ("num-hel-accepted-events", po::value<int>()->default_value(0),
     "number of accepted consecutive pattern events");
  options.AddOptions("ROOT output options")
    ("num-hel-discarded-events", po::value<int>()->default_value(0),
     "number of discarded consecutive pattern events");
  options.AddOptions("ROOT output options")
    ("mapfile-update-interval", po::value<int>()->default_value(400),
     "Events between a map file update");

  // Define the autoflush and autosave option (default values by ROOT)
  options.AddOptions("ROOT performance options")
    ("autoflush", po::value<int>()->default_value(0),
     "TTree autoflush");
  options.AddOptions("ROOT performance options")
    ("autosave", po::value<int>()->default_value(300000000),
     "TTree autosave");
  options.AddOptions("ROOT performance options")
    ("basket-size", po::value<int>()->default_value(16000),
     "TTree basket size");
  options.AddOptions("ROOT performance options")
    ("circular-buffer", po::value<int>()->default_value(0),
     "TTree circular buffer");
  options.AddOptions("ROOT performance options")
    ("compression-level", po::value<int>()->default_value(1),
     "TFile compression level");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwRootFile::DisableHisto ( const TString &  regexp )

inlineprivate

Add regexp to list of disabled histogram directories.

Definition at line 496 of file QwRootFile.h.

References fDisabledHistos.

Referenced by ProcessOptions().

                                             {
      fDisabledHistos.push_back(regexp);
    }

Here is the caller graph for this function:

void QwRootFile::DisableTree ( const TString &  regexp )

inlineprivate

Add regexp to list of disabled trees names.

Definition at line 486 of file QwRootFile.h.

References fDisabledTrees.

Referenced by ProcessOptions().

                                            {
      fDisabledTrees.push_back(regexp);
    }

Here is the caller graph for this function:

template<class T >

void QwRootFile::FillHistograms ( T &  object )

inline

Fill histograms of the subsystem array.

Definition at line 329 of file QwRootFile.h.

References fUpdateInterval, HasDirByType(), and Update().

Referenced by main().

                                   {
      // Update regularly
      static Int_t update_count = 0;
      update_count++;
      if (update_count % fUpdateInterval == 0) Update();
      if (! HasDirByType(object)) return;
      // Fill histograms
      object.FillHistograms();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Int_t QwRootFile::FillTree ( const std::string &  name )

inline

Fill the tree with name.

Definition at line 359 of file QwRootFile.h.

References fTreeByName, and HasTreeByName().

Referenced by main().

                                          {
      if (! HasTreeByName(name)) return 0;
      else return fTreeByName[name].front()->Fill();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

void QwRootFile::FillTreeBranches	(	const std::string &	name,
		const T &	object
	)

Fill the tree branches of a generic object by tree name.

Fill the tree branches of a generic object by name

Parameters

name	Name for tree
object	Subsystem array

Definition at line 658 of file QwRootFile.h.

References fTreeByAddr, HasTreeByName(), and HasTreeByType().

Referenced by main().

{
  // If this name has no registered trees
  if (! HasTreeByName(name)) return;
  // If this type has no registered trees
  if (! HasTreeByType(object)) return;

  // Get the address of the object
  const void* addr = static_cast<const void*>(&object);

  // Fill the trees with the correct address
  for (size_t tree = 0; tree < fTreeByAddr[addr].size(); tree++) {
    if (fTreeByAddr[addr].at(tree)->GetName() == name) {
      fTreeByAddr[addr].at(tree)->FillTreeBranches(object);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

void QwRootFile::FillTreeBranches

(

const T &

object

)

Fill the tree branches of a generic object by type only.

Fill the tree branches of a generic object by type only

Parameters

object

Subsystem array

Definition at line 684 of file QwRootFile.h.

References fTreeByAddr, and HasTreeByAddr().

{
  // If this address has no registered trees
  if (! HasTreeByAddr(object)) return;

  // Get the address of the object
  const void* addr = static_cast<const void*>(&object);

  // Fill the trees with the correct address
  for (size_t tree = 0; tree < fTreeByAddr[addr].size(); tree++) {
    fTreeByAddr[addr].at(tree)->FillTreeBranches(object);
  }
}

Here is the call graph for this function:

Int_t QwRootFile::FillTrees ( )

inline

Fill all registered trees.

Definition at line 365 of file QwRootFile.h.

References fTreeByName.

                      {
      // Loop over all registered tree names
      Int_t retval = 0;
      std::map< const std::string, std::vector<QwRootTree*> >::iterator iter;
      for (iter = fTreeByName.begin(); iter != fTreeByName.end(); iter++) {
        retval += iter->second.front()->Fill();
      }
      return retval;
    }

TTree* QwRootFile::GetTree ( const std::string &  name )

inline

Get the tree with name.

Definition at line 353 of file QwRootFile.h.

References fTreeByName, and HasTreeByName().

Referenced by main().

                                          {
      if (! HasTreeByName(name)) return 0;
      else return fTreeByName[name].front()->GetTree();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwRootFile::HasAnyFilled ( void  )

private

Search for non-empty trees or histograms in the file.

Determine whether the rootfile object has any non-empty trees or histograms.

Definition at line 293 of file QwRootFile.cc.

References fRootFile.

Referenced by Close(), HasAnyFilled(), and ~QwRootFile().

                                    {
  return this->HasAnyFilled(fRootFile);
}

Here is the caller graph for this function:

Bool_t QwRootFile::HasAnyFilled ( TDirectory *  d )

private

Definition at line 296 of file QwRootFile.cc.

References HasAnyFilled().

                                             {
  if (!d) return false;
  TList* l = d->GetListOfKeys();

  for( int i=0; i < l->GetEntries(); ++i) {
    const char* name = l->At(i)->GetName();
    TObject* obj = d->FindObjectAny(name);

    // Objects which can't be found don't count.
    if (!obj) continue;

    // Lists of parameter files, map files, and job conditions don't count.
    if ( TString(name).Contains("parameter_file") ) continue;
    if ( TString(name).Contains("mapfile") ) continue;
    if ( TString(name).Contains("_condition") ) continue;
    //  The EPICS tree doesn't count
    if ( TString(name).Contains("Slow_Tree") ) continue;

    // Recursively check subdirectories.
    if (obj->IsA()->InheritsFrom( "TDirectory" ))
      if (this->HasAnyFilled( (TDirectory*)obj )) return true;

    if (obj->IsA()->InheritsFrom( "TTree" ))
      if ( ((TTree*) obj)->GetEntries() ) return true;

    if (obj->IsA()->InheritsFrom( "TH1" ))
      if ( ((TH1*) obj)->GetEntries() ) return true;
  }

  return false;
}

Here is the call graph for this function:

bool QwRootFile::HasDirByName ( const std::string &  name )

inlineprivate

Is a tree registered for this name.

Definition at line 540 of file QwRootFile.h.

References fDirsByName.

                                             {
      if (fDirsByName.count(name) == 0) return false;
      else return true;
    }

template<class T >

bool QwRootFile::HasDirByType ( const T &  object )

inlineprivate

Is a directory registered for this type.

Definition at line 546 of file QwRootFile.h.

References fDirsByType.

Referenced by FillHistograms().

                                       {
      std::string type = typeid(object).name();
      if (fDirsByType.count(type) == 0) return false;
      else return true;
    }

Here is the caller graph for this function:

template<class T >

bool QwRootFile::HasTreeByAddr ( const T &  object )

inlineprivate

Is a tree registered for this object.

Definition at line 529 of file QwRootFile.h.

References fTreeByAddr.

Referenced by FillTreeBranches().

                                        {
      const void* addr = static_cast<const void*>(&object);
      if (fTreeByAddr.count(addr) == 0) return false;
      else return true;
    }

Here is the caller graph for this function:

bool QwRootFile::HasTreeByName ( const std::string &  name )

inlineprivate

Is a tree registered for this name.

Definition at line 516 of file QwRootFile.h.

References fTreeByName.

Referenced by FillTree(), FillTreeBranches(), GetTree(), and NewTree().

                                              {
      if (fTreeByName.count(name) == 0) return false;
      else return true;
    }

Here is the caller graph for this function:

template<class T >

bool QwRootFile::HasTreeByType ( const T &  object )

inlineprivate

Is a tree registered for this type.

Definition at line 522 of file QwRootFile.h.

References fTreeByType.

Referenced by FillTreeBranches().

                                        {
      const type_info* type = &typeid(object);
      if (fTreeByType.count(type) == 0) return false;
      else return true;
    }

Here is the caller graph for this function:

bool QwRootFile::IsHistoDisabled ( const std::string &  name )

inlineprivate

Does this histogram directory match a disabled histogram directory?

Definition at line 500 of file QwRootFile.h.

References fDisabledHistos.

Referenced by ConstructHistograms().

                                                {
      for (size_t i = 0; i < fDisabledHistos.size(); i++)
        if (fDisabledHistos.at(i).Match(name)) return true;
      return false;
    }

Here is the caller graph for this function:

Bool_t QwRootFile::IsMapFile ( ) const

inline

Is the map file active?

Definition at line 304 of file QwRootFile.h.

References fMapFile.

{ return (fMapFile); };

Bool_t QwRootFile::IsRootFile ( ) const

inline

Is the ROOT file active?

Definition at line 302 of file QwRootFile.h.

References fRootFile.

{ return (fRootFile); };

bool QwRootFile::IsTreeDisabled ( const std::string &  name )

inlineprivate

Does this tree name match a disabled tree name?

Definition at line 490 of file QwRootFile.h.

References fDisabledTrees.

Referenced by ConstructIndices(), and ConstructTreeBranches().

                                               {
      for (size_t i = 0; i < fDisabledTrees.size(); i++)
        if (fDisabledTrees.at(i).Match(name)) return true;
      return false;
    }

Here is the caller graph for this function:

void QwRootFile::ls ( )

inline

Definition at line 414 of file QwRootFile.h.

References fMapFile, and fRootFile.

{ if (fMapFile) fMapFile->ls();     if (fRootFile) fRootFile->ls(); }

void QwRootFile::Map ( )

inline

Definition at line 415 of file QwRootFile.h.

References fRootFile.

{ if (fRootFile) fRootFile->Map(); }

TDirectory* QwRootFile::mkdir ( const char *  name, const char *  title = ""  )

inline

Definition at line 430 of file QwRootFile.h.

References fRootFile.

                                                                {
      // TMapFile has no suport for mkdir
      if (fRootFile) return fRootFile->mkdir(name, title);
      else return 0;
    }

void QwRootFile::NewTree ( const std::string &  name, const std::string &  desc  )

inline

Create a new tree with name and description.

Definition at line 341 of file QwRootFile.h.

References cd(), fTreeByName, and HasTreeByName().

Referenced by main().

                                                               {
      this->cd();
      QwRootTree *tree = 0;
      if (! HasTreeByName(name)) {
        tree = new QwRootTree(name,desc);
      } else {
        tree = new QwRootTree(fTreeByName[name].front());
      }
      fTreeByName[name].push_back(tree);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwRootFile::Print ( )

inline

Definition at line 413 of file QwRootFile.h.

References fMapFile, and fRootFile.

{ if (fMapFile) fMapFile->Print();  if (fRootFile) fRootFile->Print(); }

void QwRootFile::PrintDirs ( ) const

inline

Print registered histogram directories.

Definition at line 391 of file QwRootFile.h.

References QwLog::endl(), fDirsByName, and QwMessage.

Referenced by main().

                           {
      QwMessage << "Dirs: " << QwLog::endl;
      // Loop ove rall registered directories
      std::map< const std::string, TDirectory* >::const_iterator iter;
      for (iter = fDirsByName.begin(); iter != fDirsByName.end(); iter++) {
        QwMessage << iter->first << QwLog::endl;
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwRootFile::PrintTrees ( ) const

inline

Print registered trees.

Definition at line 376 of file QwRootFile.h.

References QwLog::endl(), fTreeByName, and QwMessage.

Referenced by main().

                            {
      QwMessage << "Trees: " << QwLog::endl;
      // Loop over all registered tree names
      std::map< const std::string, std::vector<QwRootTree*> >::const_iterator iter;
      for (iter = fTreeByName.begin(); iter != fTreeByName.end(); iter++) {
        QwMessage << iter->first << ": " << iter->second.size()
                  << " objects registered" << QwLog::endl;
        // Loop over all registered objects for this tree
        std::vector<QwRootTree*>::const_iterator tree;
        for (tree = iter->second.begin(); tree != iter->second.end(); tree++) {
          (*tree)->Print();
        }
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwRootFile::ProcessOptions

(

QwOptions &

options

)

Process the configuration options.

Parse the configuration options and store in class fields

Parameters

options

Options object

Definition at line 243 of file QwRootFile.cc.

References DisableHisto(), DisableTree(), QwLog::endl(), fAutoFlush, fAutoSave, fBasketSize, fCircularBufferSize, fCompressionLevel, fEnableMapFile, fNumHelEventsToSave, fNumHelEventsToSkip, fNumMpsEventsToSave, fNumMpsEventsToSkip, fRootFileStem, fUpdateInterval, QwOptions::GetValue(), QwMessage, and QwWarning.

Referenced by QwRootFile().

{
  // Option 'root-stem' to specify ROOT file stem
  fRootFileStem = TString(options.GetValue<std::string>("rootfile-stem"));

  // Option 'mapfile' to enable memory-mapped ROOT file
  fEnableMapFile = options.GetValue<bool>("enable-mapfile");

  // Options 'disable-trees' and 'disable-histos' for disabling
  // tree and histogram output
  if (options.GetValue<bool>("disable-trees"))  DisableTree(".*");
  if (options.GetValue<bool>("disable-histos")) DisableHisto(".*");

  // Options 'disable-mps' and 'disable-hel' for disabling
  // helicity window and helicity pattern output
  if (options.GetValue<bool>("disable-mps-tree"))  DisableTree("Mps_Tree");
  if (options.GetValue<bool>("disable-hel-tree"))  DisableTree("Hel_Tree");
  if (options.GetValue<bool>("disable-burst-tree"))  DisableTree("Burst_Tree");
  if (options.GetValue<bool>("disable-slow-tree")) DisableTree("Slow_Tree");

  // Options 'num-accepted-events' and 'num-discarded-events' for
  // prescaling of the tree output
  fNumMpsEventsToSave = options.GetValue<int>("num-mps-accepted-events");
  fNumMpsEventsToSkip = options.GetValue<int>("num-mps-discarded-events");
  fNumHelEventsToSave = options.GetValue<int>("num-mps-accepted-events");
  fNumHelEventsToSkip = options.GetValue<int>("num-mps-discarded-events");

  // Update interval for the map file
  fCircularBufferSize = options.GetValue<int>("circular-buffer");
  fUpdateInterval = options.GetValue<int>("mapfile-update-interval");
  fCompressionLevel = options.GetValue<int>("compression-level");
  fBasketSize = options.GetValue<int>("basket-size");

  // Autoflush and autosave
  fAutoFlush = options.GetValue<int>("autoflush");
  if ((ROOT_VERSION_CODE < ROOT_VERSION(5,26,00)) && fAutoFlush != -30000000){
    QwMessage << QwLog::endl;
    QwWarning << "QwRootFile::ProcessOptions:  "
              << "The 'autoflush' flag is not supported by ROOT version "
              << ROOT_RELEASE
              << QwLog::endl;
  }
  fAutoSave  = options.GetValue<int>("autosave");
  return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void QwRootFile::SetDefaultRootFileStem ( const std::string &  stem )

inlinestatic

Set default ROOT file stem.

Definition at line 296 of file QwRootFile.h.

References fDefaultRootFileStem.

Referenced by main().

                                                              {
      fDefaultRootFileStem = stem;
    }

Here is the caller graph for this function:

void QwRootFile::Update ( )

inline

Definition at line 412 of file QwRootFile.h.

References fMapFile.

Referenced by FillHistograms().

{ if (fMapFile) fMapFile->Update(); } // not for TFile

Here is the caller graph for this function:

Int_t QwRootFile::Write ( const char *  name = 0, Int_t  option = 0, Int_t  bufsize = 0  )

inline

Definition at line 437 of file QwRootFile.h.

References fRootFile.

Referenced by main().

                                                                           {
      Int_t retval = 0;
      // TMapFile has no suport for Write
      if (fRootFile) retval = fRootFile->Write(name, option, bufsize);
      return retval;
    }

Here is the caller graph for this function:

template<class T >

Int_t QwRootFile::WriteObject ( const T *  obj, const char *  name, Option_t *  option = "", Int_t  bufsize = 0  )

inline

Write any object to the ROOT file (only valid for TFile)

Definition at line 403 of file QwRootFile.h.

References fRootFile.

Referenced by QwRootFile().

                                                                                                {
      Int_t retval = 0;
      // TMapFile has no suport for WriteObject
      if (fRootFile) retval = fRootFile->WriteObject(obj,name,option,bufsize);
      return retval;
    }

Here is the caller graph for this function:

template<class T >

Int_t QwRootFile::WriteParamFileList	(	const TString &	name,
		T &	object
	)

Definition at line 736 of file QwRootFile.h.

References fRootFile.

Referenced by main().

{
  Int_t retval = 0;
  if (fRootFile) {
    TList *param_list = (TList*) fRootFile->FindObjectAny(name);
    if (not param_list) {
      retval = fRootFile->WriteObject(object.GetParamFileNameList(name), name);
    }
  }
  return retval;
}

Here is the caller graph for this function:

Field Documentation

Int_t QwRootFile::fAutoFlush

private

Definition at line 474 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

Int_t QwRootFile::fAutoSave

private

Definition at line 475 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

Int_t QwRootFile::fBasketSize

private

Definition at line 473 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

UInt_t QwRootFile::fCircularBufferSize

private

Definition at line 560 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

Int_t QwRootFile::fCompressionLevel

private

Definition at line 472 of file QwRootFile.h.

Referenced by ProcessOptions(), and QwRootFile().

UInt_t QwRootFile::fCurrentEvent

private

Definition at line 561 of file QwRootFile.h.

std::string QwRootFile::fDefaultRootFileStem = "Qweak_"

staticprivate

Default ROOT file stem.

Definition at line 457 of file QwRootFile.h.

Referenced by DefineOptions(), and SetDefaultRootFileStem().

std::map< const std::string, TDirectory* > QwRootFile::fDirsByName

private

Directories.

Definition at line 536 of file QwRootFile.h.

Referenced by ConstructHistograms(), HasDirByName(), and PrintDirs().

std::map< const std::string, std::vector<std::string> > QwRootFile::fDirsByType

private

Definition at line 537 of file QwRootFile.h.

Referenced by ConstructHistograms(), and HasDirByType().

std::vector< TPRegexp > QwRootFile::fDisabledHistos

private

Definition at line 483 of file QwRootFile.h.

Referenced by DisableHisto(), and IsHistoDisabled().

std::vector< TPRegexp > QwRootFile::fDisabledTrees

private

List of excluded trees.

Definition at line 482 of file QwRootFile.h.

Referenced by DisableTree(), and IsTreeDisabled().

Bool_t QwRootFile::fEnableMapFile

private

Definition at line 470 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), ProcessOptions(), and QwRootFile().

Bool_t QwRootFile::fMakePermanent

private

Definition at line 462 of file QwRootFile.h.

Referenced by Close(), and ~QwRootFile().

TMapFile* QwRootFile::fMapFile

private

Map file.

Definition at line 469 of file QwRootFile.h.

Referenced by cd(), Close(), ConstructHistograms(), IsMapFile(), ls(), Print(), QwRootFile(), Update(), and ~QwRootFile().

UInt_t QwRootFile::fNumHelEventsToSave

private

Definition at line 559 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

UInt_t QwRootFile::fNumHelEventsToSkip

private

Definition at line 558 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

UInt_t QwRootFile::fNumMpsEventsToSave

private

Definition at line 557 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

UInt_t QwRootFile::fNumMpsEventsToSkip

private

Prescaling of events written to tree.

Definition at line 556 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and ProcessOptions().

TString QwRootFile::fPermanentName

private

While the file is open, give it a temporary filename. Perhaps change to a permanent name when closing the file.

Definition at line 461 of file QwRootFile.h.

Referenced by QwRootFile(), and ~QwRootFile().

TFile* QwRootFile::fRootFile

private

ROOT file.

Definition at line 452 of file QwRootFile.h.

Referenced by cd(), Close(), ConstructHistograms(), HasAnyFilled(), IsRootFile(), ls(), Map(), mkdir(), Print(), QwRootFile(), Write(), WriteObject(), WriteParamFileList(), and ~QwRootFile().

TString QwRootFile::fRootFileStem

private

ROOT file stem.

Definition at line 455 of file QwRootFile.h.

Referenced by ProcessOptions(), and QwRootFile().

std::map< const void* , std::vector<QwRootTree*> > QwRootFile::fTreeByAddr

private

Definition at line 511 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), FillTreeBranches(), and HasTreeByAddr().

std::map< const std::string, std::vector<QwRootTree*> > QwRootFile::fTreeByName

private

Tree names, addresses, and types.

Definition at line 510 of file QwRootFile.h.

Referenced by ConstructIndices(), ConstructTreeBranches(), FillTree(), FillTrees(), GetTree(), HasTreeByName(), NewTree(), PrintTrees(), and ~QwRootFile().

std::map< const type_info* , std::vector<QwRootTree*> > QwRootFile::fTreeByType

private

Definition at line 512 of file QwRootFile.h.

Referenced by ConstructTreeBranches(), and HasTreeByType().

Int_t QwRootFile::fUpdateInterval

private

Definition at line 471 of file QwRootFile.h.

Referenced by FillHistograms(), and ProcessOptions().

const Int_t QwRootFile::kMaxMapFileSize = 0x10000000

staticprivate

Definition at line 565 of file QwRootFile.h.

Referenced by QwRootFile().

const Long64_t QwRootFile::kMaxTreeSize = 100000000000LL

staticprivate

Maximum tree size.

Definition at line 564 of file QwRootFile.h.

Referenced by ConstructTreeBranches().

---

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

• QwRootFile.h
• QwRootFile.cc