PWGGA/EMCALJetTasks/AliFJWrapper.h

   1 #ifndef AliFJWrapper_H
   2 #define AliFJWrapper_H
   3
   4 // $Id$
   5
   6 #if !defined(__CINT__)
   7
   8 #include <vector>
   9 #include <TString.h>
  10 #include "AliLog.h"
  11 #include "FJ_includes.h"
  12
  13 class AliFJWrapper
  14 {
  15  public:
  16   AliFJWrapper(const char *name, const char *title);
  17   virtual ~AliFJWrapper();
  18
  19   virtual void  AddInputVector (Double_t px, Double_t py, Double_t pz, Double_t E, Int_t index = -99999);
  20   virtual void  AddInputVector (const fastjet::PseudoJet& vec,                Int_t index = -99999);
  21   virtual void  AddInputVectors(const std::vector<fastjet::PseudoJet>& vecs,  Int_t offsetIndex = -99999);
  22   virtual const char *ClassName()                            const { return "AliFJWrapper";              }
  23   virtual void  Clear(const Option_t* /*opt*/ = "");
  24   virtual void  CopySettingsFrom (const AliFJWrapper& wrapper);
  25   virtual void  GetMedianAndSigma(Double_t& median, Double_t& sigma, Int_t remove = 0) const;
  26   fastjet::ClusterSequenceArea*         GetClusterSequence() const { return fClustSeq;                   }
  27   const std::vector<fastjet::PseudoJet> GetInputVectors()    const { return fInputVectors;               }
  28   const std::vector<fastjet::PseudoJet> GetInclusiveJets()   const { return fInclusiveJets;              }
  29   std::vector<fastjet::PseudoJet>       GetJetConstituents(UInt_t idx) const;
  30   Double_t                              GetMedianUsedForBgSubtraction() const { return fMedUsedForBgSub; }
  31   const char*                           GetName()            const { return fName;                       }
  32   const char*                           GetTitle()           const { return fTitle;                      }
  33   Double_t                              GetJetArea         (UInt_t idx) const;
  34   Double_t                              GetJetSubtractedPt (UInt_t idx) const;
  35   virtual std::vector<double>           GetSubtractedJetsPts(Double_t median_pt = -1, Bool_t sorted = kFALSE);
  36
  37   virtual Int_t Run();
  38
  39   void SetStrategy(const fastjet::Strategy &strat)                 { fStrategy = strat;  }
  40   void SetAlgorithm(const fastjet::JetAlgorithm &algor)            { fAlgor    = algor;  }
  41   void SetRecombScheme(const fastjet::RecombinationScheme &scheme) { fScheme   = scheme; }
  42   void SetAreaType(const fastjet::AreaType &atype)                 { fAreaType = atype;  }
  43   void SetNRepeats(Int_t nrepeat)       { fNGhostRepeats  = nrepeat; }
  44   void SetGhostArea(Double_t gharea)    { fGhostArea      = gharea;  }
  45   void SetMaxRap(Double_t maxrap)       { fMaxRap         = maxrap;  }
  46   void SetR(Double_t r)                 { fR              = r;       }
  47   void SetGridScatter(Double_t gridSc)  { fGridScatter    = gridSc;  }
  48   void SetKtScatter(Double_t ktSc)      { fKtScatter      = ktSc;    }
  49   void SetMeanGhostKt(Double_t meankt)  { fMeanGhostKt    = meankt;  }
  50   void SetPluginAlgor(Int_t plugin)     { fPluginAlgor    = plugin;  }
  51   void SetUseArea4Vector(Bool_t useA4v) { fUseArea4Vector = useA4v;  }
  52   void SetupAlgorithmfromOpt(const char *option);
  53   void SetupAreaTypefromOpt(const char *option);
  54   void SetupSchemefromOpt(const char *option);
  55   void SetupStrategyfromOpt(const char *option);
  56
  57  protected:
  58   TString                         fName;             //!
  59   TString                         fTitle;            //!
  60   std::vector<fastjet::PseudoJet> fInputVectors;     //!
  61   std::vector<fastjet::PseudoJet> fInclusiveJets;    //!
  62   std::vector<double>             fSubtractedJetsPt; //!
  63   fastjet::AreaDefinition        *fAreaDef;          //!
  64   fastjet::VoronoiAreaSpec       *fVorAreaSpec;      //!
  65   fastjet::GhostedAreaSpec       *fGhostedAreaSpec;  //!
  66   fastjet::JetDefinition         *fJetDef;           //!
  67   fastjet::JetDefinition::Plugin *fPlugin;           //!
  68   fastjet::RangeDefinition       *fRange;            //!
  69   fastjet::ClusterSequenceArea   *fClustSeq;         //!
  70   fastjet::Strategy               fStrategy;         //!
  71   fastjet::JetAlgorithm           fAlgor;            //!
  72   fastjet::RecombinationScheme    fScheme;           //!
  73   fastjet::AreaType               fAreaType;         //!
  74   Int_t                           fNGhostRepeats;    //!
  75   Double_t                        fGhostArea;        //!
  76   Double_t                        fMaxRap;           //!
  77   Double_t                        fR;                //!
  78   // no setters for the moment - used default values in the constructor
  79   Double_t                        fGridScatter;      //!
  80   Double_t                        fKtScatter;        //!
  81   Double_t                        fMeanGhostKt;      //!
  82   Int_t                           fPluginAlgor;      //!
  83   // extra parameters
  84   Double_t                        fMedUsedForBgSub;  //!
  85   Bool_t                          fUseArea4Vector;   //!
  86
  87   virtual void   SubtractBackground(const Double_t median_pt = -1);
  88
  89  private:
  90   AliFJWrapper();
  91   AliFJWrapper(const AliFJWrapper& wrapper);
  92   AliFJWrapper& operator = (const AliFJWrapper& wrapper);
  93 };
  94 #endif
  95 #endif
  96
  97 #ifdef AliFJWrapper_CXX
  98 #undef AliFJWrapper_CXX
  99
 100 #if defined __GNUC__
 101 #pragma GCC system_header
 102 #endif
 103
 104 namespace fj = fastjet;
 105
 106 //_________________________________________________________________________________________________
 107 AliFJWrapper::AliFJWrapper(const char *name, const char *title)
 108   :
 109     fName              (name)
 110   , fTitle             (title)
 111   , fInputVectors      ( )
 112   , fInclusiveJets     ( )
 113   , fSubtractedJetsPt  ( )
 114   , fAreaDef           (0)
 115   , fVorAreaSpec       (0)
 116   , fGhostedAreaSpec   (0)
 117   , fJetDef            (0)
 118   , fPlugin            (0)
 119   , fRange             (0)
 120   , fClustSeq          (0)
 121   , fStrategy          (fj::Best)
 122   , fAlgor             (fj::kt_algorithm)
 123   , fScheme            (fj::BIpt_scheme)
 124   , fAreaType          (fj::active_area)
 125   , fNGhostRepeats     (1)
 126   , fGhostArea         (0.01)
 127   , fMaxRap            (1.)
 128   , fR                 (0.4)
 129   , fGridScatter       (1.0)
 130   , fKtScatter         (0.1)
 131   , fMeanGhostKt       (1e-100)
 132   , fPluginAlgor       (0)
 133   , fMedUsedForBgSub   (0)
 134   , fUseArea4Vector    (kFALSE)
 135 {
 136   // Constructor.
 137 }
 138
 139 //_________________________________________________________________________________________________
 140 AliFJWrapper::~AliFJWrapper()
 141 {
 142   // Destructor.
 143
 144   delete fAreaDef;
 145   delete fVorAreaSpec;
 146   delete fGhostedAreaSpec;
 147   delete fJetDef;
 148   delete fPlugin;
 149   delete fRange;
 150   delete fClustSeq;
 151 }
 152
 153 //_________________________________________________________________________________________________
 154 void AliFJWrapper::CopySettingsFrom(const AliFJWrapper& wrapper)
 155 {
 156   // Copy some settings.
 157   // You very often want to keep most of the settings
 158   // but change only the algorithm or R - do it after call to this function
 159
 160   fStrategy       = wrapper.fStrategy;
 161   fAlgor          = wrapper.fAlgor;
 162   fScheme         = wrapper.fScheme;
 163   fAreaType       = wrapper.fAreaType;
 164   fNGhostRepeats  = wrapper.fNGhostRepeats;
 165   fGhostArea      = wrapper.fGhostArea;
 166   fMaxRap         = wrapper.fMaxRap;
 167   fR              = wrapper.fR;
 168   fGridScatter    = wrapper.fGridScatter;
 169   fKtScatter      = wrapper.fKtScatter;
 170   fMeanGhostKt    = wrapper.fMeanGhostKt;
 171   fPluginAlgor    = wrapper.fPluginAlgor;
 172   fUseArea4Vector = wrapper.fUseArea4Vector;
 173 }
 174
 175 //_________________________________________________________________________________________________
 176 void AliFJWrapper::Clear(const Option_t */*opt*/)
 177 {
 178   // Simply clear the input vectors.
 179   // Make sure done on every event if the instance is reused
 180   // Reset the median to zero.
 181
 182   fInputVectors.clear();
 183   fMedUsedForBgSub = 0;
 184
 185   // for the moment brute force delete everything
 186   delete fAreaDef;         fAreaDef         = 0;
 187   delete fVorAreaSpec;     fVorAreaSpec     = 0;
 188   delete fGhostedAreaSpec; fGhostedAreaSpec = 0;
 189   delete fJetDef;          fJetDef          = 0;
 190   delete fPlugin;          fPlugin          = 0;
 191   delete fRange;           fRange           = 0;
 192   delete fClustSeq;        fClustSeq        = 0;
 193 }
 194
 195 //_________________________________________________________________________________________________
 196 void AliFJWrapper::AddInputVector(Double_t px, Double_t py, Double_t pz, Double_t E, Int_t index)
 197 {
 198   // Make the input pseudojet.
 199
 200   fastjet::PseudoJet inVec(px, py, pz, E);
 201
 202   if (index > -99999) {
 203     inVec.set_user_index(index);
 204   } else {
 205     inVec.set_user_index(fInputVectors.size());
 206   }
 207
 208   // add to the fj container of input vectors
 209   fInputVectors.push_back(inVec);
 210 }
 211
 212 //_________________________________________________________________________________________________
 213 void AliFJWrapper::AddInputVector(const fj::PseudoJet& vec, Int_t index)
 214 {
 215   // Add an input pseudojet.
 216
 217   fj::PseudoJet inVec = vec;
 218
 219   if (index > -99999) {
 220     inVec.set_user_index(index);
 221   } else {
 222     inVec.set_user_index(fInputVectors.size());
 223   }
 224
 225   // add to the fj container of input vectors
 226   fInputVectors.push_back(inVec);
 227 }
 228
 229 //_________________________________________________________________________________________________
 230 void AliFJWrapper::AddInputVectors(const std::vector<fj::PseudoJet>& vecs, Int_t offsetIndex)
 231 {
 232   // Add the input from vector of pseudojets.
 233
 234   for (UInt_t i = 0; i < vecs.size(); ++i) {
 235     fj::PseudoJet inVec = vecs[i];
 236     if (offsetIndex > -99999)
 237       inVec.set_user_index(fInputVectors.size() + offsetIndex);
 238     // add to the fj container of input vectors
 239     fInputVectors.push_back(inVec);
 240   }
 241 }
 242
 243 //_________________________________________________________________________________________________
 244 Double_t AliFJWrapper::GetJetArea(UInt_t idx) const
 245 {
 246   // Get the jet area.
 247
 248   Double_t retval = -1; // really wrong area..
 249   if ( idx < fInclusiveJets.size() ) {
 250     retval = fClustSeq->area(fInclusiveJets[idx]);
 251   } else {
 252     AliError(Form("[e] ::GetJetArea wrong index: %d",idx));
 253   }
 254   return retval;
 255 }
 256
 257 //_________________________________________________________________________________________________
 258 std::vector<double> AliFJWrapper::GetSubtractedJetsPts(Double_t median_pt, Bool_t sorted)
 259 {
 260   // Get subtracted jets pTs, returns vector.
 261
 262   SubtractBackground(median_pt);
 263
 264   if (kTRUE == sorted) {
 265     std::sort(fSubtractedJetsPt.begin(), fSubtractedJetsPt.begin());
 266   }
 267   return fSubtractedJetsPt;
 268 }
 269
 270 //_________________________________________________________________________________________________
 271 Double_t AliFJWrapper::GetJetSubtractedPt(UInt_t idx) const
 272 {
 273   // Get subtracted jets pTs, returns Double_t.
 274
 275   Double_t retval = -99999.; // really wrong pt..
 276   if ( idx < fSubtractedJetsPt.size() ) {
 277     retval = fSubtractedJetsPt[idx];
 278   }
 279   return retval;
 280 }
 281
 282 //_________________________________________________________________________________________________
 283 std::vector<fastjet::PseudoJet>
 284 AliFJWrapper::GetJetConstituents(UInt_t idx) const
 285 {
 286   // Get jets constituents.
 287
 288   std::vector<fastjet::PseudoJet> retval;
 289
 290   if ( idx < fInclusiveJets.size() ) {
 291     retval = fClustSeq->constituents(fInclusiveJets[idx]);
 292   } else {
 293     AliError(Form("[e] ::GetJetConstituents wrong index: %d",idx));
 294   }
 295
 296   return retval;
 297 }
 298
 299 //_________________________________________________________________________________________________
 300 void AliFJWrapper::GetMedianAndSigma(Double_t &median, Double_t &sigma, Int_t remove) const
 301 {
 302   // Get the median and sigma from fastjet.
 303   // User can also do it on his own because the cluster sequence is exposed (via a getter)
 304
 305   if (!fClustSeq) {
 306     AliError("[e] Run the jfinder first.");
 307     return;
 308   }
 309
 310   Double_t mean_area = 0;
 311   try {
 312     if(0 == remove) {
 313       fClustSeq->get_median_rho_and_sigma(*fRange, fUseArea4Vector, median, sigma, mean_area);
 314     }  else {
 315       std::vector<fastjet::PseudoJet> input_jets = sorted_by_pt(fClustSeq->inclusive_jets());
 316       input_jets.erase(input_jets.begin(), input_jets.begin() + remove);
 317       fClustSeq->get_median_rho_and_sigma(input_jets, *fRange, kFALSE, median, sigma, mean_area);
 318       input_jets.clear();
 319     }
 320   } catch (fj::Error) {
 321     AliError(" [w] FJ Exception caught.");
 322     median = -1.;
 323     sigma = -1;
 324   }
 325 }
 326
 327 //_________________________________________________________________________________________________
 328 Int_t AliFJWrapper::Run()
 329 {
 330   // Run the actual jet finder.
 331
 332   if (fAreaType == fj::voronoi_area) {
 333     // Rfact - check dependence - default is 1.
 334     // NOTE: hardcoded variable!
 335     fVorAreaSpec = new fj::VoronoiAreaSpec(1.);
 336     fAreaDef     = new fj::AreaDefinition(*fVorAreaSpec);
 337   } else {
 338     fGhostedAreaSpec = new fj::GhostedAreaSpec(fMaxRap,
 339                                                fNGhostRepeats,
 340                                                fGhostArea,
 341                                                fGridScatter,
 342                                                fKtScatter,
 343                                                fMeanGhostKt);
 344
 345     fAreaDef = new fj::AreaDefinition(*fGhostedAreaSpec, fAreaType);
 346   }
 347
 348   // this is acceptable by fastjet:
 349   fRange = new fj::RangeDefinition(fMaxRap - 0.95 * fR);
 350
 351   if (fAlgor == fj::plugin_algorithm) {
 352     if (fPluginAlgor == 0) {
 353       // SIS CONE ALGOR
 354       // NOTE: hardcoded split parameter
 355       Double_t overlap_threshold = 0.75; // NOTE: this actually splits a lot: thr/min(pt1,pt2)
 356       fPlugin = new fj::SISConePlugin(fR,
 357                                       overlap_threshold,
 358                                       0,    //search of stable cones - zero = until no more
 359                                       1.0); // this should be seed effectively for proto jets
 360       fJetDef = new fastjet::JetDefinition(fPlugin);
 361     } else {
 362       AliError("[e] Unrecognized plugin number!");
 363     }
 364   } else {
 365     fJetDef = new fj::JetDefinition(fAlgor, fR, fScheme, fStrategy);
 366   }
 367
 368   try {
 369     fClustSeq = new fj::ClusterSequenceArea(fInputVectors, *fJetDef, *fAreaDef);
 370   } catch (fj::Error) {
 371     AliError(" [w] FJ Exception caught.");
 372     return -1;
 373   }
 374
 375   // inclusive jets:
 376   fInclusiveJets.clear();
 377   fInclusiveJets = fClustSeq->inclusive_jets(0.0);
 378
 379   return 0;
 380 }
 381
 382 //_________________________________________________________________________________________________
 383 void AliFJWrapper::SubtractBackground(Double_t median_pt)
 384 {
 385   // Subtract the background (specify the value - see below the meaning).
 386   // Negative argument means the bg will be determined with the current algorithm
 387   // this is the default behavior. Zero is allowed
 388   // Note: user may set the switch for area4vector based subtraction.
 389
 390   Double_t median    = 0;
 391   Double_t sigma     = 0;
 392   Double_t mean_area = 0;
 393
 394   // clear the subtracted jet pt's vector<double>
 395   fSubtractedJetsPt.clear();
 396
 397   // check what was specified (default is -1)
 398   if (median_pt < 0) {
 399     try {
 400       fClustSeq->get_median_rho_and_sigma(*fRange, kFALSE, median, sigma, mean_area);
 401     }
 402
 403     catch (fj::Error) {
 404       AliError(" [w] FJ Exception caught.");
 405       median = -9999.;
 406       sigma = -1;
 407       fMedUsedForBgSub = median;
 408       return;
 409     }
 410     fMedUsedForBgSub = median;
 411   } else {
 412     // we do not know the sigma in this case
 413     sigma = -1;
 414     if (0.0 == median_pt) {
 415       // AliWarning(Form(" [w] Median specified for bg subtraction is ZERO: %f", median_pt )) << endl;
 416       fMedUsedForBgSub = 0.;
 417     } else {
 418       fMedUsedForBgSub = median_pt;
 419     }
 420   }
 421
 422   // subtract:
 423   for (unsigned i = 0; i < fInclusiveJets.size(); i++) {
 424     if (kTRUE == fUseArea4Vector) {
 425       // subtract the background using the area4vector
 426       fj::PseudoJet area4v = fClustSeq->area_4vector(fInclusiveJets[i]);
 427       fj::PseudoJet jet_sub = fInclusiveJets[i] - area4v * fMedUsedForBgSub;
 428       fSubtractedJetsPt.push_back(jet_sub.perp()); // here we put only the pt of the jet - note: this can be negative
 429     } else {
 430       // subtract the background using scalars
 431       // fj::PseudoJet jet_sub = fInclusiveJets[i] - area * fMedUsedForBgSub_;
 432       Double_t area = fClustSeq->area(fInclusiveJets[i]);
 433       // standard subtraction
 434       Double_t pt_sub = fInclusiveJets[i].perp() - fMedUsedForBgSub * area;
 435       fSubtractedJetsPt.push_back(pt_sub); // here we put only the pt of the jet - note: this can be negative
 436     }
 437   }
 438 }
 439
 440 //_________________________________________________________________________________________________
 441 void AliFJWrapper::SetupAlgorithmfromOpt(const char *option)
 442 {
 443   // Setup algorithm from char.
 444
 445   std::string opt(option);
 446
 447   if (!opt.compare("kt"))                fAlgor    = fj::kt_algorithm;
 448   if (!opt.compare("antikt"))            fAlgor    = fj::antikt_algorithm;
 449   if (!opt.compare("cambridge"))         fAlgor    = fj::cambridge_algorithm;
 450   if (!opt.compare("genkt"))             fAlgor    = fj::genkt_algorithm;
 451   if (!opt.compare("cambridge_passive")) fAlgor    = fj::cambridge_for_passive_algorithm;
 452   if (!opt.compare("genkt_passive"))     fAlgor    = fj::genkt_for_passive_algorithm;
 453   if (!opt.compare("ee_kt"))             fAlgor    = fj::ee_kt_algorithm;
 454   if (!opt.compare("ee_genkt"))          fAlgor    = fj::ee_genkt_algorithm;
 455   if (!opt.compare("plugin"))            fAlgor    = fj::plugin_algorithm;
 456 }
 457
 458 //_________________________________________________________________________________________________
 459 void AliFJWrapper::SetupAreaTypefromOpt(const char *option)
 460 {
 461   // Setup area type from char.
 462
 463   std::string opt(option);
 464
 465   if (!opt.compare("active"))                      fAreaType = fj::active_area;
 466   if (!opt.compare("invalid"))                     fAreaType = fj::invalid_area;
 467   if (!opt.compare("active_area_explicit_ghosts")) fAreaType = fj::active_area_explicit_ghosts;
 468   if (!opt.compare("one_ghost_passive"))           fAreaType = fj::one_ghost_passive_area;
 469   if (!opt.compare("passive"))                     fAreaType = fj::passive_area;
 470   if (!opt.compare("voronoi"))                     fAreaType = fj::voronoi_area;
 471 }
 472
 473 //_________________________________________________________________________________________________
 474 void AliFJWrapper::SetupSchemefromOpt(const char *option)
 475 {
 476   //
 477   // setup scheme from char
 478   //
 479
 480   std::string opt(option);
 481
 482   if (!opt.compare("BIpt"))   fScheme   = fj::BIpt_scheme;
 483   if (!opt.compare("BIpt2"))  fScheme   = fj::BIpt2_scheme;
 484   if (!opt.compare("E"))      fScheme   = fj::E_scheme;
 485   if (!opt.compare("pt"))     fScheme   = fj::pt_scheme;
 486   if (!opt.compare("pt2"))    fScheme   = fj::pt2_scheme;
 487   if (!opt.compare("Et"))     fScheme   = fj::Et_scheme;
 488   if (!opt.compare("Et2"))    fScheme   = fj::Et2_scheme;
 489 }
 490
 491 //_________________________________________________________________________________________________
 492 void AliFJWrapper::SetupStrategyfromOpt(const char *option)
 493 {
 494   // Setup strategy from char.
 495
 496   std::string opt(option);
 497
 498   if (!opt.compare("Best"))            fStrategy = fj::Best;
 499   if (!opt.compare("N2MinHeapTiled"))  fStrategy = fj::N2MinHeapTiled;
 500   if (!opt.compare("N2Tiled"))         fStrategy = fj::N2Tiled;
 501   if (!opt.compare("N2PoorTiled"))     fStrategy = fj::N2PoorTiled;
 502   if (!opt.compare("N2Plain"))         fStrategy = fj::N2Plain;
 503   if (!opt.compare("N3Dumb"))          fStrategy = fj::N3Dumb;
 504   if (!opt.compare("NlnN"))            fStrategy = fj::NlnN;
 505   if (!opt.compare("NlnN3pi"))         fStrategy = fj::NlnN3pi;
 506   if (!opt.compare("NlnN4pi"))         fStrategy = fj::NlnN4pi;
 507   if (!opt.compare("NlnNCam4pi"))      fStrategy = fj::NlnNCam4pi;
 508   if (!opt.compare("NlnNCam2pi2R"))    fStrategy = fj::NlnNCam2pi2R;
 509   if (!opt.compare("NlnNCam"))         fStrategy = fj::NlnNCam;
 510   if (!opt.compare("plugin"))          fStrategy = fj::plugin_strategy;
 511 }
 512 #endif