Utility class for histogram creation and management. More...

#include <QwHistogramHelper.h>

Collaboration diagram for QwHistogramHelper:

Data Structures
class	HistParams
	Histogram parameter class. More...

Public Member Functions
	QwHistogramHelper ()

virtual	~QwHistogramHelper ()

void	ProcessOptions (QwOptions &options)
	Process the configuration options.

void	LoadHistParamsFromFile (const std::string &filename)

void	LoadTreeParamsFromFile (const std::string &filename)

void	PrintHistParams () const

TH1F *	Construct1DHist (const TString &inputfile, const TString &name_title)

TH2F *	Construct2DHist (const TString &inputfile, const TString &name_title)

TH1F *	Construct1DHist (const TString &name_title)

TH2F *	Construct2DHist (const TString &name_title)

TProfile *	Construct1DProf (const TString &name_title)

TProfile2D *	Construct2DProf (const TString &name_title)

TH1F *	Construct1DHist (const std::string &inputfile, const TString &name_title)

TH2F *	Construct2DHist (const std::string &inputfile, const TString &name_title)

TProfile *	Construct1DProf (const std::string &inputfile, const TString &name_title)

TProfile2D *	Construct2DProf (const std::string &inputfile, const TString &name_title)

Bool_t	MatchDeviceParamsFromList (const std::string &devicename)

Bool_t	MatchVQWKElementFromList (const std::string &subsystemname, const std::string &moduletype, const std::string &devicename)

Static Public Member Functions
static void	DefineOptions (QwOptions &options)
	Define the configuration options.

Protected Member Functions
TH1F *	Construct1DHist (const HistParams &params)

TH2F *	Construct2DHist (const HistParams &params)

TProfile *	Construct1DProf (const HistParams &params)

TProfile2D *	Construct2DProf (const HistParams &params)

const HistParams	GetHistParamsFromLine (QwParameterFile &mapstr)

const HistParams	GetHistParamsFromFile (const std::string &filename, const TString &histname)

const HistParams	GetHistParamsFromList (const TString &histname)

Bool_t	DoesMatch (const TString &s, const TRegexp &wildcard)

Protected Attributes
Bool_t	fDEBUG

Bool_t	fTrimDisable

Bool_t	fTrimHistoEnable

Bool_t	fTreeTrimFileLoaded

std::string	fInputFile

std::vector< HistParams >	fHistParams

std::vector< std::pair< TString, TRegexp > >	fTreeParams

std::vector< TString >	fSubsystemList

std::vector< std::vector< TString > >	fModuleList

std::vector< std::vector< std::vector< TString > > >	fVQWKTrimmedList

Static Protected Attributes
static const Double_t	fInvalidNumber = -1.0e7

static const TString	fInvalidName = "EmptyEmpty"

Detailed Description

Utility class for histogram creation and management.

This class exists to encapsulate several helper functions to aid in describing histograms. There will be a global copy defined within the analysis framework.

Provides helper functions for creating, configuring, and managing ROOT histograms with consistent naming and binning conventions throughout the analysis framework.

Definition at line 32 of file QwHistogramHelper.h.

Constructor & Destructor Documentation

◆ QwHistogramHelper()

QwHistogramHelper::QwHistogramHelper ( )

inline

Definition at line 34 of file QwHistogramHelper.h.

34: fDEBUG(kFALSE) { fHistParams.clear(); };

QwHistogramHelper::fHistParams

std::vector< HistParams > fHistParams

Definition QwHistogramHelper.h:161

QwHistogramHelper::fDEBUG

Bool_t fDEBUG

Definition QwHistogramHelper.h:155

References fDEBUG, and fHistParams.

◆ ~QwHistogramHelper()

virtual QwHistogramHelper::~QwHistogramHelper ( )

inlinevirtual

Definition at line 35 of file QwHistogramHelper.h.

35{ };

Member Function Documentation

◆ Construct1DHist() [1/4]

TH1F * QwHistogramHelper::Construct1DHist ( const HistParams & params )

protected

Definition at line 499 of file QwHistogramHelper.cc.

{
  TH1F* h1 = 0;
  if (fTrimHistoEnable && params.name_title == fInvalidName) {
    return h1;
  }
 
  h1 = new TH1F(params.name_title,
                params.name_title,
                params.x_nbins,
                Double_t(params.x_min),Double_t(params.x_max));
  h1->SetXTitle(params.xtitle);
  h1->SetYTitle(params.ytitle);
  //  if(params.min!=fInvalidNumber) h1->SetMinimum(params.min);
  //  if(params.max!=fInvalidNumber) h1->SetMinimum(params.max);
  return h1;
}

