ValenciaPlugin.h

Go to the documentation of this file.

// $Id: ValenciaPlugin.hh 771 2015-02-21 16:40:07Z vos $
//
// Copyright (c) 2014, Marcel Vos and Ignacio Garcia
//
//----------------------------------------------------------------------
// This file is part of FastJet contrib.
//
// It is free software; you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the
// Free Software Foundation; either version 2 of the License, or (at
// your option) any later version.
//
// It is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
// License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this code. If not, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------
 
#ifndef FastJet_ValenciaPlugin_h
#define FastJet_ValenciaPlugin_h
 
#include <fastjet/internal/base.hh>
#include "fastjet/JetDefinition.hh"
#include "fastjet/ClusterSequence.hh"
FASTJET_BEGIN_NAMESPACE  // defined in fastjet/internal/base.hh
 
    namespace contrib {
  //----------------------------------------------------------------------
  //
  class ValenciaPlugin : public JetDefinition::Plugin {
  public:
    ValenciaPlugin(double R, double beta, double gamma) : _R(R), _beta(beta), _gamma(gamma) {}

    ValenciaPlugin(double R, double beta) : _R(R), _beta(beta), _gamma(beta) {}

    ValenciaPlugin(const ValenciaPlugin &plugin) { *this = plugin; }
    ValenciaPlugin &operator=(const ValenciaPlugin &) = default;
 
    // the things that are required by base class
    virtual std::string description() const;
    virtual void run_clustering(ClusterSequence &) const;

    virtual double R() const { return _R; }
 
    // the Valencia algorithm has a second parameter beta that governs
    // the exponent of the energy in the inter-particle and beam distance
    // criteria, and thus determines the clustering order
    virtual double beta() const { return _beta; }
 
    // the Valencia algorithm has a third parameter gamma that governs
    // the exponent of the sin(theta) in the beam distance
    // and thus the shrinking of the jet size in the forward region
    virtual double gamma() const { return _gamma; }

    virtual bool exclusive_sequence_meaningful() const { return true; }
 
  private:
    double _R;
    double _beta;
    double _gamma;
  };
 
}  // namespace contrib
 
FASTJET_END_NAMESPACE
 
#endif  // __FASTJET_CONTRIB_VALENCIAJETALGORITHM_HH__