CircularRange Class Reference

#include <CircularRange.hh>

Public Member Functions
	CircularRange ()
	constructor
	CircularRange (const fastjet::PseudoJet &jet, double distance)
	initialise CircularRange with a jet
	CircularRange (double rap, double phi, double distance)
	initialise CircularRange with a (rap,phi) point
	CircularRange (double distance)
	initialise CircularRange with just the radius parameter
virtual	~CircularRange ()
	destructor
virtual std::string	description () const
	return description of range
virtual bool	is_localizable () const
	returns true since this range is localizable (i.e.
virtual bool	is_in_range (double rap, double phi) const
	return bool according to whether (rap,phi) is in range
virtual void	get_rap_limits (double &rapmin, double &rapmax) const
	return the minimal and maximal rapidity of this range
Private Member Functions
void	_set_invalid_rapphi ()
	set internal phi so as to mark things as invalid
bool	_rapphi_are_valid () const
	true if rap,phi are valid (tests only phi)
Private Attributes
double	_distance
Static Private Attributes
static const double	_invalid_phi = -1000.0
	value for phi that marks it as invalid

Detailed Description

Definition at line 40 of file CircularRange.hh.

Constructor & Destructor Documentation

CircularRange::CircularRange ( ) [inline]

constructor

Definition at line 43 of file CircularRange.hh.

References _set_invalid_rapphi().

00043 {_set_invalid_rapphi();}

CircularRange::CircularRange	(	const fastjet::PseudoJet &	jet,
		double	distance
	)			`[inline]`

initialise CircularRange with a jet

Definition at line 46 of file CircularRange.hh.

References _distance, and fastjet::pi.

00046                                                                {
00047                 _distance = distance;
00048                 _rapjet = jet.rap();
00049                 _phijet = jet.phi();
00050                 _total_area = fastjet::pi*_distance*_distance;  }

CircularRange::CircularRange	(	double	rap,
		double	phi,
		double	distance
	)			`[inline]`

initialise CircularRange with a (rap,phi) point

Definition at line 53 of file CircularRange.hh.

References _distance, and fastjet::pi.

00053                                                          {
00054                 _distance = distance;
00055                 _rapjet = rap;
00056                 _phijet = phi;
00057                 _total_area = fastjet::pi*_distance*_distance;  }

CircularRange::CircularRange ( double distance ) [inline]

initialise CircularRange with just the radius parameter

Definition at line 60 of file CircularRange.hh.

References _distance, _set_invalid_rapphi(), and fastjet::pi.

00060                                  {
00061                 _set_invalid_rapphi();
00062                 _distance = distance;
00063                 _total_area = fastjet::pi*_distance*_distance;  }

virtual CircularRange::~CircularRange ( ) [inline, virtual]

destructor

Definition at line 66 of file CircularRange.hh.

00066 {}

Member Function Documentation

bool CircularRange::_rapphi_are_valid ( ) const [inline, private]

true if rap,phi are valid (tests only phi)

Definition at line 103 of file CircularRange.hh.

References _invalid_phi.

Referenced by is_in_range().

00103 {return _phijet != _invalid_phi;}

void CircularRange::_set_invalid_rapphi ( ) [inline, private]

set internal phi so as to mark things as invalid

Definition at line 101 of file CircularRange.hh.

References _invalid_phi.

Referenced by CircularRange().

00101 {_phijet = _invalid_phi;}

virtual std::string CircularRange::description ( ) const [inline, virtual]

return description of range

Definition at line 69 of file CircularRange.hh.

References _distance.

00069                                                {
00070     std::ostringstream ostr;
00071     ostr << "CircularRange: within distance "<< _distance << " of given jet or point." ;
00072     return ostr.str(); }

virtual void CircularRange::get_rap_limits	(	double &	rapmin,
		double &	rapmax
	)			const `[inline, virtual]`

return the minimal and maximal rapidity of this range

Definition at line 91 of file CircularRange.hh.

References _distance.

00091                                                                              {
00092      rapmin = _rapjet - _distance;
00093      rapmax = _rapjet + _distance; }

virtual bool CircularRange::is_in_range	(	double	rap,
		double	phi
	)			const `[inline, virtual]`

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

Definition at line 79 of file CircularRange.hh.

References _distance, _rapphi_are_valid(), fastjet::pi, and twopi.

00079                                                                 {
00080      if (! _rapphi_are_valid()) {
00081        throw Error("Circular range used without a center having being defined (use set_position())");
00082      }
00083      double deltaphi = _phijet - phi;
00084      if ( deltaphi > pi) { deltaphi -= twopi; }
00085      else if ( deltaphi < -pi) { deltaphi += twopi; }
00086      bool inrange = ( (rap-_rapjet)*(rap-_rapjet) +
00087                 deltaphi*deltaphi <= _distance*_distance );
00088      return inrange; }