STEER/AliCheb3D.h

   1 // Author: ruben.shahoyan@cern.ch   09/09/2006
   2
   3 ////////////////////////////////////////////////////////////////////////////////
   4 //                                                                            //
   5 // AliCheb3D produces the interpolation of the user 3D->NDimOut arbitrary     //
   6 // function supplied in "void (*fcn)(float* inp,float* out)" format           //
   7 // either in a separate macro file or as a function pointer.                  //
   8 // Only coefficients needed to guarantee the requested precision are kept.    //
   9 //                                                                            //
  10 // The user-callable methods are:                                             //
  11 // To create the interpolation use:                                           //
  12 // AliCheb3D(const char* funName,  // name of the file with user function     //
  13 //          or                                                                //
  14 // AliCheb3D(void (*ptr)(float*,float*),// pointer on the  user function      //
  15 //        Int_t     DimOut,     // dimensionality of the function's output    //
  16 //        Float_t  *bmin,       // lower 3D bounds of interpolation domain    //
  17 //        Float_t  *bmax,       // upper 3D bounds of interpolation domain    //
  18 //        Int_t    *npoints,    // number of points in each of 3 input        //
  19 //                              // dimension, defining the interpolation grid //
  20 //        Float_t   prec=1E-6); // requested max.absolute difference between  //
  21 //                              // the interpolation and any point on grid    //
  22 //                                                                            //
  23 // To test obtained parameterization use the method                           //
  24 // TH1* TestRMS(int idim,int npoints = 1000,TH1* histo=0);                    //
  25 // it will compare the user output of the user function and interpolation     //
  26 // for idim-th output dimension and fill the difference in the supplied       //
  27 // histogram. If no histogram is supplied, it will be created.                //
  28 //                                                                            //
  29 // To save the interpolation data:                                            //
  30 // SaveData(const char* filename, Bool_t append )                             //
  31 // write text file with data. If append is kTRUE and the output file already  //
  32 // exists, data will be added in the end of the file.                         //
  33 // Alternatively, SaveData(FILE* stream) will write the data to               //
  34 // already existing stream.                                                   //
  35 //                                                                            //
  36 // To read back already stored interpolation use either the constructor       //
  37 // AliCheb3D(const char* inpFile);                                            //
  38 // or the default constructor AliCheb3D() followed by                         //
  39 // AliCheb3D::LoadData(const char* inpFile);                                  //
  40 //                                                                            //
  41 // To compute the interpolation use Eval(float* par,float *res) method, with  //
  42 // par being 3D vector of arguments (inside the validity region) and res is   //
  43 // the array of DimOut elements for the output.                               //
  44 //                                                                            //
  45 // If only one component (say, idim-th) of the output is needed, use faster   //
  46 // Float_t Eval(Float_t *par,int idim) method.                                //
  47 //                                                                            //
  48 // void Print(option="") will print the name, the ranges of validity and      //
  49 // the absolute precision of the parameterization. Option "l" will also print //
  50 // the information about the number of coefficients for each output           //
  51 // dimension.                                                                 //
  52 //                                                                            //
  53 // NOTE: during the evaluation no check is done for parameter vector being    //
  54 // outside the interpolation region. If there is such a risk, use             //
  55 // Bool_t IsInside(float *par) method. Chebyshev parameterization is not      //
  56 // good for extrapolation!                                                    //
  57 //                                                                            //
  58 // For the properties of Chebyshev parameterization see:                      //
  59 // H.Wind, CERN EP Internal Report, 81-12/Rev.                                //
  60 //                                                                            //
  61 ////////////////////////////////////////////////////////////////////////////////
  62
  63
  64 #ifndef _ALICHEB3D_
  65 #define _ALICHEB3D_
  66 #include <stdio.h>
  67 #include <TNamed.h>
  68 #include <TMethodCall.h>
  69 #include <TMath.h>
  70 #include <TH1.h>
  71 #include <TObjArray.h>
  72 #include "AliCheb3DCalc.h"
  73
  74 class TString;
  75 class TSystem;
  76 class TRandom;
  77
  78
  79 class AliCheb3D: public TNamed
  80 {
  81  public:
  82   AliCheb3D();
  83   AliCheb3D(const AliCheb3D& src);
  84   AliCheb3D(const char* inpFile);
  85   AliCheb3D(FILE* stream);
  86   //
  87 #ifdef _INC_CREATION_ALICHEB3D_
  88   AliCheb3D(const char* funName, Int_t DimOut, Float_t  *bmin,Float_t  *bmax, Int_t *npoints, Float_t  prec=1E-6);
  89   AliCheb3D(void (*ptr)(float*,float*), Int_t DimOut, Float_t  *bmin,Float_t  *bmax, Int_t *npoints, Float_t  prec=1E-6);
  90   AliCheb3D(void (*ptr)(float*,float*), int DimOut, Float_t  *bmin,Float_t  *bmax, Int_t *npX,Int_t *npY,Int_t *npZ, Float_t prec=1E-6);
  91   AliCheb3D(void (*ptr)(float*,float*), int DimOut, Float_t  *bmin,Float_t  *bmax, Float_t prec=1E-6);
  92 #endif
  93   //
  94   ~AliCheb3D()                                                                 {Clear();}
  95   //
  96   AliCheb3D&   operator=(const AliCheb3D& rhs);
  97   void         Eval(Float_t  *par,Float_t  *res);
  98   Float_t      Eval(Float_t  *par,int idim);
  99   //
 100   void         EvalDeriv(int dimd, Float_t  *par,Float_t  *res);
 101   Float_t      EvalDeriv(int dimd,Float_t  *par, int idim);
 102   void         EvalDeriv3D(Float_t *par, Float_t dbdr[3][3]);
 103   void         Print(Option_t* opt="")                                   const;
 104   Bool_t       IsInside(Float_t  *par)                                   const;
 105   Bool_t       IsInside(Double_t  *par)                                  const;
 106   AliCheb3DCalc*  GetChebCalc(int i)                                     const {return (AliCheb3DCalc*)fChebCalc.UncheckedAt(i);}
 107   Float_t      GetBoundMin(int i)                                        const {return fBMin[i];}
 108   Float_t      GetBoundMax(int i)                                        const {return fBMax[i];}
 109   Float_t*     GetBoundMin()                                             const {return (float*)fBMin;}
 110   Float_t*     GetBoundMax()                                             const {return (float*)fBMax;}
 111   Float_t      GetPrecision()                                            const {return fPrec;}
 112   void         ShiftBound(int id,float dif);
 113   //
 114   void         LoadData(const char* inpFile);
 115   void         LoadData(FILE* stream);
 116   //
 117 #ifdef _INC_CREATION_ALICHEB3D_
 118   int*         GetNCNeeded(float xyz[3],int DimVar, float mn,float mx, float prec);
 119   void         EstimateNPoints(float Prec, int gridBC[3][3]);
 120   void         SaveData(const char* outfile,Bool_t append=kFALSE)        const;
 121   void         SaveData(FILE* stream=stdout)                             const;
 122   //
 123   void         SetUsrFunction(const char* name);
 124   void         SetUsrFunction(void (*ptr)(float*,float*));
 125   void         EvalUsrFunction(Float_t  *x, Float_t  *res);
 126   TH1*         TestRMS(int idim,int npoints = 1000,TH1* histo=0);
 127   static Int_t CalcChebCoefs(Float_t  *funval,int np, Float_t  *outCoefs, Float_t  prec=-1);
 128 #endif
 129   //
 130  protected:
 131   void         Clear(Option_t* option = "");
 132   void         SetDimOut(int d);
 133   void         PrepareBoundaries(Float_t  *bmin,Float_t  *bmax);
 134   //
 135 #ifdef _INC_CREATION_ALICHEB3D_
 136   void         EvalUsrFunction();
 137   void         DefineGrid(Int_t* npoints);
 138   Int_t        ChebFit();                                                                 // fit all output dimensions
 139   Int_t        ChebFit(int dmOut);
 140 #endif
 141   //
 142   Float_t      MapToInternal(Float_t  x,Int_t d) const; // map x to [-1:1]
 143   Float_t      MapToExternal(Float_t  x,Int_t d) const {return x/fBScale[d]+fBOffset[d];}   // map from [-1:1] to x
 144   //
 145  protected:
 146   Int_t        fDimOut;            // dimension of the ouput array
 147   Float_t      fPrec;              // requested precision
 148   Float_t      fBMin[3];           // min boundaries in each dimension
 149   Float_t      fBMax[3];           // max boundaries in each dimension
 150   Float_t      fBScale[3];         // scale for boundary mapping to [-1:1] interval
 151   Float_t      fBOffset[3];        // offset for boundary mapping to [-1:1] interval
 152   TObjArray    fChebCalc;          // Chebyshev parameterization for each output dimension
 153   //
 154   Int_t        fMaxCoefs;          //! max possible number of coefs per parameterization
 155   Int_t        fNPoints[3];        //! number of used points in each dimension
 156   Float_t      fArgsTmp[3];        //! temporary vector for coefs caluclation
 157   Float_t      fBuff[6];           //! buffer for coordinate transformations
 158   Float_t *    fResTmp;            //! temporary vector for results of user function caluclation
 159   Float_t *    fGrid;              //! temporary buffer for Chebyshef roots grid
 160   Int_t        fGridOffs[3];       //! start of grid for each dimension
 161   TString      fUsrFunName;        //! name of user macro containing the function of  "void (*fcn)(float*,float*)" format
 162   TMethodCall* fUsrMacro;          //! Pointer to MethodCall for function from user macro
 163   //
 164   ClassDef(AliCheb3D,1)  // Chebyshev parametrization for 3D->N function
 165 };
 166
 167 //__________________________________________________________________________________________
 168 inline Bool_t  AliCheb3D::IsInside(Float_t  *par) const
 169 {
 170   // check if the point is inside of the fitted box
 171   const float kTol = 1.e-4;
 172   for (int i=3;i--;) if (fBMin[i]-par[i]>kTol || par[i]-fBMax[i]>kTol) return kFALSE;
 173   //if(par[i]<fBMin[i]||par[i]>fBMax[i]) return kFALSE;
 174   return kTRUE;
 175 }
 176
 177 //__________________________________________________________________________________________
 178 inline Bool_t  AliCheb3D::IsInside(Double_t  *par) const
 179 {
 180   // check if the point is inside of the fitted box
 181   const float kTol = 1.e-4;
 182   for (int i=3;i--;) if (fBMin[i]-par[i]>kTol || par[i]-fBMax[i]>kTol) return kFALSE;
 183   //if(par[i]<fBMin[i]||par[i]>fBMax[i]) return kFALSE;
 184   return kTRUE;
 185 }
 186
 187 //__________________________________________________________________________________________
 188 inline void AliCheb3D::Eval(Float_t  *par, Float_t  *res)
 189 {
 190   // evaluate Chebyshev parameterization for 3d->DimOut function
 191   for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
 192   for (int i=fDimOut;i--;) res[i] = GetChebCalc(i)->Eval(fArgsTmp);
 193   //
 194 }
 195
 196 //__________________________________________________________________________________________
 197 inline Float_t AliCheb3D::Eval(Float_t  *par, int idim)
 198 {
 199   // evaluate Chebyshev parameterization for idim-th output dimension of 3d->DimOut function
 200   for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
 201   return GetChebCalc(idim)->Eval(fArgsTmp);
 202   //
 203 }
 204
 205 //__________________________________________________________________________________________
 206 inline void AliCheb3D::EvalDeriv3D(Float_t *par, Float_t dbdr[3][3])
 207 {
 208   // return gradient matrix
 209   for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
 210   for (int ib=3;ib--;) for (int id=3;id--;) dbdr[ib][id] = GetChebCalc(ib)->EvalDeriv(id,fArgsTmp)*fBScale[id];
 211 }
 212
 213 //__________________________________________________________________________________________
 214 inline void AliCheb3D::EvalDeriv(int dimd,Float_t  *par, Float_t  *res)
 215 {
 216   // evaluate Chebyshev parameterization derivative for 3d->DimOut function
 217   for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
 218   for (int i=fDimOut;i--;) res[i] = GetChebCalc(i)->EvalDeriv(dimd,fArgsTmp)*fBScale[dimd];;
 219   //
 220 }
 221
 222 //__________________________________________________________________________________________
 223 inline Float_t AliCheb3D::EvalDeriv(int dimd,Float_t  *par, int idim)
 224 {
 225   // evaluate Chebyshev parameterization derivative over dimd dimention for idim-th output dimension of 3d->DimOut function
 226   for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
 227   return GetChebCalc(idim)->EvalDeriv(dimd,fArgsTmp)*fBScale[dimd];
 228   //
 229 }
 230
 231 //__________________________________________________________________________________________
 232 inline Float_t AliCheb3D::MapToInternal(Float_t  x,Int_t d) const
 233 {
 234   // map x to [-1:1]
 235 #ifdef _BRING_TO_BOUNDARY_
 236   float res = (x-fBOffset[d])*fBScale[d];
 237   if (res<-1) return -1;
 238   if (res> 1) return 1;
 239   return res;
 240 #else
 241   return (x-fBOffset[d])*fBScale[d];
 242 #endif
 243 }
 244
 245 #endif