JFIT::JShowerEnergyCorrection Class Reference

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

#include <JShowerEnergyCorrection.hh>

Inheritance diagram for JFIT::JShowerEnergyCorrection:

Public Member Functions
	JShowerEnergyCorrection ()
	Default constructor.
	JShowerEnergyCorrection (const std::string &formula)
	Constructor.
	JShowerEnergyCorrection (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.
virtual JClass_t *	get () const override
	Get pointer.
virtual void	set (JClass_t *p) override
	Set pointer.
template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer.
virtual void	reset () override
	Reset pointer.
template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer.
void	reset (JClass_t *p)
	Reset 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.

Protected Attributes
JClass_t *	__p
	pointer to object

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

Detailed Description

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

Definition at line 38 of file JShowerEnergyCorrection.hh.

Constructor & Destructor Documentation

JShowerEnergyCorrection() [1/3]

JFIT::JShowerEnergyCorrection::JShowerEnergyCorrection ( )

inline

Default constructor.

No correction is applied to the energy.

Definition at line 46 of file JShowerEnergyCorrection.hh.

    {}

JShowerEnergyCorrection() [2/3]

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

inline

Constructor.

Parameters

formula

formula

Definition at line 55 of file JShowerEnergyCorrection.hh.

    {
      setFormula(formula);
    }

JShowerEnergyCorrection() [3/3]

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

inline

Constructor.

Parameters

fcn	pointer to ROOT formula

Definition at line 66 of file JShowerEnergyCorrection.hh.

                                                 :
      JPointer<const TFormula>(fcn)
    {}

Member Function Documentation

getFormula()

TString JFIT::JShowerEnergyCorrection::getFormula ( ) const

inline

Get formula.

Returns

formula

Definition at line 76 of file JShowerEnergyCorrection.hh.

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

setFormula()

void JFIT::JShowerEnergyCorrection::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 95 of file JShowerEnergyCorrection.hh.

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

operator()()

double JFIT::JShowerEnergyCorrection::operator() ( const double E ) const

inline

Get corrected energy.

Parameters

E	energy [GeV]

Returns

corrected energy [GeV]

Definition at line 120 of file JShowerEnergyCorrection.hh.

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

getName()

static const char * JFIT::JShowerEnergyCorrection::getName ( )

inlinestatic

Get name of energy correction formula.

Returns

name of formula

Definition at line 138 of file JShowerEnergyCorrection.hh.

    {
      return "energy_correction";
    }

load()

void JFIT::JShowerEnergyCorrection::load ( const char * file_name )

inline

Load formula from file.

Supported file formats:

• ROOT file (extension .root) containing TFormula object with name JShowerEnergyCorrection::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 156 of file JShowerEnergyCorrection.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(JShowerEnergyCorrection::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(JShowerEnergyCorrection::getName(), buffer));
 
        } else {
          
          THROW(JFileOpenException, "Error opening file " << buffer);
        }
 
      } else {
 
        THROW(JProtocolException, "Protocol not defined.");
      }
    }

store()

void JFIT::JShowerEnergyCorrection::store ( const char * file_name )

inline

Store formula to file.

Supported file formats:

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

Parameters

file_name

file name

Definition at line 220 of file JShowerEnergyCorrection.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(), JShowerEnergyCorrection::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()

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

set() [1/2]

template<class JClass_t >

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

inlineoverridevirtualinherited

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< Evt > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > > >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JRadiation >, JLANG::JSharedPointer< JRewindableObjectIterator< const event_type > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JTRIGGER::JMatch >, and JLANG::JSharedPointer< match_type >.

Definition at line 75 of file JPointer.hh.

    {
      this->__p = p;
    }

set() [2/2]

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());
    }

reset() [1/3]

template<class JClass_t >

virtual void JLANG::JPointer< JClass_t >::reset ( )

inlineoverridevirtualinherited