References fInvalidName, fTrimHistoEnable, QwHistogramHelper::HistParams::name_title, QwHistogramHelper::HistParams::x_max, QwHistogramHelper::HistParams::x_min, QwHistogramHelper::HistParams::x_nbins, QwHistogramHelper::HistParams::xtitle, and QwHistogramHelper::HistParams::ytitle.

◆ Construct1DHist() [2/4]

TH1F * QwHistogramHelper::Construct1DHist	(	const std::string &	inputfile,
		const TString &	name_title )

Definition at line 475 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromFile(inputfile, name_title);
  return Construct1DHist(tmpstruct);
}

References Construct1DHist(), and GetHistParamsFromFile().

Here is the call graph for this function:

◆ Construct1DHist() [3/4]

TH1F * QwHistogramHelper::Construct1DHist	(	const TString &	inputfile,
		const TString &	name_title )

inline

Definition at line 48 of file QwHistogramHelper.h.

                                                                             {
    std::string tmpfile = inputfile.Data();
    return Construct1DHist(tmpfile, name_title);
  };

References Construct1DHist().

Referenced by Construct1DHist(), Construct1DHist(), and Construct1DHist().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Construct1DHist() [4/4]

TH1F * QwHistogramHelper::Construct1DHist ( const TString & name_title )

Definition at line 443 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromList(name_title);
  return Construct1DHist(tmpstruct);
}

References Construct1DHist(), and GetHistParamsFromList().

Here is the call graph for this function:

◆ Construct1DProf() [1/3]

TProfile * QwHistogramHelper::Construct1DProf ( const HistParams & params )

protected

Definition at line 541 of file QwHistogramHelper.cc.

{
  TProfile* h1 = 0;
  if (fTrimHistoEnable && params.name_title == fInvalidName) {
    return h1;
  }
 
  h1 = new TProfile(params.name_title,
                params.name_title,
                params.x_nbins,
                Double_t(params.x_min),Double_t(params.x_max),
                Double_t(params.y_min),Double_t(params.y_max));
  h1->SetMinimum(params.y_min);
  h1->SetMaximum(params.y_max);
  h1->SetXTitle(params.xtitle);
  h1->SetYTitle(params.ytitle);
  return h1;
}

References fInvalidName, fTrimHistoEnable, QwHistogramHelper::HistParams::name_title, QwHistogramHelper::HistParams::x_max, QwHistogramHelper::HistParams::x_min, QwHistogramHelper::HistParams::x_nbins, QwHistogramHelper::HistParams::xtitle, QwHistogramHelper::HistParams::y_max, QwHistogramHelper::HistParams::y_min, and QwHistogramHelper::HistParams::ytitle.

◆ Construct1DProf() [2/3]

TProfile * QwHistogramHelper::Construct1DProf	(	const std::string &	inputfile,
		const TString &	name_title )

Definition at line 491 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromFile(inputfile, name_title);
  return Construct1DProf(tmpstruct);
}

References Construct1DProf(), and GetHistParamsFromFile().

Here is the call graph for this function:

◆ Construct1DProf() [3/3]

TProfile * QwHistogramHelper::Construct1DProf ( const TString & name_title )

Definition at line 459 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromList(name_title);
  return Construct1DProf(tmpstruct);
}

References Construct1DProf(), and GetHistParamsFromList().

Referenced by Construct1DProf(), and Construct1DProf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Construct2DHist() [1/4]

TH2F * QwHistogramHelper::Construct2DHist ( const HistParams & params )

protected

Definition at line 519 of file QwHistogramHelper.cc.

{
  TH2F* h2 = 0;
  if (fTrimHistoEnable && params.name_title == fInvalidName) {
    return h2;
  }
 
  h2 = new TH2F(params.name_title,
                params.name_title,
                params.x_nbins,
                Double_t(params.x_min),Double_t(params.x_max),
                params.y_nbins,
                Double_t(params.y_min),Double_t(params.y_max));
  h2->SetXTitle(params.xtitle);
  h2->SetYTitle(params.ytitle);
  //  if (params.min != fInvalidNumber) h2->SetMinimum(params.min);
  //  if (params.max != fInvalidNumber) h2->SetMinimum(params.max);
  return h2;
}

References fInvalidName, fTrimHistoEnable, QwHistogramHelper::HistParams::name_title, QwHistogramHelper::HistParams::x_max, QwHistogramHelper::HistParams::x_min, QwHistogramHelper::HistParams::x_nbins, QwHistogramHelper::HistParams::xtitle, QwHistogramHelper::HistParams::y_max, QwHistogramHelper::HistParams::y_min, QwHistogramHelper::HistParams::y_nbins, and QwHistogramHelper::HistParams::ytitle.

◆ Construct2DHist() [2/4]

TH2F * QwHistogramHelper::Construct2DHist	(	const std::string &	inputfile,
		const TString &	name_title )

