JGIZMO Namespace Reference

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

Classes
struct	JOpera
	Auxiliary data structure for JOpera1D.cc and JOpera2D.cc applications. 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...

Functions
TFile *	getFile (const std::string &file_name, const std::string &option="exist")
	Get TFile pointer corresponding to give file name. More...
TDirectory *	getDirectory (const JRootObjectID &id)
	Get TDirectory pointer. More...
TObject *	getObject (const JRootObjectID &id)
	Get first TObject with given identifier. 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...
Double_t	getValue (const std::string &text, const int index)
	Get parameter value from text string. More...
void	setLogarithmic (TAxis *axis)
	Make histogram axis logarithmic (e.g. after using log10()). More...
TString	getLogarithmic (const TString &formula, const char parameter)
	Make given parameter in formula logarithmic (e.g. after using log10()). More...
void	copy (const TF1 &from, TF1 &to)
	Copy function parameters. More...
void	copy (const TF2 &from, TF2 &to)
	Copy function parameters. More...
template<class T >
void	setLogarithmicX (TList *list)
	Make x-axis of objects in list logarithmic (e.g. after using log10()). More...
template<class T >
void	setLogarithmicY (TList *list)
	Make y-axis of objects in list logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TF1 *f1)
	Make x-axis of given function logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TF1 *f1)
	Make y-axis of given function logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TF2 *f2)
	Make x-axis of given function logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TF2 *f2)
	Make y-axis of given function logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TH1 *h1)
	Make x-axis and associated functions of given histogram logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TH2 *h2)
	Make x-axis and associated functions of given histogram logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TH2 *h2)
	Make y-axis and associated functions of given histogram logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TGraph *g1)
	Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TGraph *g1)
	Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TGraphErrors *g1)
	Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TGraphErrors *g1)
	Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TGraph2D *g2)
	Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TGraph2D *g2)
	Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TGraph2DErrors *g2)
	Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TGraph2DErrors *g2)
	Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TMultiGraph *gn)
	Make x-axis of given multi-graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TMultiGraph *gn)
	Make y-axis of given multi-graph logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TLine *line)
	Make x-axis of given line logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TLine *line)
	Make y-axis of given line logarithmic (e.g. after using log10()). More...
void	setLogarithmicX (TEllipse *ellipse)
	Make x-axis of given ellipse logarithmic (e.g. after using log10()). More...
void	setLogarithmicY (TEllipse *ellipse)
	Make y-axis of given ellipse logarithmic (e.g. after using log10()). 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	convertToPDF (TH3 &h3, const std::string &option="NXYW", const double factor=1.0)
	Convert 3D 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)
	Set axis with PMT address labels. More...
void	setAxisLabels (TH1 &h1, const std::string axis, const JModuleAddressMap &memo)
	Set axis labels with PMT addresses. More...
bool	isTObject (const TKey *key)
	Check if given key corresponds to a TObject. 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 corresponding to give file name.

The TFile pointer of an already opened file is recovered, else a new file is opened.
Note that the closure of the opened files should be done by the caller of this method.

Parameters

file_name	file name
option	TFile::Open option

Returns

pointer to TFile

Definition at line 107 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 140 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 first TObject with given identifier.

Parameters

id	identifier

Returns

pointer to TObject (or NULL)

Definition at line 161 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 like a line; else false

Definition at line 193 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;
            }
          }
        }
      }
    }
    {
      const TGraphErrors* g1 = dynamic_cast<const TGraphErrors*>(object);

      if (g1 != NULL) {

        for (Int_t i = 0; i != g1->GetN(); ++i) {
          if (g1->GetEY()[i] != 0.0) {
            return false;
          }
        }

        return g1->GetN() > 1;
      }
    }
    {
      const TGraph* g1 = dynamic_cast<const TGraph*>(object);

      if (g1 != NULL) {
        return g1->GetN() > 1;
      }
    }

    return true;
  }

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 return a value that is compatible with Double_t and could have arguments.
For example:

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

Parameters

text	text
object	pointer to object

