JFIT::JEnergyCorrection Class Reference

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

#include <JEnergyCorrection.hh>

Inheritance diagram for JFIT::JEnergyCorrection:

Public Types
typedef JPointer< JClass_t >	pointer_type
typedef JStorage< JClass_t, JMemory_t >	storage_type
typedef JNew< JClass_t >	memory_type

Public Member Functions
	JEnergyCorrection ()
	Default constructor.
	JEnergyCorrection (const std::string &formula)
	Constructor.
	JEnergyCorrection (const TFormula *fcn)
	Constructor.
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.
const JSharedPointer &	getSharedPointer () const
	Get shared pointer.
JSharedPointer &	getSharedPointer ()
	Get shared pointer.
void	setSharedPointer (const JSharedPointer &object)
	Set shared pointer.
virtual void	reset () override
	Reset pointer.
void	reset (const JPointer< T > &pointer)
	Reset pointer.
void	reset (JClass_t *p)
	Reset pointer.
template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer.
void	initialise ()
	Initialise counter.
void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object.
bool	detach ()
	Detach.
const int	getCount ()
	Get count.
void	recreate ()
	Recreate object in memory.
void	create ()
	Create object in memory.
void	create (const unsigned int size)
	Create array of objects in memory.
virtual JClass_t *	get () const override
	Get pointer.
JClass_t *const &	getReference () const
	Get rereference to internal pointer.
JClass_t *&	getReference ()
	Get rereference to internal pointer.
virtual bool	equals (const JAbstractPointer &object) const
	Equals.
bool	is_valid () const
	Check validity of pointer.
JClass_t *	operator-> () const
	Smart pointer operator.
	operator JClass_t * () const
	Type conversion operator.

Static Public Member Functions
static const char *	getName ()
	Get name of energy correction formula.
static void	release (JClass_t *p)
	Release memory.

Protected Member Functions
void	set (const JSharedPointer &object)
	Set pointer.
virtual void	set (JClass_t *p) override
	Set pointer.
void	release ()
	Release memory.

Protected Attributes
int *	counter
JClass_t *	__p
	pointer to object

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

Member Typedef Documentation

pointer_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JPointer<JClass_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::pointer_type

inherited

Definition at line 34 of file JSharedPointer.hh.

storage_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JStorage<JClass_t, JMemory_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::storage_type

inherited

Definition at line 35 of file JSharedPointer.hh.

memory_type

JNew<JClass_t> JLANG::JStorage< JClass_t, JNew >::memory_type

inherited

Definition at line 33 of file JStorage.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.

    {}

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.

                                           :
      JSharedPointer<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.");
        }
      }
    }

getSharedPointer() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

const JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( ) const

inlineinherited

Get shared pointer.

Returns

this shared pointer

Definition at line 95 of file JSharedPointer.hh.

    {
      return static_cast<const JSharedPointer&>(*this);
    }

getSharedPointer() [2/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( )

inlineinherited

Get shared pointer.

Returns

this shared pointer

Definition at line 106 of file JSharedPointer.hh.

    {
      return static_cast<JSharedPointer&>(*this);
    }

setSharedPointer()

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::setSharedPointer ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineinherited

Set shared pointer.

Parameters

object

shared pointer

Definition at line 117 of file JSharedPointer.hh.

    {
      if (this->get() != object.get()) {
 
        this->reset();
 
        if (object.is_valid()) {
          this->set(object);
        }
      }
    }

reset() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::reset ( )

inlineoverridevirtualinherited

Reset pointer.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero.

Reimplemented from JLANG::JStorage< JClass_t, JNew >.

Definition at line 171 of file JSharedPointer.hh.

    {
      if (this->detach()) {
        storage_type::reset();
      }
 
      pointer_type::reset();
    }

reset() [2/3]

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

inlineinherited

Reset pointer.

Parameters

pointer

pointer to object

Definition at line 35 of file JPointer.hh.

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

reset() [3/3]

template<class JClass_t >

void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t * 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);
        }
      }
    }

set() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineprotectedinherited

Set pointer.

The reference counter of the shared object pointed to is incremented by one.

Parameters

object

shared pointer

Definition at line 188 of file JSharedPointer.hh.

    {
      pointer_type::set(object.get());
 
      this->attach(object);
    }

set() [2/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( JClass_t * p )

inlineoverrideprotectedvirtualinherited

Set pointer.

The reference counter of the shared object pointed to is initialised to one.

Parameters

p	pointer to derived class object

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 202 of file JSharedPointer.hh.

    {
      pointer_type::set(p);
 
      this->initialise();
    }

set() [3/3]

template<class JClass_t >

template<class T >

void JLANG::JPointer< JClass_t >::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());
    }

initialise()

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();
 
      counter = new int(1);
    }

attach()

void JLANG::JSharedCounter::attach ( const JSharedCounter & object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object

shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();
 
      counter = object.counter;
 
      if (counter != NULL) {
        ++(*counter);
      }
    }

detach()

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns

true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {
 
        if (--(*counter) == 0) {
 
          delete counter;
 
          counter = NULL;
 
          return true;
        }
 
        counter = NULL;
      }
 
      return false;
    }

getCount()

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns

count

Definition at line 88 of file JSharedCounter.hh.

    {
      return (counter != NULL ? *counter : 0);
    }

recreate()

void JLANG::JStorage< JClass_t, JNew >::recreate ( )

inlineinherited

Recreate object in memory.

A new object is created if no memory is allocated yet, else the previously created object is maintained.

Definition at line 57 of file JStorage.hh.

    {
      if (!this->is_valid()) {
        this->set(memory_type::create());
      }
    }

create() [1/2]

void JLANG::JStorage< JClass_t, JNew >::create ( )

inlineinherited

Create object in memory.

The memory allocated by a previously created object will be released.

Definition at line 69 of file JStorage.hh.

    {
      this->reset(memory_type::create());
    }

create() [2/2]

void JLANG::JStorage< JClass_t, JNew >::create ( const unsigned int size )

inlineinherited

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters

size	number of elements

Definition at line 81 of file JStorage.hh.

    {
      this->reset(memory_type::create(size));
    }

release() [1/2]

void JLANG::JStorage< JClass_t, JNew >::release ( )

inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

    { 
      memory_type::release(this->get());
    }

release() [2/2]

template<class JClass_t >

static void JLANG::JNew< JClass_t >::release ( JClass_t * p )

inlinestaticinherited

Release memory.

Parameters

p	pointer to data

Definition at line 41 of file JMemory.hh.

    {
      delete p;
    }

get()

template<class JClass_t >

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

inlineoverridevirtualinherited

Get pointer.

Returns

pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JTypeList< JDAQEvent, JNullType > >, JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >, and JLANG::JMultiPointer< T >.

Definition at line 64 of file JPointer.hh.

    {
      return this->__p;
    }

getReference() [1/2]

template<class JClass_t >

JClass_t *const & JLANG::JPointer< JClass_t >::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]

template<class JClass_t >

JClass_t *& JLANG::JPointer< JClass_t >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns

reference to internal pointer

Definition at line 130 of file JPointer.hh.

    {
      return __p;
    }

equals()

template<class JClass_t >

virtual bool JLANG::JAbstractPointer< JClass_t >::equals ( const JAbstractPointer< JClass_t > & 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()

template<class JClass_t >

bool JLANG::JAbstractPointer< JClass_t >::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->()

template<class JClass_t >

JClass_t * JLANG::JAbstractPointer< JClass_t >::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 JClass_t *()

template<class JClass_t >

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

inlineinherited

Type conversion operator.

Returns

pointer to object

Definition at line 126 of file JAbstractPointer.hh.

    {
      return this->get();
    }

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 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

counter

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

__p

template<class JClass_t >

JClass_t* JLANG::JPointer< JClass_t >::__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