fastjet::GhostedAreaSpec Class Reference

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

#include <GhostedAreaSpec.hh>

Collaboration diagram for fastjet::GhostedAreaSpec:


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
void	_initialize ()
	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.
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.
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
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

fastjet::GhostedAreaSpec::GhostedAreaSpec ( ) [inline]

default constructor

Definition at line 61 of file GhostedAreaSpec.hh.

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

fastjet::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 70 of file GhostedAreaSpec.hh.

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

Member Function Documentation

void fastjet::GhostedAreaSpec::_initialize ( )

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 fastjet::twopi.

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 fastjet::GhostedAreaSpec::ghost_etamax ( ) const [inline]

Definition at line 90 of file GhostedAreaSpec.hh.

00090 {return _ghost_maxrap;};

double fastjet::GhostedAreaSpec::ghost_maxrap ( ) const [inline]

Definition at line 91 of file GhostedAreaSpec.hh.

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

00091 {return _ghost_maxrap;};

double fastjet::GhostedAreaSpec::ghost_area ( ) const [inline]

Definition at line 92 of file GhostedAreaSpec.hh.

Referenced by description().

00092 {return _ghost_area   ;};

double fastjet::GhostedAreaSpec::grid_scatter ( ) const [inline]

Definition at line 93 of file GhostedAreaSpec.hh.

Referenced by description().

00093 {return _grid_scatter;};

double fastjet::GhostedAreaSpec::kt_scatter ( ) const [inline]

Definition at line 94 of file GhostedAreaSpec.hh.

Referenced by description().

00094 {return _kt_scatter  ;};

double fastjet::GhostedAreaSpec::mean_ghost_kt ( ) const [inline]

Definition at line 95 of file GhostedAreaSpec.hh.

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

00095 {return _mean_ghost_kt  ;};

int fastjet::GhostedAreaSpec::repeat ( ) const [inline]

Definition at line 96 of file GhostedAreaSpec.hh.

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

00096 {return _repeat      ;};

double fastjet::GhostedAreaSpec::actual_ghost_area ( ) const [inline]

Definition at line 99 of file GhostedAreaSpec.hh.

Referenced by fastjet::ClusterSequenceActiveAreaExplicitGhosts::_add_ghosts(), fastjet::ClusterSequence1GhostPassiveArea::_run_1GPA(), and description().

00099 {return _actual_ghost_area;};

int fastjet::GhostedAreaSpec::n_ghosts ( ) const [inline]

Definition at line 100 of file GhostedAreaSpec.hh.

Referenced by fastjet::ClusterSequenceActiveAreaExplicitGhosts::_add_ghosts().

00100 {return _n_ghosts;};

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

Definition at line 103 of file GhostedAreaSpec.hh.

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

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

Definition at line 104 of file GhostedAreaSpec.hh.

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

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

Definition at line 105 of file GhostedAreaSpec.hh.

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

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

Definition at line 106 of file GhostedAreaSpec.hh.

00106 {_grid_scatter   = val; };

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

Definition at line 107 of file GhostedAreaSpec.hh.

00107 {_kt_scatter     = val; };

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

Definition at line 108 of file GhostedAreaSpec.hh.

00108 {_mean_ghost_kt  = val; };

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

Definition at line 109 of file GhostedAreaSpec.hh.

00109 {_repeat         = val; };

int fastjet::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 113 of file GhostedAreaSpec.hh.

00113 {return _nphi;}

int fastjet::GhostedAreaSpec::nrap ( ) const [inline]

Definition at line 114 of file GhostedAreaSpec.hh.

00114 {return _nrap;}

void fastjet::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 119 of file GhostedAreaSpec.hh.

00119                                                                 {
00120     _random_generator.get_status(__iseed);}

void fastjet::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 127 of file GhostedAreaSpec.hh.

00127                                                                 {
00128     _random_generator.set_status(__iseed);}

void fastjet::GhostedAreaSpec::checkpoint_random ( ) [inline]

Definition at line 130 of file GhostedAreaSpec.hh.

Referenced by _initialize().

00130 {get_random_status(_random_checkpoint);}

void fastjet::GhostedAreaSpec::restore_checkpoint_random ( ) [inline]

Definition at line 131 of file GhostedAreaSpec.hh.

00131 {set_random_status(_random_checkpoint);}

string fastjet::GhostedAreaSpec::description ( ) const

for a summary

Definition at line 83 of file GhostedAreaSpec.cc.

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

Referenced by fastjet::AreaDefinition::description().

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

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

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

Referenced by fastjet::ClusterSequenceActiveAreaExplicitGhosts::_add_ghosts(), and fastjet::ClusterSequence1GhostPassiveArea::_run_1GPA().

double fastjet::GhostedAreaSpec::random_at_own_risk ( ) const [inline]

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

Definition at line 141 of file GhostedAreaSpec.hh.

00141 {return _our_rand();};

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

very deprecated public access to the generator itself

Definition at line 143 of file GhostedAreaSpec.hh.

00143                                                              {
00144     return _random_generator;}

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

Definition at line 165 of file GhostedAreaSpec.hh.

00165 {return _random_generator();};

Member Data Documentation

double fastjet::GhostedAreaSpec::_ghost_maxrap [private]

Definition at line 149 of file GhostedAreaSpec.hh.

Referenced by _initialize().

int fastjet::GhostedAreaSpec::_repeat [private]

Definition at line 150 of file GhostedAreaSpec.hh.

double fastjet::GhostedAreaSpec::_ghost_area [private]

Definition at line 151 of file GhostedAreaSpec.hh.

Referenced by _initialize().

double fastjet::GhostedAreaSpec::_grid_scatter [private]

Definition at line 152 of file GhostedAreaSpec.hh.

double fastjet::GhostedAreaSpec::_kt_scatter [private]

Definition at line 153 of file GhostedAreaSpec.hh.

double fastjet::GhostedAreaSpec::_mean_ghost_kt [private]

Definition at line 154 of file GhostedAreaSpec.hh.

double fastjet::GhostedAreaSpec::_actual_ghost_area [private]

Definition at line 157 of file GhostedAreaSpec.hh.

Referenced by _initialize().

double fastjet::GhostedAreaSpec::_dphi [private]

Definition at line 157 of file GhostedAreaSpec.hh.

Referenced by _initialize().

double fastjet::GhostedAreaSpec::_drap [private]

Definition at line 157 of file GhostedAreaSpec.hh.

Referenced by _initialize().

int fastjet::GhostedAreaSpec::_n_ghosts [private]

Definition at line 158 of file GhostedAreaSpec.hh.

Referenced by _initialize().

int fastjet::GhostedAreaSpec::_nphi [private]

Definition at line 158 of file GhostedAreaSpec.hh.

Referenced by _initialize().

int fastjet::GhostedAreaSpec::_nrap [private]

Definition at line 158 of file GhostedAreaSpec.hh.

Referenced by _initialize().

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

Definition at line 161 of file GhostedAreaSpec.hh.

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

Definition at line 162 of file GhostedAreaSpec.hh.

The documentation for this class was generated from the following files:

include/fastjet/GhostedAreaSpec.hh
src/GhostedAreaSpec.cc

Generated on Thu Jan 3 19:05:18 2008 for fastjet by

1.5.2

fastjet::GhostedAreaSpec Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation