ActiveAreaSpec.hh

Go to the documentation of this file.

//STARTHEADER
// $Id: ActiveAreaSpec.hh 514 2007-03-10 17:50:06Z salam $
//
// Copyright (c) 2005-2006, Matteo Cacciari and Gavin Salam
//
//----------------------------------------------------------------------
// This file is part of FastJet.
//
//  FastJet 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.
//
//  The algorithms that underlie FastJet have required considerable
//  development and are described in hep-ph/0512210. If you use
//  FastJet as part of work towards a scientific publication, please
//  include a citation to the FastJet paper.
//
//  FastJet 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 FastJet; if not, write to the Free Software
//  Foundation, Inc.:
//      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//----------------------------------------------------------------------
//ENDHEADER


#ifndef __FASTJET_ACTIVEAREASPEC_HH__
#define __FASTJET_ACTIVEAREASPEC_HH__

#include<vector>
#include<string>
#include "fastjet/PseudoJet.hh"
#include "fastjet/internal/BasicRandom.hh"

// 
#define STATIC_GENERATOR 1

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

//----------------------------------------------------------------------
class ActiveAreaSpec {
public:
  ActiveAreaSpec(): _ghost_maxrap(6.0), _repeat(1), _ghost_area(0.01), 
                    _grid_scatter(1e-4), _kt_scatter(0.1), 
                    _mean_ghost_kt(1e-100),
                    _actual_ghost_area(-1.0) {_initialize();};
  
  explicit ActiveAreaSpec(double ghost_maxrap, 
                          int    repeat = 1,
                          double ghost_area=0.01, 
                          double grid_scatter = 1e-4, 
                          double kt_scatter = 0.1,
                          double mean_ghost_kt = 1e-100): 
    _ghost_maxrap(ghost_maxrap), 
    _repeat(repeat), 
    _ghost_area(ghost_area), 
    _grid_scatter(grid_scatter),  
    _kt_scatter(kt_scatter), 
    _mean_ghost_kt(mean_ghost_kt),
    _actual_ghost_area(-1.0) {_initialize();};


  void _initialize();

  // for accessing values set by the user
  inline double ghost_etamax() const {return _ghost_maxrap;};
  inline double ghost_maxrap() const {return _ghost_maxrap;};
  inline double ghost_area   () const {return _ghost_area   ;};
  inline double grid_scatter() const {return _grid_scatter;};
  inline double kt_scatter  () const {return _kt_scatter  ;};
  inline double mean_ghost_kt() const {return _mean_ghost_kt  ;};
  inline int    repeat      () const {return _repeat      ;};

  // for accessing values 
  inline double actual_ghost_area() const {return _actual_ghost_area;};
  inline int    n_ghosts()          const {return _n_ghosts;};

  // when explicitly modifying values, sometimes call the initializer
  inline void set_ghost_area   (double val) {_ghost_area    = val; _initialize();};
  inline void set_ghost_etamax(double val) {_ghost_maxrap = val; _initialize();};
  inline void set_ghost_maxrap(double val) {_ghost_maxrap = val; _initialize();};
  inline void set_grid_scatter(double val) {_grid_scatter   = val; };
  inline void set_kt_scatter  (double val) {_kt_scatter     = val; };
  inline void set_mean_ghost_kt(double val){_mean_ghost_kt  = val; };
  inline void set_repeat      (int    val) {_repeat         = val; };
  
  std::string description();

  void add_ghosts(std::vector<PseudoJet> & ) const;

private:
  
  // quantities that determine nature and distribution of ghosts
  double _ghost_maxrap;
  int    _repeat      ;
  double _ghost_area   ;  
  double _grid_scatter;
  double _kt_scatter  ;
  double _mean_ghost_kt;

  // derived quantities
  double _actual_ghost_area, _dphi, _drap;
  int    _n_ghosts, _nphi, _nrap;

  //inline double _our_rand() const {return rand()*(1.0/RAND_MAX);};
  inline double _our_rand() const {return _random_generator();};

  static BasicRandom<double> _random_generator;
  //mutable BasicRandom<double> _random_generator;

  
};

FASTJET_END_NAMESPACE

#endif // __FASTJET_ACTIVEAREASPEC_HH__

---