Definition at line 467 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromFile(inputfile, name_title);
  return Construct2DHist(tmpstruct);
}

References Construct2DHist(), and GetHistParamsFromFile().

Here is the call graph for this function:

◆ Construct2DHist() [3/4]

TH2F * QwHistogramHelper::Construct2DHist	(	const TString &	inputfile,
		const TString &	name_title )

inline

Definition at line 52 of file QwHistogramHelper.h.

                                                                             {
    std::string tmpfile = inputfile.Data();
    return Construct2DHist(tmpfile, name_title);
  };

References Construct2DHist().

Referenced by Construct2DHist(), Construct2DHist(), and Construct2DHist().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Construct2DHist() [4/4]

TH2F * QwHistogramHelper::Construct2DHist ( const TString & name_title )

Definition at line 435 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromList(name_title);
  return Construct2DHist(tmpstruct);
}

References Construct2DHist(), and GetHistParamsFromList().

Here is the call graph for this function:

◆ Construct2DProf() [1/3]

TProfile2D * QwHistogramHelper::Construct2DProf ( const HistParams & params )

protected

Definition at line 562 of file QwHistogramHelper.cc.

{
  TProfile2D* h2 = 0;
  if (fTrimHistoEnable && params.name_title == fInvalidName) {
    return h2;
  }
 
  h2 = new TProfile2D(params.name_title,
                params.name_title,
                params.x_nbins,
                Double_t(params.x_min),Double_t(params.x_max),
                params.y_nbins,
                Double_t(params.y_min),Double_t(params.y_max),
                Double_t(params.z_min),Double_t(params.z_max));
  h2->SetMinimum(params.z_min);
  h2->SetMaximum(params.z_max);
  h2->SetXTitle(params.xtitle);
  h2->SetYTitle(params.ytitle);
  return h2;
}

References fInvalidName, fTrimHistoEnable, QwHistogramHelper::HistParams::name_title, QwHistogramHelper::HistParams::x_max, QwHistogramHelper::HistParams::x_min, QwHistogramHelper::HistParams::x_nbins, QwHistogramHelper::HistParams::xtitle, QwHistogramHelper::HistParams::y_max, QwHistogramHelper::HistParams::y_min, QwHistogramHelper::HistParams::y_nbins, QwHistogramHelper::HistParams::ytitle, QwHistogramHelper::HistParams::z_max, and QwHistogramHelper::HistParams::z_min.

◆ Construct2DProf() [2/3]

TProfile2D * QwHistogramHelper::Construct2DProf	(	const std::string &	inputfile,
		const TString &	name_title )

Definition at line 483 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromFile(inputfile, name_title);
  return Construct2DProf(tmpstruct);
}

References Construct2DProf(), and GetHistParamsFromFile().

Here is the call graph for this function:

◆ Construct2DProf() [3/3]

TProfile2D * QwHistogramHelper::Construct2DProf ( const TString & name_title )

Definition at line 451 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct = GetHistParamsFromList(name_title);
  return Construct2DProf(tmpstruct);
}

References Construct2DProf(), and GetHistParamsFromList().

Referenced by Construct2DProf(), and Construct2DProf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DefineOptions()

void QwHistogramHelper::DefineOptions ( QwOptions & options )

static

Define the configuration options.

Definition at line 24 of file QwHistogramHelper.cc.

{
  // Define the histogram and tree options
  options.AddOptions()
    ("enable-tree-trim", po::value<bool>()->default_bool_value(false),
     "enable trimmed trees");
 
  options.AddOptions()
    ("enable-histo-trim", po::value<bool>()->default_bool_value(false),
     "enable trimmed histograms");
 
  options.AddOptions()(
               "tree-trim-file",  
               po::value<string>()->default_value("tree_trim.in"), 
               "trimmed tree file name"
               );
  
  // What about QwTracking ? 
  // Monday, October 18 23:19:09 EDT 2010, jhlee
  options.AddOptions()(
               "histo-trim-file", 
               po::value<string>()->default_value("parity_hist.in"),
               "trimmed histo file name"
               );
 
}

References QwOptions::AddOptions().

Referenced by QwOptions::DefineOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoesMatch()

Bool_t QwHistogramHelper::DoesMatch	(	const TString &	s,
		const TRegexp &	wildcard )

protected

Definition at line 418 of file QwHistogramHelper.cc.

{
  // A very quick and dirty string matching routine using root
  // TString and TRegExp functions. Require the string and wildcard string
  // to have the SAME length to match (much risky if we don't require this),
  // so the only wildcard you want to use here is ".".
 
  static Ssiz_t len = 0;
  if (wildcard.Index(s,&len) == 0 && len == s.Length()) {
    // found a match!
    return kTRUE;
  } else
    return kFALSE;
}

Referenced by GetHistParamsFromFile(), GetHistParamsFromList(), MatchDeviceParamsFromList(), and MatchVQWKElementFromList().

Here is the caller graph for this function:

◆ GetHistParamsFromFile()

const QwHistogramHelper::HistParams QwHistogramHelper::GetHistParamsFromFile	(	const std::string &	filename,
		const TString &	histname )

protected

Definition at line 371 of file QwHistogramHelper.cc.

{
  // The idea is to look up the input file and get the needed histogram parameters
  // For each histogram we are going to scan the input file once, which
  // is not very efficient. But we only construct histograms once per run ...
 
  HistParams tmpstruct;
  tmpstruct.name_title = fInvalidName;
 
  // Open the file
  QwParameterFile mapstr(filename.c_str());
  while (mapstr.ReadNextLine()) {
    mapstr.TrimComment();    // Remove everything after a comment character
    mapstr.TrimWhitespace(); // Get rid of leading and trailing spaces
    if (mapstr.LineIsEmpty())  continue;
 
    TString tmpname = mapstr.GetTypedNextToken<TString>();
    TString tmptype = mapstr.GetTypedNextToken<TString>();
    if (tmptype != "TH1F" && tmptype != "TH2F") {
      QwError << "QwHistogramHelper::GetHistParamsFromFile:  Unrecognized histogram type: "
              << tmptype << " (tmpname==" << tmpname <<")"<< QwLog::endl;
      continue;
    }
 
    if (DoesMatch(histname,tmpname)) {
      // Found a match
      mapstr.RewindToLineStart();
      tmpstruct = GetHistParamsFromLine(mapstr);
      tmpstruct.name_title = histname;
    }
  }
 
  if (fDEBUG) {
    QwMessage << tmpstruct << QwLog::endl;
  }
  if (tmpstruct.name_title == fInvalidName && !fTrimHistoEnable) {
    QwError << "GetHistParamsFromFile:  We haven't found a match of the histogram name: "
        << histname << QwLog::endl;
    QwError << "                        Please check the input file "
        << filename << QwLog::endl;
    exit(1);
  }
  return tmpstruct;
}

References DoesMatch(), QwLog::endl(), fDEBUG, fInvalidName, fTrimHistoEnable, GetHistParamsFromLine(), QwParameterFile::GetTypedNextToken(), QwParameterFile::LineIsEmpty(), QwHistogramHelper::HistParams::name_title, QwError, QwMessage, QwParameterFile::ReadNextLine(), QwParameterFile::RewindToLineStart(), QwParameterFile::TrimComment(), and QwParameterFile::TrimWhitespace().

Referenced by Construct1DHist(), Construct1DProf(), Construct2DHist(), and Construct2DProf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHistParamsFromLine()

const QwHistogramHelper::HistParams QwHistogramHelper::GetHistParamsFromLine ( QwParameterFile & mapstr )

protected

Decodes the histogram parameters from the current line of a QwParameter file. If the line cannot be decoded, the name is returned as fInvalidName.

Definition at line 77 of file QwHistogramHelper.cc.

{
  ///  Decodes the histogram parameters from the current line of
  ///  a QwParameter file.
  ///  If the line cannot be decoded, the name is returned as
  ///  fInvalidName.
  HistParams tmpstruct;
  tmpstruct.name_title = fInvalidName;
 
  std::string tmpname = mapstr.GetTypedNextToken<std::string>();
  std::string tmptype = mapstr.GetTypedNextToken<std::string>();
  if (tmptype != "TH1F" && tmptype != "TH2F"
   && tmptype != "TProfile" && tmptype != "TProfile2D"){
    QwError << "QwHistogramHelper::GetHistParamsFromFile:  Unrecognized histogram type: "
          << tmptype << " (tmpname==" << tmpname <<")"<<  QwLog::endl;
  } else {
    tmpstruct.expression = tmpname;
    tmpstruct.name_title = tmpname;
    tmpstruct.type       = tmptype;
    tmpstruct.x_nbins    = mapstr.GetTypedNextToken<Int_t>();
    tmpstruct.x_min      = mapstr.GetTypedNextToken<Float_t>();
    tmpstruct.x_max      = mapstr.GetTypedNextToken<Float_t>();
    if (tmptype == "TH2F") {
      tmpstruct.y_nbins  = mapstr.GetTypedNextToken<Int_t>();
      tmpstruct.y_min    = mapstr.GetTypedNextToken<Float_t>();
      tmpstruct.y_max    = mapstr.GetTypedNextToken<Float_t>();
    } else if (tmptype == "TProfile") {
      tmpstruct.y_nbins  = 0;
      tmpstruct.y_min    = mapstr.GetTypedNextToken<Float_t>();
      tmpstruct.y_max    = mapstr.GetTypedNextToken<Float_t>();
    } else {
      tmpstruct.y_nbins  = 0;
      tmpstruct.y_min    = 0.0;
      tmpstruct.y_max    = 0.0;
    }
    tmpstruct.xtitle     = mapstr.GetTypedNextToken<TString>();
    tmpstruct.ytitle     = mapstr.GetTypedNextToken<TString>();
 
    std::string tmpmin = mapstr.GetTypedNextToken<std::string>();
    if (tmpmin.find_first_not_of("-+1234567890.eE") == std::string::npos) {
      //  tmpmin is a number
      tmpstruct.min = atof(tmpmin.c_str());
    } else {
      tmpstruct.min = fInvalidNumber;
    }
    std::string tmpmax = mapstr.GetTypedNextToken<std::string>();
    if (tmpmax.find_first_not_of("-+1234567890.eE") == std::string::npos) {
      //  tmpmax is a number
      tmpstruct.max = atof(tmpmax.c_str());
    } else {
      tmpstruct.max = fInvalidNumber;
    }
  }
  return tmpstruct;
}

Referenced by GetHistParamsFromFile(), and LoadHistParamsFromFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHistParamsFromList()

const QwHistogramHelper::HistParams QwHistogramHelper::GetHistParamsFromList ( const TString & histname )

protected

Definition at line 249 of file QwHistogramHelper.cc.

{
  HistParams tmpstruct, matchstruct;
  tmpstruct.name_title = fInvalidName;
 
  std::vector<int> matches;
  for (size_t i = 0; i < fHistParams.size(); i++) {
    if (DoesMatch(histname,fHistParams.at(i).expression)) {
      matchstruct = fHistParams.at(i);
      if (tmpstruct.name_title == fInvalidName) {
        tmpstruct = matchstruct;
        tmpstruct.name_title = histname;
        matches.push_back(i);
        break; // enabled (to get warnings for multiple definitions, disable)
      } else if (tmpstruct.nbins == matchstruct.nbins
              && tmpstruct.min   == matchstruct.min
              && tmpstruct.max   == matchstruct.max
              && tmpstruct.x_nbins == matchstruct.x_nbins
              && tmpstruct.x_min   == matchstruct.x_min
              && tmpstruct.x_max   == matchstruct.x_max
              && tmpstruct.y_nbins == matchstruct.y_nbins
              && tmpstruct.y_min   == matchstruct.y_min
              && tmpstruct.y_max   == matchstruct.y_max) {
        //matches.push_back(i); // disabled (to enable, also remove break above)
      }
    }
  }
 
  // Warn when multiple identical matches were found
  if (matches.size() > 1) {
    QwWarning << "Multiple identical matches for histogram " << histname << ":" << QwLog::endl;
    for (size_t i = 0; i < matches.size(); i++) {
      QwWarning << " " << fHistParams.at(matches.at(i)).name_title << QwLog::endl;
    }
  }
 
  fDEBUG = 0;
  if (fDEBUG) {
    QwMessage << "Finding histogram definition from: " << histname << QwLog::endl;
    QwMessage << tmpstruct << QwLog::endl;
  }
  if (tmpstruct.name_title == fInvalidName && !fTrimHistoEnable) {
    std::cerr << "GetHistParamsFromList:  We haven't found a match of the histogram name: "
          << histname << std::endl;
    std::cerr << "                        Please check the input file "
          << fInputFile << std::endl;
    exit(1);
  }
  return tmpstruct;
}

Referenced by Construct1DHist(), Construct1DProf(), Construct2DHist(), and Construct2DProf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadHistParamsFromFile()

void QwHistogramHelper::LoadHistParamsFromFile ( const std::string & filename )

Definition at line 135 of file QwHistogramHelper.cc.

{
  fInputFile = filename;
 
  fDEBUG = 0;
  //fDEBUG = 1;
 
  if (fDEBUG) std::cout<< "file name "<<fInputFile<<std::endl;
  //Important to empty the fHistParams to reload the real time histo definition file
  if (fTrimHistoEnable)
    fHistParams.clear();
  
  // Open the file
  QwParameterFile mapstr(filename);
  while (mapstr.ReadNextLine()){
    mapstr.TrimComment();    // Remove everything after a comment character.
    mapstr.TrimWhitespace(); // Get rid of leading and trailing spaces.
    if (mapstr.LineIsEmpty()) continue;
 
    HistParams tmpstruct = GetHistParamsFromLine(mapstr);
    if (tmpstruct.name_title != fInvalidName){
      fHistParams.push_back(tmpstruct);
      if (fDEBUG) {
        QwMessage << fHistParams.back() << QwLog::endl;
      }
    }
  }
 
  // Sort the histogram parameter definitions
  sort(fHistParams.begin(), fHistParams.end());
}

References QwLog::endl(), fDEBUG, fHistParams, fInputFile, fInvalidName, fTrimHistoEnable, GetHistParamsFromLine(), QwParameterFile::LineIsEmpty(), QwHistogramHelper::HistParams::name_title, QwMessage, QwParameterFile::ReadNextLine(), QwParameterFile::TrimComment(), and QwParameterFile::TrimWhitespace().

Referenced by ProcessOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadTreeParamsFromFile()

void QwHistogramHelper::LoadTreeParamsFromFile ( const std::string & filename )

Definition at line 177 of file QwHistogramHelper.cc.

{
  TString devicename;
  TString moduletype;
  TString subsystemname;
  std::unique_ptr<QwParameterFile> section = nullptr;
  std::unique_ptr<QwParameterFile> module = nullptr;
  std::vector<TString> TrimmedList;//stores the list of elements for each module
  std::vector<std::vector<TString> > ModulebyTrimmedList;//stores the list of elements for each module
  std::vector<TString> ModuleList;//stores the list of modules for each subsystem
  fDEBUG = 0;
  //fDEBUG = 1;  
  if (fTrimDisable)
    return;
  QwMessage << "Tree trim definition file for Offline Engine"<< QwLog::endl;
  QwParameterFile mapstr(filename.c_str());  //Open the file
 
  fTreeTrimFileLoaded=!mapstr.IsEOF();  
  fSubsystemList.clear();
  fModuleList.clear();
  fVQWKTrimmedList.clear();
  
  while ( (section=mapstr.ReadNextSection(subsystemname)) ){
    if (subsystemname=="DEVICELIST")//done with VQWK element trimming
      break;
    fSubsystemList.push_back(subsystemname);
    QwMessage <<"Subsystem found "<<subsystemname<<QwLog::endl;  
 
    ModuleList.clear();
    ModulebyTrimmedList.clear();
    while ( (module=section->ReadNextModule(moduletype)) ){
 
      ModuleList.push_back(moduletype);
      QwMessage <<"Module found "<<moduletype<<QwLog::endl;
      TrimmedList.clear();
      while (module->ReadNextLine()){
    module->TrimComment('#');   // Remove everything after a '#' character.
    module->TrimWhitespace();   // Get rid of leading and trailing spaces.
    if (module->LineIsEmpty())  continue;
    devicename=(module->GetLine()).c_str();
    TrimmedList.push_back(devicename);
    if (fDEBUG) {
    QwMessage <<"data element "<<devicename<<QwLog::endl;   
    }
      }
      ModulebyTrimmedList.push_back(TrimmedList);
      
 
    }
    fModuleList.push_back(ModuleList);
    fVQWKTrimmedList.push_back(ModulebyTrimmedList);
 
    
  }
  //Start decoding the device list in the section [DEVICELIST]
  fTreeParams.clear();
  while (section->ReadNextLine()){
    section->TrimComment('#');   // Remove everything after a '#' character.
    section->TrimWhitespace();   // Get rid of leading and trailing spaces.
    if (section->LineIsEmpty())  continue;
    devicename=(section->GetLine()).c_str();
    fTreeParams.push_back(std::pair<TString,TRegexp>(devicename,devicename));
    if (fDEBUG)
      QwMessage <<"device name "<<devicename<<QwLog::endl;  
    
  }
 
  //exit(1);
 
}

References QwLog::endl(), fDEBUG, fModuleList, fSubsystemList, fTreeParams, fTreeTrimFileLoaded, fTrimDisable, fVQWKTrimmedList, QwParameterFile::IsEOF(), QwMessage, and QwParameterFile::ReadNextSection().

Referenced by ProcessOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MatchDeviceParamsFromList()

Bool_t QwHistogramHelper::MatchDeviceParamsFromList ( const std::string & devicename )

Definition at line 301 of file QwHistogramHelper.cc.

{
  Int_t matched;
  matched=0;
  if (!fTreeTrimFileLoaded || fTrimDisable){//if file is not loaded or trim tree is disable by cmd flag
    
    return kTRUE;//return true for all devices
  }
  for (size_t i = 0; i < fTreeParams.size(); i++) {
    if (DoesMatch(devicename,fTreeParams.at(i).second)) {
      if (fDEBUG)
    QwMessage << " Branch name found " << fTreeParams.at(i).first << QwLog::endl;
      matched++;
    }
  }
 
  // Warn when multiple identical matches were found
  if (matched > 1) {
    QwWarning << "Multiple identical matches for branch name " << devicename << ":" << QwLog::endl;
  }
  if (matched)
    return kTRUE;
  else
    return kFALSE;
}

