scaleFunctionBase< T > Class Template Reference

#include <Functions.h>

Inheritance diagram for scaleFunctionBase< T >:

Public Member Functions
virtual int	parNum () const
virtual int	parNum () const
virtual void	resetParameters (std::vector< double > *scaleVec) const
	This method is used to reset the scale parameters to neutral values (useful for iterations > 0) More...
virtual double	scale (const double &pt, const double &eta, const double &phi, const int chg, const T &parScale) const =0
virtual double	scale (const double &pt, const double &eta, const double &phi, const int chg, const T &parScale) const =0
virtual void	setParameters (double *Start, double *Step, double *Mini, double *Maxi, int *ind, TString *parname, const T &parResol, const std::vector< int > &parResolOrder, const std::vector< double > &parStep, const std::vector< double > &parMin, const std::vector< double > &parMax, const int muonType)
virtual void	setParameters (double *Start, double *Step, double *Mini, double *Maxi, int *ind, TString *parname, const T &parScale, const std::vector< int > &parScaleOrder, const int muonType)=0
	This method is used to differentiate parameters among the different functions. More...
virtual	~scaleFunctionBase ()=0
virtual	~scaleFunctionBase ()=0

Protected Member Functions
virtual void	setPar (double *Start, double *Step, double *Mini, double *Maxi, int *ind, TString *parname, const T &parResol, const std::vector< int > &parResolOrder, const std::vector< ParameterSet > &parSet)
virtual void	setPar (double *Start, double *Step, double *Mini, double *Maxi, int *ind, TString *parname, const T &parResol, const std::vector< int > &parResolOrder, const std::vector< ParSet > &parSet)
virtual void	setPar (double *Start, double *Step, double *Mini, double *Maxi, int *ind, TString *parname, const T &parScale, const std::vector< int > &parScaleOrder, double *thisStep, double *thisMini, double *thisMaxi, TString *thisParName)
	This method sets the parameters. More...

Protected Attributes
int	parNum_

Detailed Description

template<class T>
class scaleFunctionBase< T >

The correct functor is selected at job start in the constructor. The pt value is taken by reference and modified internally. eta, phi and chg are taken by const reference.
Made into a template so that it can be used with arrays too (parval for the scale fit is an array, because Lykelihood is an extern C function, because TMinuit asks it).
Note that in the array case it takes the pointer by const reference, thus the elements of the array are modifiable.

Definition at line 40 of file Functions.h.

Constructor & Destructor Documentation

~scaleFunctionBase() [1/2]

template<class T >

scaleFunctionBase< T >::~scaleFunctionBase ( )

inlinepure virtual

Definition at line 132 of file Functions.h.

                                                {
}  // defined even though it's pure virtual; should be faster this way.

~scaleFunctionBase() [2/2]

template<class T>

virtual scaleFunctionBase< T >::~scaleFunctionBase ( )

pure virtual

Member Function Documentation

parNum() [1/2]

template<class T>

virtual int scaleFunctionBase< T >::parNum ( ) const

inlinevirtual

Definition at line 44 of file MuScleFitCorrector_Functions.h.

{ return parNum_; }

parNum() [2/2]

template<class T>

virtual int scaleFunctionBase< T >::parNum ( ) const

inlinevirtual

Definition at line 76 of file Functions.h.

{ return parNum_; }

Referenced by heppy::MuScleFitCorrector::convertToArrays(), MuScleFitUtils::minimizeLikelihood(), and heppy::MuScleFitCorrector::readParameters().

resetParameters()

template<class T>

virtual void scaleFunctionBase< T >::resetParameters ( std::vector< double > *  scaleVec ) const

inlinevirtual

This method is used to reset the scale parameters to neutral values (useful for iterations > 0)

Reimplemented in scaleFunctionType64< T >, scaleFunctionType50< T >, and scaleFunctionType0< T >.

Definition at line 46 of file Functions.h.

                                                                  {
    std::cout << "ERROR: the resetParameters method must be defined in each scale function" << std::endl;
    std::cout << "Please add it to the scaleFunction you are using" << std::endl;
    exit(1);
  }

Referenced by MuScleFitUtils::minimizeLikelihood().

scale() [1/2]

template<class T>

virtual double scaleFunctionBase< T >::scale ( const double &  pt, const double &  eta, const double &  phi, const int  chg, const T &  parScale  ) const

pure virtual

Implemented in scaleFunctionType64< T >, scaleFunctionType50< T >, scaleFunctionType0< T >, and scaleFunction50< T >.

scale() [2/2]

template<class T>

virtual double scaleFunctionBase< T >::scale ( const double &  pt, const double &  eta, const double &  phi, const int  chg, const T &  parScale  ) const

pure virtual

Implemented in scaleFunctionType64< T >, scaleFunctionType50< T >, scaleFunctionType0< T >, and scaleFunction50< T >.

Referenced by MuScleFitUtils::applyBias(), MuScleFitUtils::applyScale(), MomentumScaleCorrector::correct(), heppy::MuScleFitCorrector::getCorrectPt(), and MomentumScaleCorrector::operator()().

setPar() [1/3]

template<class T>

virtual void scaleFunctionBase< T >::setPar ( double *  Start, double *  Step, double *  Mini, double *  Maxi, int *  ind, TString *  parname, const T &  parResol, const std::vector< int > &  parResolOrder, const std::vector< ParameterSet > &  parSet  )

inlineprotectedvirtual

Definition at line 102 of file Functions.h.

                                                             {
    if (int(parSet.size()) != this->parNum_) {
      std::cout << "Error: wrong number of parameter initializations = " << parSet.size()
                << ". Number of parameters is " << this->parNum_ << std::endl;
      exit(1);
    }
    for (int iPar = 0; iPar < this->parNum_; ++iPar) {
      Start[iPar] = parResol[iPar];
      Step[iPar] = parSet[iPar].step;
      Mini[iPar] = parSet[iPar].mini;
      Maxi[iPar] = parSet[iPar].maxi;
      ind[iPar] = parResolOrder[iPar];
      parname[iPar] = parSet[iPar].name;
    }
  }

setPar() [2/3]

template<class T>

virtual void scaleFunctionBase< T >::setPar ( double *  Start, double *  Step, double *  Mini, double *  Maxi, int *  ind, TString *  parname, const T &  parResol, const std::vector< int > &  parResolOrder, const std::vector< ParSet > &  parSet  )

inlineprotectedvirtual

Definition at line 48 of file MuScleFitCorrector_Functions.h.

                                                       {
    if (int(parSet.size()) != this->parNum_) {
      std::cout << "Error: wrong number of parameter initializations = " << parSet.size()
                << ". Number of parameters is " << this->parNum_ << std::endl;
      exit(1);
    }
    for (int iPar = 0; iPar < this->parNum_; ++iPar) {
      Start[iPar] = parResol[iPar];
      Step[iPar] = parSet[iPar].step;
      Mini[iPar] = parSet[iPar].mini;
      Maxi[iPar] = parSet[iPar].maxi;
      ind[iPar] = parResolOrder[iPar];
      parname[iPar] = parSet[iPar].name;
    }
  }

setPar() [3/3]

template<class T>

virtual void scaleFunctionBase< T >::setPar ( double *  Start, double *  Step, double *  Mini, double *  Maxi, int *  ind, TString *  parname, const T &  parScale, const std::vector< int > &  parScaleOrder, double *  thisStep, double *  thisMini, double *  thisMaxi, TString *  thisParName  )

inlineprotectedvirtual

This method sets the parameters.

Definition at line 81 of file Functions.h.

                                            {
    for (int iPar = 0; iPar < this->parNum_; ++iPar) {
      Start[iPar] = parScale[iPar];
      Step[iPar] = thisStep[iPar];
      Mini[iPar] = thisMini[iPar];
      Maxi[iPar] = thisMaxi[iPar];
      ind[iPar] = parScaleOrder[iPar];
      parname[iPar] = thisParName[iPar];
    }
  }

Referenced by scaleFunctionType50< T >::setParameters(), and scaleFunctionType64< T >::setParameters().

setParameters() [1/2]

template<class T>

virtual void scaleFunctionBase< T >::setParameters ( double *  Start, double *  Step, double *  Mini, double *  Maxi, int *  ind, TString *  parname, const T &  parResol, const std::vector< int > &  parResolOrder, const std::vector< double > &  parStep, const std::vector< double > &  parMin, const std::vector< double > &  parMax, const int  muonType  )

inlinevirtual

Reimplemented in scaleFunctionType64< T >, and scaleFunctionType50< T >.

Definition at line 61 of file Functions.h.

                                                 {
    std::cout << "The method setParameters must be implemented for this scale function" << std::endl;
    exit(1);
  }

setParameters() [2/2]

template<class T>

virtual void scaleFunctionBase< T >::setParameters ( double *  Start, double *  Step, double *  Mini, double *  Maxi, int *  ind, TString *  parname, const T &  parScale, const std::vector< int > &  parScaleOrder, const int  muonType  )

pure virtual

This method is used to differentiate parameters among the different functions.

Implemented in scaleFunctionType64< T >, scaleFunctionType50< T >, and scaleFunctionType0< T >.

Referenced by MuScleFitUtils::minimizeLikelihood().

Member Data Documentation

parNum_

template<class T>

int scaleFunctionBase< T >::parNum_

protected

Definition at line 79 of file Functions.h.

Referenced by scaleFunctionBase< std::vector< double > >::parNum(), scaleFunctionType50< T >::resetParameters(), scaleFunctionType64< T >::resetParameters(), scaleFunction50< T >::scaleFunction50(), scaleFunctionType0< T >::scaleFunctionType0(), scaleFunctionType50< T >::scaleFunctionType50(), scaleFunctionType64< T >::scaleFunctionType64(), scaleFunctionBase< std::vector< double > >::setPar(), scaleFunctionType50< T >::setParameters(), and scaleFunctionType64< T >::setParameters().