pftools::CalibrationResultWrapper Class Reference

A small class designed to hold the result of a calibration of a SingleParticleWrapper. More...

#include <CalibrationResultWrapper.h>

Public Member Functions
double	bias () const
	CalibrationResultWrapper ()
void	compute ()
double	ratio () const
void	reset ()
virtual	~CalibrationResultWrapper ()

Public Attributes
double	a_
double	b_
double	bias_
double	c_
double	ecalEnergy_
double	hcalEnergy_
double	particleEnergy_
CalibrationProvenance	provenance_
double	ratio_
CalibrationTarget	target_
double	targetFuncContrib_
double	truthEnergy_

Private Member Functions
virtual void	computeCore ()
virtual void	resetCore ()

Detailed Description

A small class designed to hold the result of a calibration of a SingleParticleWrapper.

Author

Jamie Ballin

Date

May 2008

Definition at line 18 of file CalibrationResultWrapper.h.

Constructor & Destructor Documentation

pftools::CalibrationResultWrapper::CalibrationResultWrapper ( )

inline

Definition at line 24 of file CalibrationResultWrapper.h.

References reset().

                               {
        reset();
    }

virtual pftools::CalibrationResultWrapper::~CalibrationResultWrapper ( )

inlinevirtual

Definition at line 28 of file CalibrationResultWrapper.h.

                                        {
    }

Member Function Documentation

double pftools::CalibrationResultWrapper::bias ( ) const

inline

Definition at line 41 of file CalibrationResultWrapper.h.

References particleEnergy_, and truthEnergy_.

Referenced by computeCore().

                        {
        return (particleEnergy_ -  truthEnergy_) / truthEnergy_;
    }

void pftools::CalibrationResultWrapper::compute ( )

inline

Definition at line 37 of file CalibrationResultWrapper.h.

References computeCore().

                   {
        computeCore();
    }

virtual void pftools::CalibrationResultWrapper::computeCore ( )

inlineprivatevirtual

Definition at line 99 of file CalibrationResultWrapper.h.

References bias(), and ratio().

Referenced by compute().

                               {
        bias_ = bias();
        ratio_ = ratio();
    }

double pftools::CalibrationResultWrapper::ratio ( ) const

inline

Definition at line 45 of file CalibrationResultWrapper.h.

References particleEnergy_, and truthEnergy_.

Referenced by computeCore().

                         {
        return(particleEnergy_/truthEnergy_);
    }

void pftools::CalibrationResultWrapper::reset ( void  )

inline

Definition at line 32 of file CalibrationResultWrapper.h.

References resetCore().

Referenced by CalibrationResultWrapper().

                 {
        resetCore();
    }

virtual void pftools::CalibrationResultWrapper::resetCore ( )

inlineprivatevirtual

Definition at line 104 of file CalibrationResultWrapper.h.

References pftools::UNCALIBRATED, and pftools::UNDEFINED.

Referenced by reset().

                             {
        truthEnergy_ = 0;
        ecalEnergy_ = 0;
        hcalEnergy_ = 0;
        particleEnergy_ = 0;
        provenance_ = UNCALIBRATED;
        target_ = UNDEFINED;
        bias_ = 0;
        ratio_ = 1.0;
        targetFuncContrib_ = 0;
        a_ = 0.0;
        b_ = 1.0;
        c_ = 1.0;
    }

Member Data Documentation

double pftools::CalibrationResultWrapper::a_

Definition at line 93 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::b_

Definition at line 94 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::bias_

Definition at line 81 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::c_

Definition at line 95 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::ecalEnergy_

Definition at line 61 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::hcalEnergy_

Definition at line 66 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::particleEnergy_

Definition at line 71 of file CalibrationResultWrapper.h.

Referenced by bias(), and ratio().

CalibrationProvenance pftools::CalibrationResultWrapper::provenance_

Definition at line 52 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::ratio_

Definition at line 86 of file CalibrationResultWrapper.h.

CalibrationTarget pftools::CalibrationResultWrapper::target_

Definition at line 76 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::targetFuncContrib_

Definition at line 91 of file CalibrationResultWrapper.h.

double pftools::CalibrationResultWrapper::truthEnergy_

Definition at line 56 of file CalibrationResultWrapper.h.

Referenced by bias(), and ratio().