Reset pointer.

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< Evt > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > > >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JRadiation >, JLANG::JSharedPointer< JRewindableObjectIterator< const event_type > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JTRIGGER::JMatch >, JLANG::JSharedPointer< match_type >, JLANG::JStorage< JClass_t, JMemory_t >, JLANG::JStorage< JAbstractAutoPointer< JBase_t >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< Evt >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JDAQSummaryslice >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JHead_t >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JTail_t >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >, JLANG::JStorage< JAccessibleObjectOutput< T >, JNew >, JLANG::JStorage< JBase_t, JNew >, JLANG::JStorage< JClass_t, JNew >, JLANG::JStorage< JDETECTOR::JCLBDefaultSimulatorInterface::JStateMachine, JNew >, JLANG::JStorage< JDETECTOR::JCLBDefaultSimulatorInterface::JTDC, JNew >, JLANG::JStorage< JDETECTOR::JCLBSimulator, JNew >, JLANG::JStorage< JDETECTOR::JK40Simulator, JNew >, JLANG::JStorage< JDETECTOR::JModuleRouter, JNew >, JLANG::JStorage< JDETECTOR::JPMTSimulator, JNew >, JLANG::JStorage< JFIT::JMEstimator, JNew >, JLANG::JStorage< JIO::JReader, JNew >, JLANG::JStorage< JIO::JWriter, JNew >, JLANG::JStorage< JLANG::JMultiPipe< T, N >, JNew >, JLANG::JStorage< JLOGGER::JLogger, JNew >, JLANG::JStorage< JNET::JControlHost, JNew >, JLANG::JStorage< JNET::JControlHostObjectOutput, JNew >, JLANG::JStorage< JNET::JServerSocket, JNew >, JLANG::JStorage< JObjectIterator< T >, JNew >, JLANG::JStorage< JObjectOutput< JHead_t >, JNew >, JLANG::JStorage< JObjectOutput< JTail_t >, JNew >, JLANG::JStorage< JObjectOutput< T >, JNew >, JLANG::JStorage< JParserElementInterface, JNew >, JLANG::JStorage< JPropertiesElementInterface, JNew >, JLANG::JStorage< JRadiation, JNew >, JLANG::JStorage< JRewindableObjectIterator< const event_type >, JNew >, JLANG::JStorage< JRewindableObjectIterator< JHead_t >, JNew >, JLANG::JStorage< JRewindableObjectIterator< JTail_t >, JNew >, JLANG::JStorage< JRewindableObjectIterator< T >, JNew >, JLANG::JStorage< JTOOLS::JFunction1D, JNew >, JLANG::JStorage< JTOOLS::JMultiMapTransformer, JNew >, JLANG::JStorage< JTRIGGER::JBuildL1, JNew >, JLANG::JStorage< JTRIGGER::JBuildL2, JNew >, JLANG::JStorage< JTRIGGER::JDAQHitSelector, JNew >, JLANG::JStorage< JTRIGGER::JMatch, JNew >, JLANG::JStorage< JTRIGGER::JTimesliceRouter, JNew >, JLANG::JStorage< JTRIGGER::JTrigger3DMuon, JNew >, JLANG::JStorage< JTRIGGER::JTrigger3DShower, JNew >, JLANG::JStorage< JTRIGGER::JTriggerMXShower, JNew >, JLANG::JStorage< JTRIGGER::JTriggerNB, JNew >, JLANG::JStorage< match_type, JNew >, and JLANG::JStorage< TFile >.

Definition at line 84 of file JPointer.hh.

    { 
      this->__p = NULL;
    }

reset() [2/3]

template<class JClass_t >

template<class T >

void JLANG::JPointer< JClass_t >::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]

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);
        }
      }
    }

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, JShowerEnergyCorrection & 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 265 of file JShowerEnergyCorrection.hh.

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

operator<<

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

friend

Write energy correction to output.

Parameters

out	output stream
object	energy correction

Returns

output stream

Definition at line 284 of file JShowerEnergyCorrection.hh.

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

Member Data Documentation

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

• JShowerEnergyCorrection.hh