GhostedAreaSpec Class Reference

Class that defines the parameters that go into the measurement of active jet areas. More...

#include <GhostedAreaSpec.hh>

List of all members.

Public Member Functions

 GhostedAreaSpec ()
 default constructor
 GhostedAreaSpec (double ghost_maxrap, int repeat=gas::def_repeat, double ghost_area=gas::def_ghost_area, double grid_scatter=gas::def_grid_scatter, double kt_scatter=gas::def_kt_scatter, double mean_ghost_kt=gas::def_mean_ghost_kt)
 explicit constructor
 GhostedAreaSpec (double ghost_minrap, double ghost_maxrap, int repeat=gas::def_repeat, double ghost_area=gas::def_ghost_area, double grid_scatter=gas::def_grid_scatter, double kt_scatter=gas::def_kt_scatter, double mean_ghost_kt=gas::def_mean_ghost_kt)
 explicit constructor
void _initialize ()
 does the initialization of actual ghost parameters
double ghost_etamax () const
double ghost_maxrap () const
double ghost_area () const
double grid_scatter () const
double kt_scatter () const
double mean_ghost_kt () const
int repeat () const
double actual_ghost_area () const
int n_ghosts () const
void set_ghost_area (double val)
void set_ghost_etamax (double val)
void set_ghost_maxrap (double val)
void set_grid_scatter (double val)
void set_kt_scatter (double val)
void set_mean_ghost_kt (double val)
void set_repeat (int val)
int nphi () const
 return nphi (ghosts layed out (-nrap, 0..nphi-1), (-nrap+1,0..nphi-1),
int nrap () const
void get_random_status (std::vector< int > &__iseed) const
 get all relevant information about the status of the random number generator, so that it can be reset subsequently with set_random_status.
void set_random_status (const std::vector< int > &__iseed)
 set the status of the random number generator, as obtained previously with get_random_status.
void checkpoint_random ()
void restore_checkpoint_random ()
std::string description () const
 for a summary
void add_ghosts (std::vector< PseudoJet > &) const
 push the ghost 4-momenta onto the back of the vector of PseudoJets
double random_at_own_risk () const
 very deprecated public access to a random number from the internal generator
BasicRandom< double > & generator_at_own_risk () const
 very deprecated public access to the generator itself

Private Member Functions

double _our_rand () const

Private Attributes

double _ghost_maxrap
double _ghost_rap_offset
int _repeat
double _ghost_area
double _grid_scatter
double _kt_scatter
double _mean_ghost_kt
double _actual_ghost_area
double _dphi
double _drap
int _n_ghosts
int _nphi
int _nrap
std::vector< int > _random_checkpoint

Static Private Attributes

static BasicRandom< double > _random_generator

Detailed Description

Class that defines the parameters that go into the measurement of active jet areas.

Definition at line 58 of file GhostedAreaSpec.hh.

Constructor & Destructor Documentation

GhostedAreaSpec::GhostedAreaSpec (  )  [inline]

default constructor

Definition at line 61 of file GhostedAreaSpec.hh.

References _initialize().

00061                    : _ghost_maxrap (gas::def_ghost_maxrap), 
00062                      _ghost_rap_offset(0.0),
00063                     _repeat       (gas::def_repeat), 
00064                     _ghost_area   (gas::def_ghost_area), 
00065                     _grid_scatter (gas::def_grid_scatter), 
00066                     _kt_scatter   (gas::def_kt_scatter), 
00067                     _mean_ghost_kt(gas::def_mean_ghost_kt),
00068                     _actual_ghost_area(-1.0) {_initialize();};

GhostedAreaSpec::GhostedAreaSpec ( double  ghost_maxrap,
int  repeat = gas::def_repeat,
double  ghost_area = gas::def_ghost_area,
double  grid_scatter = gas::def_grid_scatter,
double  kt_scatter = gas::def_kt_scatter,
double  mean_ghost_kt = gas::def_mean_ghost_kt 
) [inline, explicit]

explicit constructor

Definition at line 71 of file GhostedAreaSpec.hh.

References _initialize().

00077                            : 
00078     _ghost_maxrap(ghost_maxrap), 
00079     _ghost_rap_offset(0.0),
00080     _repeat(repeat), 
00081     _ghost_area(ghost_area), 
00082     _grid_scatter(grid_scatter),  
00083     _kt_scatter(kt_scatter), 
00084     _mean_ghost_kt(mean_ghost_kt),
00085     _actual_ghost_area(-1.0) {_initialize();};

GhostedAreaSpec::GhostedAreaSpec ( double  ghost_minrap,
double  ghost_maxrap,
int  repeat = gas::def_repeat,
double  ghost_area = gas::def_ghost_area,
double  grid_scatter = gas::def_grid_scatter,
double  kt_scatter = gas::def_kt_scatter,
double  mean_ghost_kt = gas::def_mean_ghost_kt 
) [inline, explicit]

explicit constructor

Definition at line 88 of file GhostedAreaSpec.hh.

References _initialize().

00095                            : 
00096     _ghost_maxrap    (0.5*(ghost_maxrap - ghost_minrap)), 
00097     _ghost_rap_offset(0.5*(ghost_maxrap + ghost_minrap)),
00098     _repeat(repeat), 
00099     _ghost_area(ghost_area), 
00100     _grid_scatter(grid_scatter),  
00101     _kt_scatter(kt_scatter), 
00102     _mean_ghost_kt(mean_ghost_kt),
00103     _actual_ghost_area(-1.0) {_initialize();};

Member Function Documentation

void GhostedAreaSpec::_initialize (  ) 

does the initialization of actual ghost parameters

sets the detailed parameters for the ghosts (which may not be quite the same as those requested -- this is in order for things to fit in nicely into 2pi etc.

..

Definition at line 45 of file GhostedAreaSpec.cc.

References _actual_ghost_area, _dphi, _drap, _ghost_area, _ghost_maxrap, _n_ghosts, _nphi, _nrap, checkpoint_random(), and twopi.

Referenced by GhostedAreaSpec(), set_ghost_area(), set_ghost_etamax(), and set_ghost_maxrap().

00045                                   {
00046   // add on area-measuring dummy particles
00047   _drap = sqrt(_ghost_area);
00048   _dphi = _drap;
00049   _nphi = int(ceil(twopi/_dphi)); _dphi = twopi/_nphi;
00050   _nrap = int(ceil(_ghost_maxrap/_drap)); _drap = _ghost_maxrap / _nrap;
00051   _actual_ghost_area = _dphi * _drap;
00052   _n_ghosts   = (2*_nrap+1)*_nphi;
00053 
00054   // checkpoint the status of the random number generator.
00055   checkpoint_random();
00056   //_random_generator.info(cerr);
00057 }

double GhostedAreaSpec::_our_rand (  )  const [inline, private]

Definition at line 186 of file GhostedAreaSpec.hh.

References _random_generator.

Referenced by random_at_own_risk().

00186 {return _random_generator();};

double GhostedAreaSpec::actual_ghost_area (  )  const [inline]

Definition at line 119 of file GhostedAreaSpec.hh.

References _actual_ghost_area.

Referenced by ClusterSequence1GhostPassiveArea::_run_1GPA(), and description().

00119 {return _actual_ghost_area;};

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

push the ghost 4-momenta onto the back of the vector of PseudoJets

Referenced by ClusterSequence1GhostPassiveArea::_run_1GPA().

void GhostedAreaSpec::checkpoint_random (  )  [inline]

Definition at line 150 of file GhostedAreaSpec.hh.

References _random_checkpoint, and get_random_status().

Referenced by _initialize().

00150 {get_random_status(_random_checkpoint);}

string GhostedAreaSpec::description (  )  const

for a summary

Definition at line 84 of file GhostedAreaSpec.cc.

References actual_ghost_area(), ghost_area(), ghost_maxrap(), grid_scatter(), kt_scatter(), mean_ghost_kt(), and repeat().

Referenced by AreaDefinition::description().

00084                                           {
00085 
00086   ostringstream ostr;
00087   ostr << "ghosts of area " << actual_ghost_area() 
00088        << " (had requested " << ghost_area() << ")"
00089        << ", placed up to y = " << ghost_maxrap() 
00090        << ", scattered wrt to perfect grid by (rel) " << grid_scatter() 
00091        << ", mean_ghost_kt = " << mean_ghost_kt()
00092        << ", rel kt_scatter =  " << kt_scatter()
00093        << ", n repetitions of ghost distributions =  " << repeat();
00094   return ostr.str();
00095 }

BasicRandom<double>& GhostedAreaSpec::generator_at_own_risk (  )  const [inline]

very deprecated public access to the generator itself

Definition at line 163 of file GhostedAreaSpec.hh.

References _random_generator.

00163                                                              {
00164     return _random_generator;}

void GhostedAreaSpec::get_random_status ( std::vector< int > &  __iseed  )  const [inline]

get all relevant information about the status of the random number generator, so that it can be reset subsequently with set_random_status.

Definition at line 139 of file GhostedAreaSpec.hh.

References _random_generator.

Referenced by checkpoint_random().

00139                                                                 {
00140     _random_generator.get_status(__iseed);}

double GhostedAreaSpec::ghost_area (  )  const [inline]

Definition at line 112 of file GhostedAreaSpec.hh.

References _ghost_area.

Referenced by description().

00112 {return _ghost_area   ;};

double GhostedAreaSpec::ghost_etamax (  )  const [inline]

Definition at line 110 of file GhostedAreaSpec.hh.

References _ghost_maxrap.

00110 {return _ghost_maxrap;};

double GhostedAreaSpec::ghost_maxrap (  )  const [inline]

Definition at line 111 of file GhostedAreaSpec.hh.

References _ghost_maxrap.

Referenced by ClusterSequenceActiveArea::_initialise_AA(), ClusterSequenceArea::_warn_if_range_unsuitable(), and description().

00111 {return _ghost_maxrap;};

double GhostedAreaSpec::grid_scatter (  )  const [inline]

Definition at line 113 of file GhostedAreaSpec.hh.

References _grid_scatter.

Referenced by description().

00113 {return _grid_scatter;};

double GhostedAreaSpec::kt_scatter (  )  const [inline]

Definition at line 114 of file GhostedAreaSpec.hh.

References _kt_scatter.

Referenced by description().

00114 {return _kt_scatter  ;};

double GhostedAreaSpec::mean_ghost_kt (  )  const [inline]

Definition at line 115 of file GhostedAreaSpec.hh.

References _mean_ghost_kt.

Referenced by ClusterSequencePassiveArea::_initialise_and_run_PA(), and description().

00115 {return _mean_ghost_kt  ;};

int GhostedAreaSpec::n_ghosts (  )  const [inline]

Definition at line 120 of file GhostedAreaSpec.hh.

References _n_ghosts.

00120 {return _n_ghosts;};

int GhostedAreaSpec::nphi (  )  const [inline]

return nphi (ghosts layed out (-nrap, 0..nphi-1), (-nrap+1,0..nphi-1),

.. (nrap,0..nphi-1)

Definition at line 133 of file GhostedAreaSpec.hh.

References _nphi.

00133 {return _nphi;}

int GhostedAreaSpec::nrap (  )  const [inline]

Definition at line 134 of file GhostedAreaSpec.hh.

References _nrap.

00134 {return _nrap;}

double GhostedAreaSpec::random_at_own_risk (  )  const [inline]

very deprecated public access to a random number from the internal generator

Definition at line 161 of file GhostedAreaSpec.hh.

References _our_rand().

00161 {return _our_rand();};

int GhostedAreaSpec::repeat (  )  const [inline]

Definition at line 116 of file GhostedAreaSpec.hh.

References _repeat.

Referenced by ClusterSequenceActiveArea::_initialise_AA(), ClusterSequenceActiveArea::_postprocess_AA(), ClusterSequence1GhostPassiveArea::_run_1GPA(), ClusterSequenceActiveArea::_run_AA(), description(), and ClusterSequenceArea::initialize_and_run_cswa().

00116 {return _repeat      ;};

void GhostedAreaSpec::restore_checkpoint_random (  )  [inline]

Definition at line 151 of file GhostedAreaSpec.hh.

References _random_checkpoint, and set_random_status().

00151 {set_random_status(_random_checkpoint);}

void GhostedAreaSpec::set_ghost_area ( double  val  )  [inline]

Definition at line 123 of file GhostedAreaSpec.hh.

References _ghost_area, and _initialize().

00123 {_ghost_area    = val; _initialize();};

void GhostedAreaSpec::set_ghost_etamax ( double  val  )  [inline]

Definition at line 124 of file GhostedAreaSpec.hh.

References _ghost_maxrap, and _initialize().

00124 {_ghost_maxrap = val; _initialize();};

void GhostedAreaSpec::set_ghost_maxrap ( double  val  )  [inline]

Definition at line 125 of file GhostedAreaSpec.hh.

References _ghost_maxrap, and _initialize().

00125 {_ghost_maxrap = val; _initialize();};

void GhostedAreaSpec::set_grid_scatter ( double  val  )  [inline]

Definition at line 126 of file GhostedAreaSpec.hh.

References _grid_scatter.

00126 {_grid_scatter   = val; };

void GhostedAreaSpec::set_kt_scatter ( double  val  )  [inline]

Definition at line 127 of file GhostedAreaSpec.hh.

References _kt_scatter.

00127 {_kt_scatter     = val; };

void GhostedAreaSpec::set_mean_ghost_kt ( double  val  )  [inline]

Definition at line 128 of file GhostedAreaSpec.hh.

References _mean_ghost_kt.

00128 {_mean_ghost_kt  = val; };

void GhostedAreaSpec::set_random_status ( const std::vector< int > &  __iseed  )  [inline]

set the status of the random number generator, as obtained previously with get_random_status.

Note that the random generator is a static member of the class, i.e. common to all instances of the class --- so if you modify the random for this instance, you modify it for all instances.

Definition at line 147 of file GhostedAreaSpec.hh.

References _random_generator.

Referenced by restore_checkpoint_random().

00147                                                                 {
00148     _random_generator.set_status(__iseed);}

void GhostedAreaSpec::set_repeat ( int  val  )  [inline]

Definition at line 129 of file GhostedAreaSpec.hh.

References _repeat.

00129 {_repeat         = val; };

Member Data Documentation

double GhostedAreaSpec::_actual_ghost_area [private]

Definition at line 178 of file GhostedAreaSpec.hh.

Referenced by _initialize(), and actual_ghost_area().

double GhostedAreaSpec::_dphi [private]

Definition at line 178 of file GhostedAreaSpec.hh.

Referenced by _initialize().

double GhostedAreaSpec::_drap [private]

Definition at line 178 of file GhostedAreaSpec.hh.

Referenced by _initialize().

double GhostedAreaSpec::_ghost_area [private]

Definition at line 172 of file GhostedAreaSpec.hh.

Referenced by _initialize(), ghost_area(), and set_ghost_area().

double GhostedAreaSpec::_ghost_maxrap [private]

Definition at line 169 of file GhostedAreaSpec.hh.

Referenced by _initialize(), ghost_etamax(), ghost_maxrap(), set_ghost_etamax(), and set_ghost_maxrap().

double GhostedAreaSpec::_ghost_rap_offset [private]

Definition at line 170 of file GhostedAreaSpec.hh.

double GhostedAreaSpec::_grid_scatter [private]

Definition at line 173 of file GhostedAreaSpec.hh.

Referenced by grid_scatter(), and set_grid_scatter().

double GhostedAreaSpec::_kt_scatter [private]

Definition at line 174 of file GhostedAreaSpec.hh.

Referenced by kt_scatter(), and set_kt_scatter().

double GhostedAreaSpec::_mean_ghost_kt [private]

Definition at line 175 of file GhostedAreaSpec.hh.

Referenced by mean_ghost_kt(), and set_mean_ghost_kt().

int GhostedAreaSpec::_n_ghosts [private]

Definition at line 179 of file GhostedAreaSpec.hh.

Referenced by _initialize(), and n_ghosts().

int GhostedAreaSpec::_nphi [private]

Definition at line 179 of file GhostedAreaSpec.hh.

Referenced by _initialize(), and nphi().

int GhostedAreaSpec::_nrap [private]

Definition at line 179 of file GhostedAreaSpec.hh.

Referenced by _initialize(), and nrap().

std::vector<int> GhostedAreaSpec::_random_checkpoint [private]

Definition at line 182 of file GhostedAreaSpec.hh.

Referenced by checkpoint_random(), and restore_checkpoint_random().

FASTJET_BEGIN_NAMESPACE BasicRandom< double > GhostedAreaSpec::_random_generator [static, private]

Definition at line 183 of file GhostedAreaSpec.hh.

Referenced by _our_rand(), generator_at_own_risk(), get_random_status(), and set_random_status().

int GhostedAreaSpec::_repeat [private]

Definition at line 171 of file GhostedAreaSpec.hh.

Referenced by repeat(), and set_repeat().

The documentation for this class was generated from the following files:
Generated on 26 Feb 2010 for fastjet by  doxygen 1.6.1