JRECONSTRUCTION::JEnergyCorrection Class Reference

Auxiliary class for correction of energy determined by JEnergy.cc. More...

#include <JEnergyCorrection.hh>

Inheritance diagram for JRECONSTRUCTION::JEnergyCorrection:

Public Member Functions
	JEnergyCorrection ()
	Default constructor.
	JEnergyCorrection (const std::string &formula)
	Constructor.
	JEnergyCorrection (const TFormula *fcn)
	Constructor.
bool	is_valid () const
	Check validity of pointer.
TString	getFormula () const
	Get formula.
void	setFormula (const std::string &formula)
	Set formula.
double	operator() (const double E) const
	Get corrected energy.
void	load (const char *file_name)
	Load formula from file.
void	store (const char *file_name)
	Store formula to file.

Static Public Member Functions
static const char *	getName ()
	Get name of energy correction formula.

Friends
std::istream &	operator>> (std::istream &in, JEnergyCorrection &object)
	Read energy correction from input.
std::ostream &	operator<< (std::ostream &out, const JEnergyCorrection &object)
	Write energy correction to output.

Detailed Description

Auxiliary class for correction of energy determined by JEnergy.cc.

Note that the correction is applied to 10log(E) with E in GeV.

Definition at line 38 of file JEnergyCorrection.hh.

Constructor & Destructor Documentation

JEnergyCorrection() [1/3]

JRECONSTRUCTION::JEnergyCorrection::JEnergyCorrection ( )

inline

Default constructor.

No correction is applied to the energy.

Definition at line 46 of file JEnergyCorrection.hh.

    {}

JEnergyCorrection() [2/3]

JRECONSTRUCTION::JEnergyCorrection::JEnergyCorrection ( const std::string & formula )

inline

Constructor.

Parameters

formula

formula

Definition at line 55 of file JEnergyCorrection.hh.

    {
      setFormula(formula);
    }

JEnergyCorrection() [3/3]

JRECONSTRUCTION::JEnergyCorrection::JEnergyCorrection ( const TFormula * fcn )

inline

Constructor.

Parameters

fcn	pointer to ROOT formula

Definition at line 66 of file JEnergyCorrection.hh.

                                           :
      std::shared_ptr<const TFormula>(fcn)
    {}

Member Function Documentation

is_valid()

bool JRECONSTRUCTION::JEnergyCorrection::is_valid ( ) const

inline

Check validity of pointer.

Returns

true if pointer not null; else false

Definition at line 76 of file JEnergyCorrection.hh.

    {
      return (bool) std::shared_ptr<const TFormula>(*this);
    }

getFormula()

TString JRECONSTRUCTION::JEnergyCorrection::getFormula ( ) const

inline

Get formula.

Returns

formula

Definition at line 87 of file JEnergyCorrection.hh.

    {
      if (is_valid())
        return get()->GetExpFormula();
      else
        return TString();
    }

setFormula()

void JRECONSTRUCTION::JEnergyCorrection::setFormula ( const std::string & formula )

inline

Set formula.

The input can be:

• TFormula compatible expression;
• name of ROOT file (extension .root);
• name of ASCII file (extension .txt);

Parameters

formula

formula

Definition at line 106 of file JEnergyCorrection.hh.

    {
      if (formula != "") {
 
        TString buffer(formula.c_str());
      
        if (buffer.EndsWith(".root") ||
            buffer.EndsWith(".txt")) {
          
          load(buffer);
          
        } else {
 
          reset(new TFormula(JEnergyCorrection::getName(), buffer));
        }
      }
    }

operator()()

double JRECONSTRUCTION::JEnergyCorrection::operator() ( const double E ) const

inline

Get corrected energy.

Parameters

E	energy [GeV]

Returns

corrected energy [GeV]

Definition at line 131 of file JEnergyCorrection.hh.

    {
      if (is_valid()) {
 
        const double y = get()->Eval(log10(E));
 
        return pow(10.0, y);
      }
 
      return E;
    }

getName()

static const char * JRECONSTRUCTION::JEnergyCorrection::getName ( )

inlinestatic

Get name of energy correction formula.

Returns

name of formula

Definition at line 149 of file JEnergyCorrection.hh.

    {
      return "energy_correction";
    }

load()

void JRECONSTRUCTION::JEnergyCorrection::load ( const char * file_name )

inline

Load formula from file.

Supported file formats:

• ROOT file (extension .root) containing TFormula object with name JEnergyCorrection::getName();
• ASCII file (extension .txt) containing TFormula compatible expression;

Note that the method JEEP::getFullFilename() is used to search for a possible location of a file with the given name in the LD_LIBRARY_PATH environment variable.

Parameters

file_name

file name

Definition at line 167 of file JEnergyCorrection.hh.

    {
      using namespace std;
      using namespace JLANG;
      using namespace JEEP;
 
      TString buffer(getFullFilename(LD_LIBRARY_PATH, file_name).c_str());
 
      if        (buffer.EndsWith(".root")) {
 
        TFile in(buffer, "READ");
        
        if (in.IsOpen()) {
 
          TFormula* f1;
  
          in.GetObject(JEnergyCorrection::getName(), f1);
 
          reset(f1);
      
          in.Close();
 
        } else {
 
          THROW(JFileOpenException, "Error opening file " << buffer);
        }
 
      } else if (buffer.EndsWith(".txt")) {
 
        ifstream in(buffer);
 
        if (in) {
 
          buffer.ReadFile(in);
 
          // remove control characters
 
          for (Ssiz_t i = 0; i != buffer.Length(); ++i) {
            if (iscntrl(buffer[i])) {
              buffer[i] = ' ';
            }
          }
          
          in.close();
 
          reset(new TFormula(JEnergyCorrection::getName(), buffer));
 
        } else {
          
          THROW(JFileOpenException, "Error opening file " << buffer);
        }
 
      } else {
 
        THROW(JProtocolException, "Protocol not defined.");
      }
    }

store()

void JRECONSTRUCTION::JEnergyCorrection::store ( const char * file_name )

inline

Store formula to file.

Supported file formats:

• ROOT file (extension .root) containing TFormula object with name JEnergyCorrection::getName;
• ASCII file (extension .txt) containing TFormula compatible expression;

Parameters

file_name

file name

Definition at line 235 of file JEnergyCorrection.hh.

    {
      using namespace std;
      using namespace JLANG;
      using namespace JEEP;
 
      if (is_valid()) {
 
        const TString buffer(file_name);
 
        if        (buffer.EndsWith(".root")) {
 
          TFile out(file_name, "RECREATE");
 
          out.WriteObject(get(), JEnergyCorrection::getName());
          
          out.Write();
          out.Close();
 
        } else if (buffer.EndsWith(".txt")) {
 
          ofstream out(file_name);
 
          out << *this;
 
          out.close();
        
        } else {
 
          THROW(JProtocolException, "Protocol not defined.");
        }
      }
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JEnergyCorrection & object )

friend

Read energy correction from input.

In case a file name is specified, the method load() is used to read the energy correction from the corresponding file.

Parameters

in	input stream
object	energy correction

Returns

input stream

Definition at line 280 of file JEnergyCorrection.hh.

    {
      std::string buffer;
 
      getline(in, buffer);
 
      object.setFormula(buffer);
 
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JEnergyCorrection & object )

friend

Write energy correction to output.

Parameters

out	output stream
object	energy correction

Returns

output stream

Definition at line 299 of file JEnergyCorrection.hh.

    {
      return out << object.getFormula();
    }

---

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

• JEnergyCorrection.hh