Returns

value

Definition at line 249 of file JGizmoToolkit.hh.

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

      TClass* p = TClass::GetClass(object->ClassName());
      
      if (p != NULL) {
        
        for ( ; ; ) {

          TMethod* method = NULL;

          for (std::unique_ptr<TIterator> iter(p->GetListOfAllPublicMethods()->MakeIterator()); TMethod* p = (TMethod*) iter->Next(); ) {
            if (buffer.Index(p->GetName()) != -1) {
              if (method == NULL || strlen(p->GetName()) > strlen(method->GetName())) {
                method = p;
              }
            }
          }

          if (method == NULL) {
            break;
          }

          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 || pos != index + (Ssiz_t) strlen(method->GetName())) {

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

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

            } else {

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

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

            buffer.Replace(index, len, TString::Format("%20.10e", 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 return a value that is compatible with Double_t and could have arguments.
For example:

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

Parameters

text	text
object	pointer to object

Returns

value

Definition at line 321 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 335 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 return a value that is compatible with Double_t and could have arguments.
For example:

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

Parameters

text	text
object	pointer to object

Returns

value

Definition at line 366 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);
  }

Double_t JGIZMO::getValue ( const std::string &  text, const int  index  )

inline

Get parameter value from text string.

The formula may contain names of member methods of the object pointed to.
These methods should return a value that is compatible with Double_t and could have arguments.
For example:

        getValue("p[..] = 1.0 2.0 3.0", 1);

will return 2.0.

Parameters

text	text
index	index

Returns

value

Definition at line 394 of file JGizmoToolkit.hh.

  {
    using namespace std;

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

    TString buffer(text.c_str());

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


    istringstream is((std::string(buffer)));

    Double_t value;

    for (int i = index; is >> value && i > 0; --i) {}

    if (is)
      return value;
    else
      THROW(JParseError, "Text does not contain a number at given position " << buffer << ' ' << index);
  }

void JGIZMO::setLogarithmic ( TAxis *  axis )

inline

Make histogram axis logarithmic (e.g. after using log10()).

Parameters

axis

axis

Definition at line 424 of file JGizmoToolkit.hh.

  {
    if (axis != NULL) {
      
      const Int_t    first = axis->GetFirst();
      const Int_t    last  = axis->GetLast();

      const Double_t xmin  = axis->GetBinLowEdge(first);
      const Double_t xmax  = axis->GetBinLowEdge(last)  +  axis->GetBinWidth(last);

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

      if (axis->TestBit(TAxis::kAxisRange)) {
        axis->SetRangeUser(TMath::Power(10.0, xmin), TMath::Power(10.0, xmax));
      }
    }
  }

TString JGIZMO::getLogarithmic ( const TString &  formula, const char  parameter  )

inline

Make given parameter in formula logarithmic (e.g. after using log10()).

Parameters

formula	formula
parameter	parameter

Returns

formula

Definition at line 459 of file JGizmoToolkit.hh.

  {
    const TRegexp regexp[] = {
      TString("^")          + TString(parameter) + TString("[^a-zA-Z_]"),   // parameter at start  of line
      TString("[^a-zA-Z_]") + TString(parameter) + TString("[^a-zA-Z_]"),   // parameter in middle of line
      TString("[^a-zA-Z_]") + TString(parameter) + TString("$")             // parameter at end    of line
    };

    const TString replacement = TString("log10(") + TString(parameter) + TString(")");

    TString buffer(formula);

    if (buffer.Length() == 1 && buffer[0] == parameter) {

      buffer = replacement;

    } else {
 
      for (Ssiz_t pos = 0, i; pos < buffer.Length(); pos += replacement.Length()) {
        if      ((i = buffer.Index(regexp[0], pos)) != -1) { buffer.Replace((pos = i + 0), 1, replacement); }
        else if ((i = buffer.Index(regexp[1], pos)) != -1) { buffer.Replace((pos = i + 1), 1, replacement); }
        else if ((i = buffer.Index(regexp[2], pos)) != -1) { buffer.Replace((pos = i + 1), 1, replacement); }
        else { break; }
      }
    }

    return buffer;
  }

void JGIZMO::copy ( const TF1 &  from, TF1 &  to  )

inline

Copy function parameters.

Parameters

from	function
to	function

Definition at line 495 of file JGizmoToolkit.hh.

  {
    static_cast<TAttLine&>  (to) = static_cast<const TAttLine&>  (from);
    static_cast<TAttFill&>  (to) = static_cast<const TAttFill&>  (from);
    static_cast<TAttMarker&>(to) = static_cast<const TAttMarker&>(from);

    to.SetParameters(from.GetParameters());

    to.SetNpx(from.GetNpx());
  }

void JGIZMO::copy ( const TF2 &  from, TF2 &  to  )

inline

Copy function parameters.

Parameters

from	function
to	function

Definition at line 513 of file JGizmoToolkit.hh.

  {
    copy(static_cast<const TF1&>(from), static_cast<TF1&>(to));

    to.SetNpy(from.GetNpy());
  }

template<class T >

void JGIZMO::setLogarithmicX ( TList *  list )

inline

Make x-axis of objects in list logarithmic (e.g. after using log10()).

Parameters

list

list

Definition at line 921 of file JGizmoToolkit.hh.

  {
    for (TIter i(list); T* p = dynamic_cast<T*>(i.Next()); ) {
      setLogarithmicX(p);
    }
  }

template<class T >

void JGIZMO::setLogarithmicY ( TList *  list )

inline

Make y-axis of objects in list logarithmic (e.g. after using log10()).

Parameters

list

list

Definition at line 935 of file JGizmoToolkit.hh.

  {
    for (TIter i(list); T* p = dynamic_cast<T*>(i.Next()); ) {
      setLogarithmicY(p);
    }
  }

void JGIZMO::setLogarithmicX ( TF1 *  f1 )

inline

Make x-axis of given function logarithmic (e.g. after using log10()).

Parameters

f1

function

Definition at line 544 of file JGizmoToolkit.hh.

  {
    if (f1 != NULL) {

      TF1 fn(f1->GetName(), getLogarithmic(f1->GetExpFormula(), 'x'));

      copy(*f1, fn);

      fn.SetRange(f1->GetXmin(),
                  f1->GetXmax());

      *f1 = fn;

      f1->SetRange(TMath::Power(10.0,f1->GetXmin()),
                   TMath::Power(10.0,f1->GetXmax()));
    }
  }

void JGIZMO::setLogarithmicY ( TF1 *  f1 )

inline

Make y-axis of given function logarithmic (e.g. after using log10()).

Parameters

f1

function

Definition at line 568 of file JGizmoToolkit.hh.

  {
    if (f1 != NULL) {

      TString buffer = f1->GetExpFormula();

      buffer = "pow(10.0, " + buffer + ")";

      TF1 fn(f1->GetName(), buffer);

      copy(*f1, fn);

      *f1 = fn;
    }
  }

void JGIZMO::setLogarithmicX ( TF2 *  f2 )

inline

Make x-axis of given function logarithmic (e.g. after using log10()).

Parameters

f2

function

Definition at line 590 of file JGizmoToolkit.hh.

  {
    if (f2 != NULL) {

      TF2 fn(f2->GetName(), getLogarithmic(f2->GetExpFormula(), 'x'));

      copy(*f2, fn);

      fn.SetRange(f2->GetXmin(),
                  f2->GetYmin(),
                  f2->GetXmax(),
                  f2->GetYmax());

      *f2 = fn;

      f2->SetRange(TMath::Power(10.0,f2->GetXmin()),
                   f2->GetYmin(),
                   TMath::Power(10.0,f2->GetXmax()),
                   f2->GetYmax());
    }
  }

void JGIZMO::setLogarithmicY ( TF2 *  f2 )

inline

Make y-axis of given function logarithmic (e.g. after using log10()).

Parameters

f2

function

Definition at line 618 of file JGizmoToolkit.hh.

  {
    if (f2 != NULL) {

      TF2 fn(f2->GetName(), getLogarithmic(f2->GetExpFormula(), 'y'));

      copy(*f2, fn);

      fn.SetRange(f2->GetXmin(),
                  f2->GetYmin(),
                  f2->GetXmax(),
                  f2->GetYmax());

      *f2 = fn;

      f2->SetRange(f2->GetXmin(),
                   TMath::Power(10.0,f2->GetYmin()),
                   f2->GetXmax(),
                   TMath::Power(10.0,f2->GetYmax()));
    }
  }

void JGIZMO::setLogarithmicX ( TH1 *  h1 )

inline

Make x-axis and associated functions of given histogram logarithmic (e.g. after using log10()).

Parameters

h1

histogram

Definition at line 646 of file JGizmoToolkit.hh.

  {
    if (h1 != NULL) {

      setLogarithmicX<TF1>(h1->GetListOfFunctions());
      
      setLogarithmic(h1->GetXaxis());
    }
  }

void JGIZMO::setLogarithmicX ( TH2 *  h2 )

inline

Make x-axis and associated functions of given histogram logarithmic (e.g. after using log10()).

Parameters

h2

histogram

Definition at line 662 of file JGizmoToolkit.hh.

  {
    using namespace std;

    if (h2 != NULL) {

      setLogarithmicX<TF2>(h2->GetListOfFunctions());

      setLogarithmic(h2->GetXaxis());
    }
  }

void JGIZMO::setLogarithmicY ( TH2 *  h2 )

inline

Make y-axis and associated functions of given histogram logarithmic (e.g. after using log10()).

Parameters

h2

histogram

Definition at line 680 of file JGizmoToolkit.hh.

  {
    if (h2 != NULL) {

      setLogarithmicY<TF2>(h2->GetListOfFunctions());

      setLogarithmic(h2->GetYaxis());
    }
  }

void JGIZMO::setLogarithmicX ( TGraph *  g1 )

inline

Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g1

graph

Definition at line 696 of file JGizmoToolkit.hh.

  {
    if (g1 != NULL) {

      setLogarithmicX<TF1>(g1->GetListOfFunctions());

      for (Int_t i = 0; i != g1->GetN(); ++i) {
        g1->GetX()[i] = pow(10.0, g1->GetX()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicY ( TGraph *  g1 )

inline

Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g1

graph

Definition at line 714 of file JGizmoToolkit.hh.

  {
    if (g1 != NULL) {

      setLogarithmicY<TF1>(g1->GetListOfFunctions());

      for (Int_t i = 0; i != g1->GetN(); ++i) {
        g1->GetY()[i] = pow(10.0, g1->GetY()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicX ( TGraphErrors *  g1 )

inline

Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g1

graph

Definition at line 732 of file JGizmoToolkit.hh.

  {
    if (g1 != NULL) {

      setLogarithmicX<TF1>(g1->GetListOfFunctions());

      for (Int_t i = 0; i != g1->GetN(); ++i) {
        g1->GetEX()[i] = pow(10.0, g1->GetX()[i] + g1->GetEX()[i])  -  pow(10.0, g1->GetX()[i]);
        g1->GetX() [i] = pow(10.0, g1->GetX()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicY ( TGraphErrors *  g1 )

inline

Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g1

graph

Definition at line 751 of file JGizmoToolkit.hh.

  {
    if (g1 != NULL) {

      setLogarithmicY<TF1>(g1->GetListOfFunctions());

      for (Int_t i = 0; i != g1->GetN(); ++i) {
        g1->GetEY()[i] = pow(10.0, g1->GetY()[i] + g1->GetEY()[i])  -  pow(10.0, g1->GetY()[i]);
        g1->GetY() [i] = pow(10.0, g1->GetY()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicX ( TGraph2D *  g2 )

inline

Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g2

graph

Definition at line 770 of file JGizmoToolkit.hh.

  {
    if (g2 != NULL) {

      setLogarithmicX<TF2>(g2->GetListOfFunctions());

      for (Int_t i = 0; i != g2->GetN(); ++i) {
        g2->GetX()[i] = pow(10.0, g2->GetX()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicY ( TGraph2D *  g2 )

inline

Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g2

graph

Definition at line 788 of file JGizmoToolkit.hh.

  {
    if (g2 != NULL) {

      setLogarithmicY<TF2>(g2->GetListOfFunctions());

      for (Int_t i = 0; i != g2->GetN(); ++i) {
        g2->GetY()[i] = pow(10.0, g2->GetY()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicX ( TGraph2DErrors *  g2 )

inline

Make x-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g2

graph

Definition at line 806 of file JGizmoToolkit.hh.

  {
    if (g2 != NULL) {

      setLogarithmicX<TF2>(g2->GetListOfFunctions());

      for (Int_t i = 0; i != g2->GetN(); ++i) {
        g2->GetEX()[i] = pow(10.0, g2->GetX()[i] + g2->GetEX()[i])  -  pow(10.0, g2->GetX()[i]);
        g2->GetX() [i] = pow(10.0, g2->GetX()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicY ( TGraph2DErrors *  g2 )

inline

Make y-axis and associated functions of given graph logarithmic (e.g. after using log10()).

Parameters

g2

graph

Definition at line 825 of file JGizmoToolkit.hh.

  {
    if (g2 != NULL) {

      setLogarithmicY<TF2>(g2->GetListOfFunctions());

      for (Int_t i = 0; i != g2->GetN(); ++i) {
        g2->GetEY()[i] = pow(10.0, g2->GetY()[i] + g2->GetEY()[i])  -  pow(10.0, g2->GetY()[i]);
        g2->GetY() [i] = pow(10.0, g2->GetY()[i]);
      }
    }
  }

void JGIZMO::setLogarithmicX ( TMultiGraph *  gn )

inline

Make x-axis of given multi-graph logarithmic (e.g. after using log10()).

Parameters

gn	multi graph

Definition at line 844 of file JGizmoToolkit.hh.

  {
    if (gn != NULL) {
      setLogarithmicX<TGraph>(gn->GetListOfGraphs());
    }
  }

void JGIZMO::setLogarithmicY ( TMultiGraph *  gn )

inline

Make y-axis of given multi-graph logarithmic (e.g. after using log10()).

Parameters

gn	multi graph

Definition at line 857 of file JGizmoToolkit.hh.

  {
    if (gn != NULL) {
      setLogarithmicY<TGraph>(gn->GetListOfGraphs());
    }
  }

void JGIZMO::setLogarithmicX ( TLine *  line )

inline

Make x-axis of given line logarithmic (e.g. after using log10()).

Parameters

line

line

Definition at line 870 of file JGizmoToolkit.hh.

  {
    if (line != NULL) {
      line->SetX1(pow(10.0, line->GetX1()));
      line->SetX2(pow(10.0, line->GetX2()));
    }
  }

void JGIZMO::setLogarithmicY ( TLine *  line )

inline

Make y-axis of given line logarithmic (e.g. after using log10()).

Parameters

line

line

Definition at line 884 of file JGizmoToolkit.hh.

  {
    if (line != NULL) {
      line->SetY1(pow(10.0, line->GetY1()));
      line->SetY2(pow(10.0, line->GetY2()));
    }
  }

void JGIZMO::setLogarithmicX ( TEllipse *  ellipse )

inline

Make x-axis of given ellipse logarithmic (e.g. after using log10()).

Parameters

ellipse

ellipse

Definition at line 898 of file JGizmoToolkit.hh.

  {
    THROW(JFunctionalException, "Operation setLogarithmicX on TEllipse not allowed.");
  }

void JGIZMO::setLogarithmicY ( TEllipse *  ellipse )

inline

Make y-axis of given ellipse logarithmic (e.g. after using log10()).

Parameters

ellipse

ellipse

Definition at line 909 of file JGizmoToolkit.hh.

  {
    THROW(JFunctionalException, "Operation setLogarithmicY on TEllipse not allowed.");
  }

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 955 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 1004 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 ix = 1; ix <= h2.GetXaxis()->GetNbins(); ++ix) {
          for (Int_t iy = 1; iy <= h2.GetYaxis()->GetNbins(); ++iy) {
            W += h2.GetBinContent(ix,iy);
          }
        }
      }

      if (W != 0.0) {

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

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

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

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

        if (normalise) {

          W = 0.0;

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

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

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

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

inline

Convert 3D histogram to PDF.

Possible options are:

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

Parameters

h3	histogram
option	option
factor	scaling factor

Definition at line 1119 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 Z         = (option.find('Z') != string::npos || option.find('z') != 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 && Z) {

      if (normalise) {
      
        W = 0.0;
        
        for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
          for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {
            for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {     
              W += h3.GetBinContent(ix,iy,iz);
            }
          }
        }
      }

      if (W != 0.0) {

        for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
          for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {
            for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {     
            
              const Double_t w = W * (bin_width ? h3.GetXaxis()->GetBinWidth(ix) * h3.GetYaxis()->GetBinWidth(iy) * h3.GetZaxis()->GetBinWidth(iz) : 1.0);
              
              h3.SetBinContent(ix, iy, iz, h3.GetBinContent(ix,iy,iz) * factor / w);
          
              if (use_error) {
                h3.SetBinError(ix, iy, iz, h3.GetBinError(ix,iy,iz) * factor / w);
              }
            }
          }
        }
      }
      
    } else if (X && Z) {

      for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {
        
        if (normalise) {
      
          W = 0.0;
        
          for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
            for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {
              W += h3.GetBinContent(ix,iy,iz);
            }
          }
        }

        if (W != 0.0) {

          for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
            for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {
            
              const Double_t w = W * (bin_width ? h3.GetXaxis()->GetBinWidth(ix) * h3.GetZaxis()->GetBinWidth(iz) : 1.0);
              
              h3.SetBinContent(ix, iy, iz, h3.GetBinContent(ix,iy,iz) * factor / w);
          
              if (use_error) {
                h3.SetBinError(ix, iy, iz, h3.GetBinError(ix,iy,iz) * factor / w);
              }
            }
          }
        }
      }
      
    } else if (Y && Z) {

      for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
        
        if (normalise) {
      
          W = 0.0;
        
          for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {
            for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {
              W += h3.GetBinContent(ix,iy,iz);
            }
          }
        }

        if (W != 0.0) {

          for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {
            for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {
            
              const Double_t w = W * (bin_width ? h3.GetYaxis()->GetBinWidth(iy) * h3.GetZaxis()->GetBinWidth(iz) : 1.0);
              
              h3.SetBinContent(ix, iy, iz, h3.GetBinContent(ix,iy,iz) * factor / w);
          
              if (use_error) {
                h3.SetBinError(ix, iy, iz, h3.GetBinError(ix,iy,iz) * factor / w);
              }
            }
          }
        }
      }
      
    } else if (X && Y) {

      for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {      

        if (normalise) {
      
          W = 0.0;
        
          for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
            for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {
              W += h3.GetBinContent(ix,iy,iz);
            }
          }
        }

        if (W != 0.0) {

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

          if (normalise) {
          
            W = 0.0;
        
            for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
              W += h3.GetBinContent(ix,iy,iz);
            }
          }

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

              h3.SetBinContent(ix, iy, iz, h3.GetBinContent(ix,iy,iz) * factor / w);
          
              if (use_error) {
                h3.SetBinError(ix, iy, iz, h3.GetBinError(ix,iy,iz) * factor / w);
              }
            }
          }
        }
      }
      
    } else if (Y) {
    
      for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
        for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {     

          if (normalise) {

            W = 0.0;

            for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {
              W += h3.GetBinContent(ix,iy,iz);
            }
          }

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

              h3.SetBinContent(ix, iy, iz, h3.GetBinContent(ix,iy,iz) / w);
          
              if (use_error) {
                h3.SetBinError(ix, iy, iz, h3.GetBinError(ix,iy,iz) / w);
              }
            }
          }
        }
      }
      
    } else if (Z) {

      for (Int_t ix = 1; ix <= h3.GetXaxis()->GetNbins(); ++ix) {
        for (Int_t iy = 1; iy <= h3.GetYaxis()->GetNbins(); ++iy) {     

          if (normalise) {

            W = 0.0;

            for (Int_t iz = 1; iz <= h3.GetZaxis()->GetNbins(); ++iz) {
              W += h3.GetBinContent(ix,iy,iz);
            }
          }

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

              h3.SetBinContent(ix, iy, iz, h3.GetBinContent(ix,iy,iz) / w);
          
              if (use_error) {
                h3.SetBinError(ix, iy, iz, h3.GetBinError(ix,iy,iz) / w);
              }
            }
          }
        }
      }
    }
  }

void JGIZMO::setLimits ( TGraph &  g1 )

inline

Set limits of TGraph.

Parameters

g1

graph

Definition at line 1359 of file JGizmoToolkit.hh.

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

    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 1384 of file JGizmoToolkit.hh.

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

    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 1411 of file JGizmoToolkit.hh.

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

    double dx = (xmax - xmin) * 0.1;

    if (logx || 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

Set axis with PMT address labels.

This methods sets the labels of the given axis to the sorted values of the PMT ring and position.
It should normally be called before filling of the corresponding histogram.
The filling should then be made with the textual representation of the PMT ring and position (i.e. JDETECTOR::JPMTPhysicalAddress::toString).

Alternatively, the filling can be made with the index of the PMT in the address map of the corresponding module (i.e. JDETECTOR::JModuleAddressMap::getIndex).
In that case, the method can be called before or after filling of the histogram.

Parameters

axis	axis
memo	module address map

Definition at line 1450 of file JGizmoToolkit.hh.

  {
    using namespace JPP;

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

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

        const JPMTPhysicalAddress& address = memo[i];

        axis->SetBinLabel(i + 1, address.toString().c_str());
      }

    } else {

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

void JGIZMO::setAxisLabels ( TH1 &  h1, const std::string  axis, const JModuleAddressMap &  memo  )

inline

Set axis labels with PMT addresses.

This methods sets the labels of the given axis to the sorted values of the PMT ring and position.
It should be called after filling of the corresponding histogram.
The filling should have been made with the PMT number (e.g. KM3NETDAQ::JDAQHit::getPMT).

Parameters

h1	histogram
axis	axis (x, X, y, Y, z, Z)
memo	module address map

Definition at line 1481 of file JGizmoToolkit.hh.

  {
    using namespace JPP;

    TAxis* pax = NULL;

    if      (axis == "x" || axis == "X") 
      pax = h1.GetXaxis();
    else if (axis == "y" || axis == "Y") 
      pax = h1.GetYaxis();
    else if (axis == "z" || axis == "Z") 
      pax = h1.GetZaxis();
    else
      THROW(JValueOutOfRange, "Invalid axis " << axis);

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

      for (int i = 0; i != pax->GetNbins(); ++i) {

        const JPMTPhysicalAddress& address = memo.getAddressTranslator(i);

        pax->SetBinLabel(i + 1, address.toString().c_str());
      }

      h1.LabelsOption("a", axis.c_str());       // sort labels

    } else {

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

bool JGIZMO::isTObject ( const TKey *  key )

inline

Check if given key corresponds to a TObject.

Parameters

key

ROOT key

Returns

true if given key corresponds to a TObject; else false

Definition at line 1520 of file JGizmoToolkit.hh.

  {
    return (key != NULL && TClass::GetClass(key->GetClassName())->IsTObject());
  }

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 94 of file JGizmoToolkit.hh.

const char JGIZMO::LABEL_TERMINATOR = '&'

static

label terminator

Definition at line 23 of file JRootObject.hh.