RooFunctorBinding.cxx

Go to the documentation of this file.

/*****************************************************************************
 * Project: RooFit                                                           *
 * Package: RooFitCore                                                       *
 *    File: $Id$
 * Authors:                                                                  *
 *   WV, Wouter Verkerke, NIKHEF, verkerke@nikhef.nl                         *
 *                                                                           *
 * Copyright (c) 2000-2008, NIKHEF, Regents of the University of California  *
 *                          and Stanford University. All rights reserved.    *
 *                                                                           *
 *****************************************************************************/
 
/** \class RooFunctorBinding
    \ingroup Roofit
 
RooFunctorBinding makes math functions from ROOT usable in RooFit. It takes
a ROOT::Math::IBaseFunctionMultiDim, and binds the variables of this function to
the RooFit variables passed in the constructor.
 
Instances of function binding
classes are fully functional RooFit function objects with one exception:
if the bound function is *not* a standard TMath or MathMore function the
class cannot be persisted in a RooWorkspace without registering the function
pointer first using RooCFunction1Binding<T1,T2>::register().
**/
 
/** \class RooFunctorPdfBinding
    \ingroup Roofit
RooFunctorPdfBinding makes math functions from ROOT usable as PDFs in RooFit. It takes
a ROOT::Math::IBaseFunctionMultiDim, and binds the variables of this function to
the RooFit variables passed in the constructor.
When the PDF is evaluated, the bound function is evaluated, and also integrated numerically
to normalise it to unity over the range of its observables.
 
Instances of function binding
classes are fully functional RooFit function objects with one exception:
if the bound function is *not* a standard TMath or MathMore function the
class cannot be persisted in a RooWorkspace without registering the function
pointer first using RooCFunction1Binding<T1,T2>::register().
**/
 
#include "Riostream.h"
#include "RooFunctorBinding.h"
 
using std::endl, std::ostream, std::string;
 
 
////////////////////////////////////////////////////////////////////////////////
/// Create a RooFit function that makes `ftor` usable in RooFit.
/// \param name Name of the object.
/// \param title Title (e.g. for plotting)
/// \param ftor Functor instance to be evaluated.
/// \param v RooFit variables to be passed to the function.
RooFunctorBinding::RooFunctorBinding(const char *name, const char *title, const ROOT::Math::IBaseFunctionMultiDim& ftor, const RooArgList& v) :
  RooAbsReal(name,title),
  func(&ftor),
  vars("vars","vars",this)
{
  // Check that function dimension and number of variables match
  if (ftor.NDim()!=UInt_t(v.size())) {
    coutE(InputArguments) << "RooFunctorBinding::ctor(" << GetName() << ") ERROR number of provided variables (" << v.size()
           << ") does not match dimensionality of function (" << ftor.NDim() << ")" << std::endl ;
    throw string("RooFunctor::ctor ERROR") ;
  }
  x = new double[func->NDim()] ;
  vars.add(v) ;
}
 
////////////////////////////////////////////////////////////////////////////////
RooFunctorBinding::RooFunctorBinding(const RooFunctorBinding &other, const char *name)
   : RooAbsReal(other, name), func(other.func), vars("vars", this, other.vars), x(new double[func->NDim()])
{
  // Copy constructor
}
 
////////////////////////////////////////////////////////////////////////////////
void RooFunctorBinding::printArgs(ostream& os) const {
  // Print object arguments and name/address of function pointer
  os << "[ function=" << func << " " ;
  for (Int_t i=0 ; i<numProxies() ; i++) {
    RooAbsProxy* p = getProxy(i) ;
    if (!TString(p->name()).BeginsWith("!")) {
      p->print(os) ;
      os << " " ;
    }
  }
  os << "]" ;
}
 
////////////////////////////////////////////////////////////////////////////////
double RooFunctorBinding::evaluate() const {
    // Return value of embedded function using value of referenced variable x
    for (std::size_t i=0 ; i<vars.size() ; i++) {
      x[i] = static_cast<RooAbsReal*>(vars.at(i))->getVal();
    }
    return (*func)(x) ;
}
 
 
////////////////////////////////////////////////////////////////////////////////
/// Create a RooFit PDF that makes `ftor` usable as a PDF in RooFit.
/// \param name Name of the object.
/// \param title Title (e.g. for plotting)
/// \param ftor Functor instance to be evaluated and normalised.
/// \param v RooFit variables to be passed to the function.
RooFunctorPdfBinding::RooFunctorPdfBinding(const char *name, const char *title, const ROOT::Math::IBaseFunctionMultiDim& ftor, const RooArgList& v) :
  RooAbsPdf(name,title),
  func(&ftor),
  vars("vars","vars",this)
{
  // Check that function dimension and number of variables match
  if (ftor.NDim()!=UInt_t(v.size())) {
    coutE(InputArguments) << "RooFunctorPdfBinding::ctor(" << GetName() << ") ERROR number of provided variables (" << v.size()
           << ") does not match dimensionality of function (" << ftor.NDim() << ")" << std::endl ;
    throw string("RooFunctor::ctor ERROR") ;
  }
  x = new double[func->NDim()] ;
  vars.add(v) ;
}
 
////////////////////////////////////////////////////////////////////////////////
RooFunctorPdfBinding::RooFunctorPdfBinding(const RooFunctorPdfBinding &other, const char *name)
   : RooAbsPdf(other, name), func(other.func), vars("vars", this, other.vars), x(new double[func->NDim()])
{
  // Copy constructor
}
 
////////////////////////////////////////////////////////////////////////////////
void RooFunctorPdfBinding::printArgs(ostream& os) const {
  // Print object arguments and name/address of function pointer
  os << "[ function=" << func << " " ;
  for (Int_t i=0 ; i<numProxies() ; i++) {
    RooAbsProxy* p = getProxy(i) ;
    if (!TString(p->name()).BeginsWith("!")) {
      p->print(os) ;
      os << " " ;
    }
  }
  os << "]" ;
}
 
////////////////////////////////////////////////////////////////////////////////
double RooFunctorPdfBinding::evaluate() const {
    // Return value of embedded function using value of referenced variable x
    for (std::size_t i=0 ; i<vars.size() ; i++) {
      x[i] = static_cast<RooAbsReal*>(vars.at(i))->getVal();
    }
    return (*func)(x) ;
  }
 
namespace RooFit {
 
  RooAbsReal* bindFunction(const char* name, const ROOT::Math::IBaseFunctionMultiDim& ftor,const RooArgList& vars) {
    return new RooFunctorBinding(name,name,ftor,vars) ;
  }
 
  RooAbsPdf*  bindPdf(const char* name, const ROOT::Math::IBaseFunctionMultiDim& ftor, const RooArgList& vars) {
    return new RooFunctorPdfBinding(name,name,ftor,vars) ;
  }
 
}