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

#include <JEnergyCorrection.hh>

Inheritance diagram for JFIT::JEnergyCorrection:

Public Member Functions
	JEnergyCorrection ()
	Default constructor. More...

	JEnergyCorrection (const std::string &formula)
	Constructor. More...

	JEnergyCorrection (const TFormula *fcn)
	Constructor. More...

TString	getFormula () const
	Get formula. More...

void	setFormula (const std::string &formula)
	Set formula. More...

double	operator() (const double E) const
	Get corrected energy. More...

void	load (const char *file_name)
	Load formula from file. More...

void	store (const char *file_name)
	Store formula to file. More...

virtual const TFormula *	get () const
	Get pointer. More...

virtual void	set (const TFormula *p)
	Set pointer. More...

void	set (const JPointer< T > &pointer)
	Set pointer. More...

virtual void	reset ()
	Reset pointer. More...

void	reset (const JPointer< T > &pointer)
	Reset pointer. More...

void	reset (const TFormula *p)
	Reset pointer. More...

const TFormula *const &	getReference () const
	Get rereference to internal pointer. More...

const TFormula *&	getReference ()
	Get rereference to internal pointer. More...

virtual bool	equals (const JAbstractPointer &object) const
	Equals. More...

bool	is_valid () const
	Check validity of pointer. More...

const TFormula *	operator-> () const
	Smart pointer operator. More...

	operator const TFormula * () const
	Type conversion operator. More...

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

Protected Attributes
const TFormula *	__p
	pointer to object More...

Friends
std::istream &	operator>> (std::istream &in, JEnergyCorrection &object)
	Read energy correction from input. More...

std::ostream &	operator<< (std::ostream &out, const JEnergyCorrection &object)
	Write energy correction to output. More...

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 39 of file JEnergyCorrection.hh.

Constructor & Destructor Documentation

◆ JEnergyCorrection() [1/3]

JFIT::JEnergyCorrection::JEnergyCorrection ( )

inline

Default constructor.

No correction is applied to the energy.

Definition at line 47 of file JEnergyCorrection.hh.

48 {}

◆ JEnergyCorrection() [2/3]

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

inline

Constructor.

Parameters

formula formula

Definition at line 56 of file JEnergyCorrection.hh.

     {
       setFormula(formula);
     }

◆ JEnergyCorrection() [3/3]

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

inline

Constructor.

Parameters

fcn	pointer to ROOT formula

Definition at line 67 of file JEnergyCorrection.hh.

                                            :
       JPointer<const TFormula>(fcn)
     {}

Member Function Documentation

◆ getFormula()

TString JFIT::JEnergyCorrection::getFormula ( ) const

inline

Get formula.

Returns: formula

Definition at line 77 of file JEnergyCorrection.hh.

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

◆ setFormula()

void JFIT::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 96 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 JFIT::JEnergyCorrection::operator() ( const double E ) const

inline

Get corrected energy.

Parameters

E	energy [GeV]

Returns: corrected energy [GeV]

Definition at line 121 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* JFIT::JEnergyCorrection::getName ( )

inlinestatic

Get name of energy correction formula.

Returns: name of formula

Definition at line 139 of file JEnergyCorrection.hh.

     {
       return "energy_correction";
     }

◆ load()

void JFIT::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 157 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()) {
  
           in.GetObject(JEnergyCorrection::getName(), getReference());
       
           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 JFIT::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 221 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.");
         }
       }
     }

◆ get()

virtual const TFormula * JLANG::JPointer< const TFormula >::get ( ) const

inlinevirtualinherited

Get pointer.

Returns: pointer to object

Implements JLANG::JAbstractPointer< const TFormula >.

Definition at line 64 of file JPointer.hh.

     {
       return this->__p;
     }

◆ set() [1/2]

virtual void JLANG::JPointer< const TFormula >::set ( const TFormula * p )

inlinevirtualinherited

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< const TFormula >.

Definition at line 75 of file JPointer.hh.

     {
       this->__p = p;
     }

◆ set() [2/2]

void JLANG::JPointer< const TFormula >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer pointer to object

Definition at line 96 of file JPointer.hh.

     {
       this->set(pointer.get());
     }

◆ reset() [1/3]

virtual void JLANG::JPointer< const TFormula >::reset ( )

inlinevirtualinherited

Reset pointer.

Implements JLANG::JAbstractPointer< const TFormula >.

Definition at line 84 of file JPointer.hh.

     { 
       this->__p = NULL;
     }

◆ reset() [2/3]

void JLANG::JPointer< const TFormula >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

     {
       this->reset(pointer.get());
     }

◆ reset() [3/3]

void JLANG::JAbstractPointer< const TFormula >::reset ( const TFormula * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

     {
       if (this->get() != p) {
  
         this->reset();
  
         if (p != NULL) {
           this->set(p);
         }
       }
     }

◆ getReference() [1/2]

const TFormula * const& JLANG::JPointer< const TFormula >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 119 of file JPointer.hh.

     {
       return __p;
     }

◆ getReference() [2/2]

const TFormula * & JLANG::JPointer< const TFormula >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 130 of file JPointer.hh.

     {
       return __p;
     }

◆ equals()

virtual bool JLANG::JAbstractPointer< const TFormula >::equals ( const JAbstractPointer< const TFormula > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object abstract pointer

Returns: true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

     {
       return this->get() == object.get();
     }

◆ is_valid()

bool JLANG::JAbstractPointer< const TFormula >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns: true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

     { 
       return this->get() != NULL; 
     }

◆ operator->()

const TFormula * JLANG::JAbstractPointer< const TFormula >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 112 of file JAbstractPointer.hh.

     { 
       if (!is_valid())
         throw JNullPointerException("JAbstractPointer::operator->()");
       else
         return this->get();
     }

◆ operator const TFormula *()

JLANG::JAbstractPointer< const TFormula >::operator const TFormula * ( ) const

inlineinherited

Type conversion operator.

Returns: pointer to object

Definition at line 126 of file JAbstractPointer.hh.

     {
       return this->get();
     }

Friends And Related Function 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 266 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 285 of file JEnergyCorrection.hh.

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

Member Data Documentation

◆ __p

const TFormula * JLANG::JPointer< const TFormula >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

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

JEnergyCorrection.hh

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JEnergyCorrection() [1/3]

◆ JEnergyCorrection() [2/3]

◆ JEnergyCorrection() [3/3]

Member Function Documentation

◆ getFormula()

◆ setFormula()

◆ operator()()

◆ getName()

◆ load()

◆ store()

◆ get()

◆ set() [1/2]

◆ set() [2/2]

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator const TFormula *()

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ __p