fastjet::RangeDefinition Class Reference

class for holding a range definition specification, given by limits on rapidity and azimuth. More...

#include <RangeDefinition.hh>

List of all members.

Public Member Functions
	RangeDefinition ()
	default constructor
	RangeDefinition (double rapmax)
	constructor for a range definition given by |y|<rapmax
virtual	~RangeDefinition ()
	destructor does nothing
	RangeDefinition (double rapmin, double rapmax, double phimin=0.0, double phimax=twopi)
	constructor for a range definition given by rapmin <= y <= rapmax, phimin <= phi <= phimax
bool	is_in_range (const PseudoJet &jet) const
	return bool according to whether the jet is within the given range
virtual bool	is_in_range (double rap, double phi) const
	return bool according to whether a (rap,phi) point is in range
virtual void	get_rap_limits (double &rapmin, double &rapmax) const
	return the minimal and maximal rapidity of this range; remember to replace this if you write a derived class with more complex ranges;
virtual double	area () const
	area of the range region
virtual std::string	description () const
	textual description of range
Protected Member Functions
void	_numerical_total_area (double rapmax, int npoints)
	calculate, and set _total_area, by calculating which of points on a grid (npoints * npoints from -rapmax.
Protected Attributes
double	_total_area
Private Attributes
double	_rapmin
double	_rapmax
double	_phimin
double	_phimax

---

Detailed Description

class for holding a range definition specification, given by limits on rapidity and azimuth.

Definition at line 46 of file RangeDefinition.hh.

---

Constructor & Destructor Documentation

fastjet::RangeDefinition::RangeDefinition

(

)

[inline]

default constructor

Definition at line 49 of file RangeDefinition.hh.

{}

fastjet::RangeDefinition::RangeDefinition

(

double

rapmax

)

[inline]

constructor for a range definition given by |y|<rapmax

Definition at line 52 of file RangeDefinition.hh.

References twopi.

                                 {
                     assert ( rapmax > 0.0 );
                     _rapmax = rapmax;
                     _rapmin = -rapmax;
                     _phimin = 0.0;
                     _phimax = twopi;
                     _total_area = 2.0*rapmax*twopi; }

virtual fastjet::RangeDefinition::~RangeDefinition

(

)

[inline, virtual]

destructor does nothing

Definition at line 61 of file RangeDefinition.hh.

{}

fastjet::RangeDefinition::RangeDefinition	(	double	rapmin,
		double	rapmax,
		double	phimin = 0.0,
		double	phimax = twopi
	)			[inline]

constructor for a range definition given by rapmin <= y <= rapmax, phimin <= phi <= phimax

Definition at line 65 of file RangeDefinition.hh.

                                                              {
                     assert ( rapmin < rapmax);
                     assert ( phimin < phimax);
                     assert ( phimin >= 0.0 );
                     _rapmax = rapmax;
                     _rapmin = rapmin;
                     _phimin = phimin;
                     _phimax = phimax;
                     _total_area = (_rapmax - _rapmin)*(_phimax - _phimin); }

---

Member Function Documentation

bool fastjet::RangeDefinition::is_in_range

(

const PseudoJet &

jet

)

const [inline]

return bool according to whether the jet is within the given range

Definition at line 78 of file RangeDefinition.hh.

References fastjet::PseudoJet::phi(), and fastjet::PseudoJet::rap().

Referenced by _numerical_total_area(), fastjet::ClusterSequenceAreaBase::empty_area(), fastjet::ClusterSequenceActiveAreaExplicitGhosts::empty_area(), fastjet::ClusterSequenceActiveArea::empty_area(), fastjet::ClusterSequenceAreaBase::get_median_rho_and_sigma(), fastjet::ClusterSequenceActiveArea::n_empty_jets(), and fastjet::ClusterSequenceAreaBase::parabolic_pt_per_unit_area().

                                                       {
    double rap = jet.rap();
    double phi = jet.phi();
    return is_in_range(rap,phi);
  }

virtual bool fastjet::RangeDefinition::is_in_range	(	double	rap,
		double	phi
	)			const [inline, virtual]

return bool according to whether a (rap,phi) point is in range

Definition at line 85 of file RangeDefinition.hh.

                                                                {
    return  ( rap >= _rapmin && 
              rap <= _rapmax &&
              phi >= _phimin &&
              phi <= _phimax );
  }

virtual void fastjet::RangeDefinition::get_rap_limits	(	double &	rapmin,
		double &	rapmax
	)			const [inline, virtual]

return the minimal and maximal rapidity of this range; remember to replace this if you write a derived class with more complex ranges;

Definition at line 94 of file RangeDefinition.hh.

Referenced by fastjet::ClusterSequenceArea::_warn_if_range_unsuitable().

                                                                             {
    rapmin = _rapmin;
    rapmax = _rapmax;
  }

virtual double fastjet::RangeDefinition::area

(

)

const [inline, virtual]

area of the range region

Definition at line 100 of file RangeDefinition.hh.

Referenced by fastjet::ClusterSequenceAreaBase::empty_area().

{ return _total_area; }

virtual std::string fastjet::RangeDefinition::description

(

)

const [inline, virtual]

textual description of range

Definition at line 103 of file RangeDefinition.hh.

                                               {
    std::ostringstream ostr;
    ostr << "Range: " << _rapmin << " <= y <= "   << _rapmax << ", "
                      << _phimin << " <= phi <= " << _phimax ;
    return ostr.str();
}

void fastjet::RangeDefinition::_numerical_total_area	(	double	rapmax,
		int	npoints
	)			[protected]

calculate, and set _total_area, by calculating which of points on a grid (npoints * npoints from -rapmax.

calculate, and set in _total_area, the area with a numerical test takes a reasonable time with rapmax = 10, npoints = 100

.rapmax,0..2pi) are contained in the range; it takes a reasonable time with rapmax = 10, npoints = 100.

Definition at line 39 of file RangeDefinition.cc.

References _total_area, is_in_range(), and fastjet::twopi.

                                                                      {

      int count = 0;
      double deltaphi = twopi/double(npoints);
      double deltarap = 2.0*rapmax/double(npoints);
      double phi = 0.0;
      for(int i = 0; i < npoints; i++) {
        double rap = -rapmax;
        for (int j = 0; j < npoints; j++) {
          if ( is_in_range(rap,phi) ) { count++; }
          rap += deltarap;
        }
        phi += deltaphi;
      }

      _total_area = double(count)/double(npoints*npoints)*2.0*twopi*rapmax;
}

---

Member Data Documentation

double fastjet::RangeDefinition::_total_area [protected]

Definition at line 111 of file RangeDefinition.hh.

Referenced by _numerical_total_area().

double fastjet::RangeDefinition::_rapmin [private]

Definition at line 120 of file RangeDefinition.hh.

double fastjet::RangeDefinition::_rapmax [private]

Definition at line 120 of file RangeDefinition.hh.

double fastjet::RangeDefinition::_phimin [private]

Definition at line 120 of file RangeDefinition.hh.

double fastjet::RangeDefinition::_phimax [private]

Definition at line 120 of file RangeDefinition.hh.

---

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

• include/fastjet/RangeDefinition.hh
• src/RangeDefinition.cc