JGIZMO Namespace Reference

Auxiliary applications for use of ROOT and more. More...

Classes
class	JCanvas
	Data structure for size of TCanvas. More...
struct	JOpera
	Auxiliary data structure for JOpera1D.cc and JOpera2D.cc applications. More...
class	JLineAttributes
	Auxiliary class to set line attributes. More...
class	JManager
	Auxiliary class to manage set of compatible ROOT objects (e.g. More...
class	JMarkerAttributes
	Auxiliary class to set marker attributes. More...
class	JRootObject
	Auxiliary data structure for TObject with a user defined label. More...
class	JRootObjectID
	Auxiliary class to handle file name, ROOT directory and object name. More...
class	JStyle
	Wrapper class around ROOT TStyle. More...
struct	JVolume
	Auxiliary class for histogramming of effective volume. More...

Functions
TFile *	getFile (const std::string &file_name, const std::string &option="exist")
	Get TFile pointer. More...
TDirectory *	getDirectory (const JRootObjectID &id)
	Get TDirectory pointer. More...
TObject *	getObject (const JRootObjectID &id)
	Get TObject. More...
bool	isTAttLine (const TObject *object)
	Get drawing option of TH1. More...
Double_t	getResult (const TString &text, TObject *object=NULL)
	Get result of given textual formula. More...
Double_t	getResult (const std::string &text, TObject *object=NULL)
	Get result of given textual formula. More...
int	getParameter (const std::string &text)
	Get parameter number from text string. More...
Double_t	getValue (const std::string &text, TObject *object=NULL)
	Get parameter value from text string. More...
void	setLogarithm (TAxis *axis)
	Make axis logarithmic (e.g. More...
void	convertToPDF (TH1 &h1, const std::string &option="NW", const double factor=1.0)
	Convert 1D histogram to PDF. More...
void	convertToPDF (TH2 &h2, const std::string &option="NXYW", const double factor=1.0)
	Convert 2D histogram to PDF. More...
void	setLimits (TGraph &g1)
	Set limits of TGraph. More...
void	setLimits (TGraph2D &g2)
	Set limits of TGraph2D. More...
void	setRange (double &xmin, double &xmax, const bool logx)
	Set axis range. More...
void	setAxisLabels (TAxis *axis, const JModuleAddressMap &memo)
	initialize axis with PMT address labels More...
TLegend *	getLegend (const Int_t width, const Int_t height, const std::string option="TR")
	Get legend. More...
template<class JKey_t , class JValue_t >
bool	resetObject (JManager< JKey_t, JValue_t > *object, const bool reset=false)
	Reset JManager object. More...

Variables
static const char *const	TIMESTAMP = "#splitline{}{#splitline{%d:%m:%y}{ %H:%M}}%F1970-01-01 00:00:00"
	Time stamp of earliest UTC time. More...
static const char	LABEL_TERMINATOR = '&'
	label terminator More...

Detailed Description

Auxiliary applications for use of ROOT and more.

Author

mdejong

Function Documentation

TFile* JGIZMO::getFile ( const std::string &  file_name, const std::string &  option = "exist"  )

inline

Get TFile pointer.

The TFile pointer of an already opened file is recovered, else a new file is opened.

Parameters

file_name	file name
option	TFile::Open option

Returns

pointer to TFile

Definition at line 89 of file JGizmoToolkit.hh.

  {
    using namespace std;

    gErrorIgnoreLevel = kError;

    static map<string, TFile*> zmap;
    
    map<string, TFile*>::iterator i = zmap.find(file_name);
    
    if (i == zmap.end() || i->second == NULL || !i->second->IsOpen()) {
      
      TFile* file = TFile::Open(file_name.c_str(), option.c_str());
      
      zmap[file_name] = file;

      return file;

    } else {
    
      return i->second;
    }
  }

TDirectory* JGIZMO::getDirectory ( const JRootObjectID &  id )

inline

Get TDirectory pointer.

The TFile pointer of an already opened file is recovered, else a new file is opened.

Parameters

id	identifier

Returns

pointer to TDirectory

Definition at line 121 of file JGizmoToolkit.hh.

  {
    TFile* in = getFile(id.getFilename().c_str(), "exist");

    if (in == NULL || !in->IsOpen()) {
      return NULL;
    }

    if (id.getDirectory() != "")
      return in->GetDirectory(id.getDirectory());
    else
      return in;
  }

TObject* JGIZMO::getObject ( const JRootObjectID &  id )

inline

Get TObject.

Parameters

id	identifier

Returns

pointer to TObject (or NULL)

Definition at line 142 of file JGizmoToolkit.hh.

  {
    TDirectory* dir = getDirectory(id);

    if (dir != NULL) {

      const TRegexp regexp(id.getObjectName());

      TIter iter(dir->GetListOfKeys());

      for (TKey* key; (key = (TKey*) iter.Next()) != NULL; ) {

        const TString tag(key->GetName());

        // option match

        if (tag.Index(regexp) != -1) {
          return key->ReadObj();
        }
      }
    }

    return NULL;
  }

bool JGIZMO::isTAttLine ( const TObject *  object )

inline

Get drawing option of TH1.

Parameters

object

pointer to TObject

Returns

true if TH1 looks a line; else false

Definition at line 174 of file JGizmoToolkit.hh.

  {
    const TH1* h1 = dynamic_cast<const TH1*>(object);
    
    if (h1 != NULL) {

      if (h1->GetSumw2N()) {

        for (Int_t i = 1; i <= h1->GetNbinsX(); ++i) {

          if (h1->GetBinError(i) != 0.0) {
            return false;
          }
        }
      }

      return true;

    } else {

      return false;
    }
  }

Double_t JGIZMO::getResult ( const TString &  text, TObject *  object = NULL  )

inline

Get result of given textual formula.

The formula may contain names of member methods of the object pointed to. These methods should have no arguments and the return type Double_t. Example:

        getResult("1.0/GetEntries", TH1*);

Parameters

text	text
object	pointer to object

Returns

value

Definition at line 212 of file JGizmoToolkit.hh.

  {
    TString buffer(text);
    
    if (object != NULL) {

      TClass* p = TClass::GetClass(object->ClassName());
      
      if (p != NULL) {
        
        TIterator* iter = p->GetListOfAllPublicMethods()->MakeIterator();
        
        for (TMethod* method; (method = (TMethod*) iter->Next()) != NULL; ) {

          for (Ssiz_t index; (index = buffer.Index(method->GetName())) != -1; ) {

            const TRegexp fp("([^)]*)");   // function call

            Ssiz_t len;
            Ssiz_t pos = buffer.Index(fp, &len, index);
            
            Double_t value;
            
            if        (pos == -1) {

              TMethodCall(p, method->GetName(), NULL).Execute(object, value);

              len  = strlen(method->GetName());

            } else if (pos == index + (Ssiz_t) strlen(method->GetName())) {

              TMethodCall(p, method->GetName(), NULL).Execute(object, TString(buffer(pos + 1, len - 2)), value);

              len += strlen(method->GetName());

            } else {

              continue;
            }

            buffer.Replace(index, len, TString::Format("%f", value));
          }
        }
      }
    }

    return TFormula("/tmp", buffer.Data()).Eval(0.0);
  }

Double_t JGIZMO::getResult ( const std::string &  text, TObject *  object = NULL  )

inline

Get result of given textual formula.

The formula may contain names of member methods of the object pointed to. These methods should have no arguments and the return type Double_t. Example:

        getResult("1.0/GetEntries", TH1*);

Parameters

text	text
object	pointer to object

Returns

value

Definition at line 275 of file JGizmoToolkit.hh.

  {
    return getResult(TString(text.c_str()), object);
  }

int JGIZMO::getParameter ( const std::string &  text )

inline

Get parameter number from text string.

The number corresponds to the value [0-9]* in the expression "p[0-9]* = ..".

Parameters

text

text

Returns

parameter number

Definition at line 288 of file JGizmoToolkit.hh.

  {
    const char* regexp("p[0-9]* *=");

    TString buffer(text.c_str());
    
    buffer = buffer(TRegexp(regexp));
    buffer = buffer(1, buffer.Length() - 2);

    if (!buffer.IsDigit()) {
      THROW(JParseError, "Text is not a number " << text << ' ' << regexp);
    }
  
    return buffer.Atoi();
  }

Double_t JGIZMO::getValue ( const std::string &  text, TObject *  object = NULL  )

inline

Get parameter value from text string.

The formula may contain names of member methods of the object pointed to. These methods should have no arguments and the return type Double_t. Example:

        getValue("p[..] = 2*GetMaximum", TH1*);

Parameters

text	text
object	pointer to object

Returns

value

Definition at line 318 of file JGizmoToolkit.hh.

  {
    const char* regexp("=.*");

    TString buffer(text.c_str());
    
    buffer = buffer(TRegexp(regexp));
    buffer = buffer(1, buffer.Length() - 1);

    return getResult(std::string(buffer), object);
  }

void JGIZMO::setLogarithm ( TAxis *  axis )

inline

Make axis logarithmic (e.g.

after filling with log10()).

Parameters

axis

axis

Definition at line 336 of file JGizmoToolkit.hh.

  {
    if (axis != NULL) {

      const int N = axis->GetNbins();
      Double_t  buffer[N+1];
      
      buffer[0] = TMath::Power(10.0, axis->GetBinLowEdge(1));
      
      for (int i = 1; i <= N; ++i) {
        buffer[i] = TMath::Power(10.0, axis->GetBinLowEdge(i) + axis->GetBinWidth(i));
      }
      
      axis->Set(N, buffer);
    }
  }

void JGIZMO::convertToPDF ( TH1 &  h1, const std::string &  option = "NW", const double  factor = 1.0  )

inline

Convert 1D histogram to PDF.

Possible options are:

• N normalise to histogram contents;
• W divide by bin width;
• E convert also bin errors.

Parameters

h1	histogram
option	option
factor	scaling factor

Definition at line 366 of file JGizmoToolkit.hh.

  {
    using namespace std;
    
    const bool normalise = (option.find('N') != string::npos || option.find('n') != string::npos);
    const bool bin_width = (option.find('W') != string::npos || option.find('w') != string::npos);
    const bool use_error = (option.find('E') != string::npos || option.find('e') != string::npos);

    Double_t W = 1.0;

    if (normalise) {

      W = 0.0;
      
      for (Int_t i = 1; i <= h1.GetXaxis()->GetNbins(); ++i) {
        W += h1.GetBinContent(i);
      }
    }
    
    if (W != 0.0) {
      
      for (Int_t i = 1; i <= h1.GetXaxis()->GetNbins(); ++i) {

        const Double_t w = W * (bin_width ? h1.GetXaxis()->GetBinWidth(i) : 1.0);
        
        h1.SetBinContent(i, h1.GetBinContent(i) * factor / w);
        
        if (use_error) {
          h1.SetBinError(i, h1.GetBinError(i) * factor / w);
        }
      }
    }
  }

void JGIZMO::convertToPDF ( TH2 &  h2, const std::string &  option = "NXYW", const double  factor = 1.0  )

inline

Convert 2D histogram to PDF.

Possible options are:

• N normalise to histogram contents;
• X convert x-axis to PDF;
• Y convert y-axis to PDF;
• W divide by bin width;
• E convert also bin errors.

Parameters

h2	histogram
option	option
factor	scaling factor

Definition at line 415 of file JGizmoToolkit.hh.

  {
    using namespace std;
    
    const bool normalise = (option.find('N') != string::npos || option.find('n') != string::npos);
    const bool X         = (option.find('X') != string::npos || option.find('x') != string::npos);
    const bool Y         = (option.find('Y') != string::npos || option.find('y') != string::npos);
    const bool bin_width = (option.find('W') != string::npos || option.find('w') != string::npos);
    const bool use_error = (option.find('E') != string::npos || option.find('e') != string::npos);

    Double_t W = 1.0;
    
    if (X && Y) {

      if (normalise) {
      
        W = 0.0;
        
        for (Int_t i = 1; i <= h2.GetXaxis()->GetNbins(); ++i) {
          for (Int_t j = 1; j <= h2.GetYaxis()->GetNbins(); ++j) {
            W += h2.GetBinContent(i,j);
          }
        }
      }

      if (W != 0.0) {

        for (Int_t i = 1; i <= h2.GetXaxis()->GetNbins(); ++i) {
          for (Int_t j = 1; j <= h2.GetYaxis()->GetNbins(); ++j) {
            
            const Double_t w = W * (bin_width ? h2.GetXaxis()->GetBinWidth(i) * h2.GetYaxis()->GetBinWidth(j) : 1.0);
              
            h2.SetBinContent(i, j, h2.GetBinContent(i,j) * factor / w);
          
            if (use_error) {
              h2.SetBinError(i, j, h2.GetBinError(i,j) * factor / w);
            }
          }
        }
      }
      
    } else if (X) {
    
      for (Int_t j = 1; j <= h2.GetYaxis()->GetNbins(); ++j) {

        if (normalise) {
          
          W = 0.0;
        
          for (Int_t i = 1; i <= h2.GetXaxis()->GetNbins(); ++i) {
            W += h2.GetBinContent(i,j);
          }
        }

        if (W != 0.0) {
          
          for (Int_t i = 1; i <= h2.GetXaxis()->GetNbins(); ++i) {
            
            const Double_t w = W * (bin_width ? h2.GetXaxis()->GetBinWidth(i) : 1.0);

            h2.SetBinContent(i, j, h2.GetBinContent(i,j) * factor / w);
          
            if (use_error) {
              h2.SetBinError(i, j, h2.GetBinError(i,j) * factor / w);
            }
          }
        }
      }
      
    } else if (Y) {
    
      for (Int_t i = 1; i <= h2.GetXaxis()->GetNbins(); ++i) {

        if (normalise) {

          W = 0.0;

          for (Int_t j = 1; j <= h2.GetYaxis()->GetNbins(); ++j) {
            W += h2.GetBinContent(i,j);
          }
        }

        if (W != 0.0) {
          
          for (Int_t j = 1; j <= h2.GetYaxis()->GetNbins(); ++j) {
            
            const Double_t w = W * (bin_width ? h2.GetYaxis()->GetBinWidth(j) : 1.0);

            h2.SetBinContent(i, j, h2.GetBinContent(i,j) / w);
          
            if (use_error) {
              h2.SetBinError(i, j, h2.GetBinError(i,j) / w);
            }
          }
        }
      }
    }
  }

void JGIZMO::setLimits ( TGraph &  g1 )

inline

Set limits of TGraph.

Parameters

g1

graph

Definition at line 520 of file JGizmoToolkit.hh.

  {
    using namespace std;
    
    Double_t ymin = +numeric_limits<Double_t>::max();
    Double_t ymax = -numeric_limits<Double_t>::max();

    for (Int_t i = 0; i != g1.GetN(); ++i) {

      const Double_t y = g1.GetY()[i];

      if (y > ymax) { ymax = y; }
      if (y < ymin) { ymin = y; }
    }

    g1.SetMinimum(ymin);
    g1.SetMaximum(ymax);
  }

void JGIZMO::setLimits ( TGraph2D &  g2 )

inline

Set limits of TGraph2D.

Parameters

g2

graph

Definition at line 545 of file JGizmoToolkit.hh.

  {
    using namespace std;
    
    Double_t zmin = +numeric_limits<Double_t>::max();
    Double_t zmax = -numeric_limits<Double_t>::max();

    for (Int_t i = 0; i != g2.GetN(); ++i) {

      const Double_t z = g2.GetZ()[i];

      if (z > zmax) { zmax = z; }
      if (z < zmin) { zmin = z; }
    }

    g2.SetMinimum(zmin);
    g2.SetMaximum(zmax);
  }

void JGIZMO::setRange ( double &  xmin, double &  xmax, const bool  logx  )

inline

Set axis range.

Parameters

xmin	lower limit (I/O)
xmax	upper limit (I/O)
logx	logarithmic

Definition at line 572 of file JGizmoToolkit.hh.

  {
    if (logx) {
      xmin = log(xmin);
      xmax = log(xmax);
    }

    double dx = (xmax - xmin) * 0.1;

    if (xmin > dx || xmin < 0.0)
      xmin -= dx;
    else
      xmin  = 0.0;

    xmax += dx;

    if (logx) {
      xmin = exp(xmin);
      xmax = exp(xmax);
    }
  }

void JGIZMO::setAxisLabels ( TAxis *  axis, const JModuleAddressMap &  memo  )

inline

initialize axis with PMT address labels

Parameters

axis	axis
memo	default module address map

Definition at line 603 of file JGizmoToolkit.hh.

  {
    using namespace JPP;

    if (axis->GetNbins() == (int) memo.size()) {

      for (int i = 0; i < axis->GetNbins(); i++) {

        const JPMTPhysicalAddress& pmtAddress = memo[i];

        axis->SetBinLabel(i + 1, TString(pmtAddress.toString()));
      }

    } else {

      THROW(JValueOutOfRange, "Number of bins " << axis->GetNbins() << " != " << memo.size());
    }
  } 

TLegend* JGIZMO::getLegend ( const Int_t  width, const Int_t  height, const std::string  option = "TR"  )

inline

Get legend.

Parameters

width	width [characters]
height	height [lines]
option	position [TR TL BL BR]

Returns

legend

Definition at line 28 of file JLegend.hh.

  {
    using namespace std;
      
    gPad->Update();

    const Double_t X1  = 0.0 + gPad->GetLeftMargin();
    const Double_t X2  = 1.0 - gPad->GetRightMargin();
    const Double_t Y1  = 0.0 + gPad->GetBottomMargin();
    const Double_t Y2  = 1.0 - gPad->GetTopMargin();

    const Double_t w   = gPad->XtoPixel(gPad->GetX2());
    const Double_t h   = gPad->YtoPixel(gPad->GetY1());
    const Double_t ch  = gStyle->GetStatFontSize() * (w < h ? w : h);
      
    const Double_t fx  = 0.70 * ch/w;            // estimated fonst size  [NDC]
    const Double_t fy  = 1.10 * ch/h;            // estimated fonst size  [NDC]
    const Double_t eps = 0.002;                  // extra space [NDC]
    const Int_t    nc  = 3;                      // number of characters reserved for margin

    Int_t wd = width;
      
    if (wd < 2) {
      wd = 2;
    }
      
    Double_t W  =  (wd + nc) * fx;               // width  [NDC]
    Double_t H  =  (height)  * fy;               // height [NDC]

    Double_t fc = 1.0;                           // scaling factor
      
    if (fc * W > X2 - X1 - 2*eps) {
      fc *= (X2 - X1 - 2*eps) / W;
    }

    if (fc * H > Y2 - Y1 - 2*eps) {
      fc *= (Y2 - Y1 - 2*eps) / H;
    }
      
    W *= fc;
    H *= fc;
      
    // default position is top-right

    Double_t x1  = X2 - W - eps;
    Double_t y1  = Y2 - H - eps;
    Double_t x2  = X2     - eps;
    Double_t y2  = Y2     - eps;

    int halign = 2;
    int valign = 2;
      
    if (option.find('T') != string::npos && option.find('B') == string::npos) {   // top

      y1  = Y2 - H - eps;
      y2  = Y2     - eps;

      //valign = 1;
    }

    if (option.find('B') != string::npos && option.find('T') == string::npos) {   // bottom

      y1  = Y1     + eps;
      y2  = Y1 + H + eps;

      //valign = 3;
    }

    if (option.find('R') != string::npos && option.find('L') == string::npos) {   // right

      x1  = X2 - W - eps;
      x2  = X2     - eps;

      halign = 1;
    }

    if (option.find('L') != string::npos && option.find('R') == string::npos) {   // left

      x1  = X1     + eps;
      x2  = X1 + W + eps;

      halign = 1;
    }

    TLegend* lg = new TLegend(x1, y1, x2, y2);

    lg->SetTextAlign(halign*10 + valign);

    //lg->SetFillStyle(4000);
    lg->SetFillColor(kWhite);
    lg->SetBorderSize(0);
    lg->SetTextAlign(12);
    lg->SetTextFont(gStyle->GetStatFont());
    lg->SetTextSize(gStyle->GetStatFontSize());
    //lg->SetTextSize(lg->GetTextSize() * fc);
    lg->SetMargin((Double_t) nc / (Double_t) (wd + nc));

    return lg;
  }

template<class JKey_t , class JValue_t >

bool JGIZMO::resetObject ( JManager< JKey_t, JValue_t > *  object, const bool  reset = false  )

inline

Reset JManager object.

Parameters

object	ROOT TH1 object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 365 of file JManager.hh.

  {
    if (object->is_valid()) {
      JROOT::resetObject(object->get());
    }

    for (typename JManager<JKey_t, JValue_t>::iterator i = object->begin(); i != object->end(); ++i) {
      JROOT::resetObject(i->second.get());
    }

    return true;
  }

Variable Documentation

const char* const JGIZMO::TIMESTAMP = "#splitline{}{#splitline{%d:%m:%y}{ %H:%M}}%F1970-01-01 00:00:00"

static

Time stamp of earliest UTC time.

Definition at line 79 of file JGizmoToolkit.hh.

const char JGIZMO::LABEL_TERMINATOR = '&'

static

label terminator

Definition at line 21 of file JRootObject.hh.