CircularRange.hh

//FJSTARTHEADER
// $Id$
//
// Copyright (c) 2005-2026, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
//
//----------------------------------------------------------------------
// 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. They are described in the original FastJet paper,
//  hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
//  FastJet as part of work towards a scientific publication, please
//  quote the version you use and include a citation to the manual and
//  optionally also to hep-ph/0512210.
//
//  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, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------
//FJENDHEADER
 
 
#ifndef __FASTJET_CIRCULARRANGE_HH__
#define __FASTJET_CIRCULARRANGE_HH__
 
#include "fastjet/RangeDefinition.hh"
#include "fastjet/Error.hh"
#include "fastjet/internal/deprecated.hh"
 
// for backwards compatibility: one should now use SelectorCircle,
// defined in fastjet/Selector.hh, instead CircularRange
#warning This file includes fastjet/CircularRange.hh, \
a deprecated FastJet header provided only for backward compatibility. \
This is not guaranteed to work in future releases of FastJet. \
From FastJet 3.0 onwards, please consider using Selector, defined in \
fastjet/Selector.hh, instead of RangeDefinition and, in particular, \
SelectorCircle instead of CircularRange.
 
FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
 
class CircularRange : public fastjet::RangeDefinition {
public:
  /// constructor
  FASTJET_DEPRECATED_MSG("CircularRange is deprecated since FastJet 3.0. Use SelectorCircle instead",
  CircularRange()) {_set_invalid_rapphi();}
  
  /// initialise CircularRange with a jet
  FASTJET_DEPRECATED_MSG("CircularRange is deprecated since FastJet 3.0. Use SelectorCircle instead",
  CircularRange(const fastjet::PseudoJet & jet, double distance)) {
                _distance = distance;
                _rapjet = jet.rap();
                _phijet = jet.phi();
                _total_area = fastjet::pi*_distance*_distance;  }
 
  /// initialise CircularRange with a (rap,phi) point
  FASTJET_DEPRECATED_MSG("CircularRange is deprecated since FastJet 3.0. Use SelectorCircle instead",
  CircularRange(double rap, double phi, double distance)) {
                _distance = distance;
                _rapjet = rap;
                _phijet = phi;
                _total_area = fastjet::pi*_distance*_distance;  }
 
  /// initialise CircularRange with just the radius parameter
  FASTJET_DEPRECATED_MSG("CircularRange is deprecated since FastJet 3.0. Use SelectorCircle instead",
  CircularRange(double distance)) {
                _set_invalid_rapphi();
                _distance = distance;
                _total_area = fastjet::pi*_distance*_distance;  }
  
  /// destructor
  virtual ~CircularRange() {}
  
  /// return description of range
  virtual inline std::string description() const FASTJET_OVERRIDE {
    std::ostringstream ostr;
    ostr << "CircularRange: within distance "<< _distance << " of given jet or point." ;
    return ostr.str(); }
 
  /// returns true since this range is localizable (i.e. set_position
  /// does something meaningful)
  virtual inline bool is_localizable() const FASTJET_OVERRIDE { return true; }
  
  /// return bool according to whether (rap,phi) is in range
  virtual inline bool is_in_range(double rap, double phi) const FASTJET_OVERRIDE {
     if (! _rapphi_are_valid()) {
       throw Error("Circular range used without a center having being defined (use set_position())");
     }
     double deltaphi = _phijet - phi;
     if ( deltaphi > pi) { deltaphi -= twopi; }
     else if ( deltaphi < -pi) { deltaphi += twopi; }
     bool inrange = ( (rap-_rapjet)*(rap-_rapjet) +
                deltaphi*deltaphi <= _distance*_distance );
     return inrange; }
 
  /// return the minimal and maximal rapidity of this range
  virtual inline void get_rap_limits(double & rapmin, double & rapmax) const FASTJET_OVERRIDE {
     rapmin = _rapjet - _distance;
     rapmax = _rapjet + _distance; }
 
private:
  double _distance;
 
  /// value for phi that marks it as invalid
  FASTJET_WINDLL const static double _invalid_phi = -1000.0;
  /// set internal phi so as to mark things as invalid
  void _set_invalid_rapphi() {_phijet = _invalid_phi;}
  /// true if rap,phi are valid (tests only phi)
  bool _rapphi_are_valid() const {return _phijet != _invalid_phi;}
};
 
FASTJET_END_NAMESPACE
 
#endif // __FASTJET_CIRCULARRANGE_HH__