References DoesMatch(), QwLog::endl(), fDEBUG, fTreeParams, fTreeTrimFileLoaded, fTrimDisable, QwMessage, and QwWarning.

Here is the call graph for this function:

◆ MatchVQWKElementFromList()

Bool_t QwHistogramHelper::MatchVQWKElementFromList	(	const std::string &	subsystemname,
		const std::string &	moduletype,
		const std::string &	devicename )

Definition at line 327 of file QwHistogramHelper.cc.

{
  Int_t matched = 0;
  if (!fTreeTrimFileLoaded || fTrimDisable){//if file is not loaded or trim tree is disable by cmd flag
 
    return kTRUE;//return true for all devices
  }
  
  for (size_t j = 0; j < fSubsystemList.size(); j++) {
    //    QwMessage << " Subsystem name "<< subsystemname<< " From List "<<fSubsystemList.at(j) <<  QwLog::endl;
    if (DoesMatch(subsystemname,fSubsystemList.at(j))){
      for (size_t i = 0; i < fModuleList.at(j).size(); i++) {
    if (DoesMatch(moduletype,fModuleList.at(j).at(i))) {
      for (size_t k = 0; k < fVQWKTrimmedList.at(j).at(i).size(); k++) {
        if (DoesMatch(elementname,fVQWKTrimmedList.at(j).at(i).at(k))){
          if (fDEBUG)
        QwMessage << "Subsystem " << fSubsystemList.at(j)
                          << " Module Type " << fModuleList.at(j).at(i)
                          << " Element " << fVQWKTrimmedList.at(j).at(i).at(k)
                          << QwLog::endl;
          matched++;
        }
      }
      break;
    }
      }
    }
  }
 
  
  // Warn when multiple identical matches were found
  if (matched > 1) {
    QwWarning << "Multiple identical matches for element name " <<elementname << ":" << QwLog::endl;
  }
  if (matched)
    return kTRUE;
  else
    return kFALSE;
}

References DoesMatch(), QwLog::endl(), fDEBUG, fModuleList, fSubsystemList, fTreeTrimFileLoaded, fTrimDisable, fVQWKTrimmedList, QwMessage, and QwWarning.

Here is the call graph for this function:

◆ PrintHistParams()

void QwHistogramHelper::PrintHistParams ( ) const

Definition at line 168 of file QwHistogramHelper.cc.

{
  for (std::vector<HistParams>::const_iterator h = fHistParams.begin();
       h != fHistParams.end(); ++h) {
    QwMessage << *h << QwLog::endl;
  }
}

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

Here is the call graph for this function:

◆ ProcessOptions()

void QwHistogramHelper::ProcessOptions ( QwOptions & options )

Process the configuration options.

Definition at line 51 of file QwHistogramHelper.cc.

{
  //enable the tree trim when  --enable-tree-trim in offline mode or --enable-mapfile for real time mode
  //  fTrimDisable =!( options.GetValue<bool>("enable-tree-trim") || options.GetValue<bool>("enable-mapfile"));
  //  fTrimHistoEnable = options.GetValue<bool>("enable-histo-trim") || options.GetValue<bool>("enable-mapfile");
  fTrimDisable =!( options.GetValue<bool>("enable-tree-trim"));
  fTrimHistoEnable = options.GetValue<bool>("enable-histo-trim");
  
  if (fTrimDisable)
    QwMessage <<"tree-trim is disabled"<<QwLog::endl;
  else
    QwMessage <<"tree-trim is enabled"<<QwLog::endl;
 
  if (fTrimHistoEnable)
    QwMessage <<"RT Mode: histo-trim is enabled "<<QwLog::endl;
  else
    QwMessage <<"histo-trim is disabled "<<QwLog::endl;
 
  // Process trim file options
  if (options.HasValue("tree-trim-file"))
    LoadTreeParamsFromFile(options.GetValue<string>("tree-trim-file"));
  if (options.HasValue("histo-trim-file"))
    LoadHistParamsFromFile(options.GetValue<string>("histo-trim-file"));
}

References QwLog::endl(), fTrimDisable, fTrimHistoEnable, QwOptions::GetValue(), QwOptions::HasValue(), LoadHistParamsFromFile(), LoadTreeParamsFromFile(), and QwMessage.

Here is the call graph for this function:

Field Documentation

◆ fDEBUG

Bool_t QwHistogramHelper::fDEBUG

protected

Definition at line 155 of file QwHistogramHelper.h.

Referenced by GetHistParamsFromFile(), GetHistParamsFromList(), LoadHistParamsFromFile(), LoadTreeParamsFromFile(), MatchDeviceParamsFromList(), MatchVQWKElementFromList(), and QwHistogramHelper().

◆ fHistParams

std::vector<HistParams> QwHistogramHelper::fHistParams

protected

Definition at line 161 of file QwHistogramHelper.h.

Referenced by GetHistParamsFromList(), LoadHistParamsFromFile(), PrintHistParams(), and QwHistogramHelper().

◆ fInputFile

std::string QwHistogramHelper::fInputFile

protected

Definition at line 160 of file QwHistogramHelper.h.

Referenced by GetHistParamsFromList(), and LoadHistParamsFromFile().

◆ fInvalidName

const TString QwHistogramHelper::fInvalidName = "EmptyEmpty"

staticprotected

Definition at line 154 of file QwHistogramHelper.h.

Referenced by Construct1DHist(), Construct1DProf(), Construct2DHist(), Construct2DProf(), GetHistParamsFromFile(), GetHistParamsFromLine(), GetHistParamsFromList(), and LoadHistParamsFromFile().

◆ fInvalidNumber

const Double_t QwHistogramHelper::fInvalidNumber = -1.0e7

staticprotected

Definition at line 153 of file QwHistogramHelper.h.

Referenced by GetHistParamsFromLine().

◆ fModuleList

std::vector<std::vector<TString> > QwHistogramHelper::fModuleList

protected

Definition at line 165 of file QwHistogramHelper.h.

Referenced by LoadTreeParamsFromFile(), and MatchVQWKElementFromList().

◆ fSubsystemList

std::vector<TString> QwHistogramHelper::fSubsystemList

protected

Definition at line 164 of file QwHistogramHelper.h.

Referenced by LoadTreeParamsFromFile(), and MatchVQWKElementFromList().

◆ fTreeParams

std::vector< std::pair< TString,TRegexp > > QwHistogramHelper::fTreeParams

protected

Definition at line 162 of file QwHistogramHelper.h.

Referenced by LoadTreeParamsFromFile(), and MatchDeviceParamsFromList().

◆ fTreeTrimFileLoaded

Bool_t QwHistogramHelper::fTreeTrimFileLoaded

protected

Definition at line 158 of file QwHistogramHelper.h.

Referenced by LoadTreeParamsFromFile(), MatchDeviceParamsFromList(), and MatchVQWKElementFromList().

◆ fTrimDisable

Bool_t QwHistogramHelper::fTrimDisable

protected

Definition at line 156 of file QwHistogramHelper.h.

Referenced by LoadTreeParamsFromFile(), MatchDeviceParamsFromList(), MatchVQWKElementFromList(), and ProcessOptions().

◆ fTrimHistoEnable

Bool_t QwHistogramHelper::fTrimHistoEnable

protected

Definition at line 157 of file QwHistogramHelper.h.

Referenced by Construct1DHist(), Construct1DProf(), Construct2DHist(), Construct2DProf(), GetHistParamsFromFile(), GetHistParamsFromList(), LoadHistParamsFromFile(), and ProcessOptions().

◆ fVQWKTrimmedList

std::vector<std::vector<std::vector<TString> > > QwHistogramHelper::fVQWKTrimmedList

protected

Definition at line 166 of file QwHistogramHelper.h.

Referenced by LoadTreeParamsFromFile(), and MatchVQWKElementFromList().

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

Data Structures

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QwHistogramHelper()

◆ ~QwHistogramHelper()

Member Function Documentation

◆ Construct1DHist() [1/4]

◆ Construct1DHist() [2/4]

◆ Construct1DHist() [3/4]

◆ Construct1DHist() [4/4]

◆ Construct1DProf() [1/3]

◆ Construct1DProf() [2/3]

◆ Construct1DProf() [3/3]

◆ Construct2DHist() [1/4]

◆ Construct2DHist() [2/4]

◆ Construct2DHist() [3/4]

◆ Construct2DHist() [4/4]

◆ Construct2DProf() [1/3]

◆ Construct2DProf() [2/3]

◆ Construct2DProf() [3/3]

◆ DefineOptions()

◆ DoesMatch()

◆ GetHistParamsFromFile()

◆ GetHistParamsFromLine()

◆ GetHistParamsFromList()

◆ LoadHistParamsFromFile()

◆ LoadTreeParamsFromFile()

◆ MatchDeviceParamsFromList()

◆ MatchVQWKElementFromList()

◆ PrintHistParams()

◆ ProcessOptions()

Field Documentation

◆ fDEBUG

◆ fHistParams

◆ fInputFile

◆ fInvalidName

◆ fInvalidNumber

◆ fModuleList

◆ fSubsystemList

◆ fTreeParams

◆ fTreeTrimFileLoaded

◆ fTrimDisable

◆ fTrimHistoEnable

◆ fVQWKTrimmedList