SISConeSphericalPlugin.hh

Go to the documentation of this file.

#ifndef __SISCONESPHERICALPLUGIN_HH__
#define __SISCONESPHERICALPLUGIN_HH__

#include "SISConeBasePlugin.hh"

// forward declaration of the siscone classes we'll need
namespace siscone_spherical{
  class CSphsiscone;
};

// questionable whether this should be in fastjet namespace or not...
FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh

//----------------------------------------------------------------------
//
//
class SISConeSphericalPlugin : public SISConeBasePlugin{
public:

  enum SplitMergeScale {SM_E,        
                        SM_Etilde    
  };


  SISConeSphericalPlugin (double cone_radius,
                          double overlap_threshold,
                          int    n_pass_max = 0,
                          double protojet_Emin = 0.0, 
                          bool   caching = false,
                          SplitMergeScale  split_merge_scale = SM_Etilde,
                          double split_merge_stopping_scale = 0.0){
    _cone_radius           =cone_radius;
    _overlap_threshold     =overlap_threshold;
    _n_pass_max            =n_pass_max;
    _protojet_Emin         =protojet_Emin;
    _caching               =caching;        
    _split_merge_scale     =split_merge_scale;
    _split_merge_stopping_scale = split_merge_stopping_scale;
    _ghost_sep_scale       = 0.0;
    _use_E_weighted_splitting = false;
  }

  double protojet_Emin  () const {return _protojet_Emin  ;}

  double protojet_or_ghost_Emin  () const {return std::max(_protojet_Emin,
                                                           _ghost_sep_scale);}

  SplitMergeScale split_merge_scale() const {return _split_merge_scale;}
  void set_split_merge_scale(SplitMergeScale sms) {_split_merge_scale = sms;}

  bool split_merge_use_E_weighted_splitting() const {return _use_E_weighted_splitting;}
  void set_split_merge_use_E_weighted_splitting(bool val) {
    _use_E_weighted_splitting = val;}

  virtual bool supports_ghosted_passive_areas() const {return true;}
  
  // the things that are required by base class
  virtual std::string description () const;
  virtual void run_clustering(ClusterSequence &) const ;

protected:
  virtual void reset_stored_plugin() const;

private:
  double _protojet_Emin;
  SplitMergeScale _split_merge_scale;
  bool _use_E_weighted_splitting;

  // part needed for the cache 
  // variables for caching the results and the input
  static std::auto_ptr<SISConeSphericalPlugin        > stored_plugin;
  static std::auto_ptr<std::vector<PseudoJet>        > stored_particles;
  static std::auto_ptr<siscone_spherical::CSphsiscone> stored_siscone;
};

//======================================================================
class SISConeSphericalExtras : public SISConeBaseExtras {
public:
  //  it just initialises the pass information 
  SISConeSphericalExtras(int nparticles)
    : SISConeBaseExtras(nparticles){}

  const SISConeSphericalPlugin* jet_def_plugin() const {
    return dynamic_cast<const SISConeSphericalPlugin*>(_jet_def_plugin);
  }

private:
  // let us be written to by SISConePlugin
  friend class SISConeSphericalPlugin;
};

FASTJET_END_NAMESPACE        // defined in fastjet/internal/base.hh

#endif // __SISCONEPLUGIN_HH__