PhiFilterRange implements the range (ie: [min, max]) the filters will use to take their filtering decisions. More...

#include <PhiFilterRange.h>

Inheritance diagram for PhiFilterRange:

Collaboration diagram for PhiFilterRange:

Public Member Functions
	PhiFilterRange ()
	Default constructor: it sets the minimum value to -infinity and the maximum value to +infinity. More...

	PhiFilterRange (const PhiFilterRange &range)
	Copy constructor: More...

	PhiFilterRange (const double min, const double max)
	Constructor with parameters: More...

virtual	~PhiFilterRange ()
	Destructor: More...

PhiFilterRange &	operator= (const PhiFilterRange &obj)
	Assignment operator: More...

double	lower () const
	Return the minimum value of the range. More...

double	upper () const
	Return the maximum value of the range. More...

double	getMin () const
	Return the minimum value of the range. More...

double	getMax () const
	Return the maximum value of the range. More...

bool	isInRange (const double point) const
	Const methods: More...

bool	isActive () const
	return Return true if the range is active (optimize parsing of multiple ranges and returning the final decision) More...

double	atlasPhi (const double phi) const
	Convert a phi angle in the ATLAS conventional range -PI->PI inspired from FourMom package (could also use CaloPhiRange) More...

void	setRange (const double lower, const double upper)
	Non-const methods: More...

void	setMin (const double minValue)

void	setMax (const double maxValue)

void	include (const double xMin, const double xMax)
	Add [xMin, xMax] interval to existing set of valid ranges. More...

void	includeAll ()
	Set full range (from MINUS_INF to PLUS_INF ). More...

double	precision () const
	Return the double precision for the comparaison of doubles. More...

double	PLUS_INF () const
	Define +infinity according to specific implementation. More...

double	MINUS_INF () const
	Define -infinity according to specific implementation. More...

void	setPrecision (const double delta)

Protected Types
typedef boost::numeric::interval< double >	interval_t

Protected Member Functions
void	addRange (double xMin, double xMax)
	add a new range [xmin,xmax] deleting previous ranges full contained More...

Protected Attributes
std::optional< interval_t >	m_range
	The boost interval wrapped by a boost optional. More...

double	m_precision
	Setup the wanted double precision. More...

Detailed Description

PhiFilterRange implements the range (ie: [min, max]) the filters will use to take their filtering decisions.

It is a specialisation of FilterRange for the phi angles. It enforces the ATLAS policy for phi angles : \( \phi \in [-\pi,\pi[ \)

Internally it uses the Boost class interval but maybe one could use a SEAL class (FML/RangeSet or FML/Bound)

Definition at line 29 of file PhiFilterRange.h.

Member Typedef Documentation

◆ interval_t

typedef boost::numeric::interval<double> FilterRange::interval_t

protectedinherited

Definition at line 142 of file FilterRange.h.

Constructor & Destructor Documentation

◆ PhiFilterRange() [1/3]

PhiFilterRange::PhiFilterRange ( )

inline

Default constructor: it sets the minimum value to -infinity and the maximum value to +infinity.

Inline methods:

Constructors

Definition at line 141 of file PhiFilterRange.h.

                                       :
   FilterRange()
 {}

◆ PhiFilterRange() [2/3]

PhiFilterRange::PhiFilterRange ( const PhiFilterRange & range )

Copy constructor:

Public methods:

Copy constructor

Definition at line 26 of file PhiFilterRange.cxx.

                                                             :
   FilterRange( range )
 {}

◆ PhiFilterRange() [3/3]

PhiFilterRange::PhiFilterRange	(	const double	min,
		const double	max
	)

inline

Constructor with parameters:

Parameters

min	: the minimum value of the range
max	: the maximum value of the range

Definition at line 145 of file PhiFilterRange.h.

                                                                           :
   FilterRange( min, max )
 {
   if ( min == -M_PI && max == +M_PI ) {
     //std::cout << ">>> You are giving a NO-OP interval : ]"
     //      << min << "; "
     //      << max << "["
     //      << std::endl
     //      << ">>> De-activating this range for optimization purpose."
     //      << std::endl;
     m_range = std::nullopt;
     if ( isActive() ) {
       std::string err = "ERROR : PhiFilterRange is ACTIVE (Should NOT BE !!)";
       throw err;
     }
   } else {
     // Do nothing : everything is allright
   }
 }

◆ ~PhiFilterRange()

PhiFilterRange::~PhiFilterRange ( )

inlinevirtual

Destructor:

Destructor.

Definition at line 167 of file PhiFilterRange.h.

167 {}

Member Function Documentation

◆ addRange()

void PhiFilterRange::addRange	(	double	xMin,
		double	xMax
	)

protected

add a new range [xmin,xmax] deleting previous ranges full contained

Special case where one adds a no-op interval

Take care of inversion of bounds because of the moduli

Definition at line 84 of file PhiFilterRange.cxx.

 { 
   if ( (xMin == -M_PI    && xMax == +M_PI    ) ||
        (xMin == -FLT_MAX && xMax == +FLT_MAX ) ) {
     m_range = std::nullopt;
     return;
   }
  
   const double phiMin = atlasPhi( xMin );
   const double phiMax = atlasPhi( xMax );
   
   if ( phiMin < phiMax ) {
     m_range = interval_t( phiMin, phiMax );
   } else {
     m_range = interval_t( phiMax, phiMin );
   }
 }

◆ atlasPhi()

double PhiFilterRange::atlasPhi ( const double phi ) const

Convert a phi angle in the ATLAS conventional range -PI->PI inspired from FourMom package (could also use CaloPhiRange)

Definition at line 49 of file PhiFilterRange.cxx.

 {
   if ( M_PI == std::fabs(phi) ) {
     return phi;
   }
   if ( FLT_MAX != std::fabs(phi) ) {
     return std::fmod( phi + 3*M_PI, 2*M_PI ) - M_PI;
   } else {
     if ( phi > 0. ) {
       return M_PI;
     } else {
       return -M_PI;
     }
   }
 }

◆ getMax()

double PhiFilterRange::getMax ( ) const

inline

Return the maximum value of the range.

Definition at line 195 of file PhiFilterRange.h.

 {
   return upper();
 }

◆ getMin()

double PhiFilterRange::getMin ( ) const

inline

Return the minimum value of the range.

Definition at line 190 of file PhiFilterRange.h.

 {
   return lower();
 }

◆ include()

void PhiFilterRange::include	(	const double	xMin,
		const double	xMax
	)

Add [xMin, xMax] interval to existing set of valid ranges.

Non-const methods:

Parameters

xMin	- lower bound of a new valid range
xMax	- upper bound of a new valid range

Reset the whole range : this is temporary, just to mimic FML::RangeSet API

Definition at line 68 of file PhiFilterRange.cxx.

 { 
   addRange(xMin,xMax); 
 }

◆ includeAll()

void PhiFilterRange::includeAll ( )

Set full range (from MINUS_INF to PLUS_INF ).

Definition at line 75 of file PhiFilterRange.cxx.

 { 
   m_range = std::nullopt;
   return;
 }

◆ isActive()

bool PhiFilterRange::isActive ( ) const

inline

return Return true if the range is active (optimize parsing of multiple ranges and returning the final decision)

Definition at line 200 of file PhiFilterRange.h.

 {
   if ( m_range ) return true;
   return false;
 }

◆ isInRange()

bool PhiFilterRange::isInRange ( const double point ) const

Const methods:

Definition at line 43 of file PhiFilterRange.cxx.

 { 
   // check if point is in range
   return FilterRange::isInRange( atlasPhi(point) ); 
 }

◆ lower()

double PhiFilterRange::lower ( ) const

inline

Return the minimum value of the range.

Const methods:

Definition at line 172 of file PhiFilterRange.h.

 {
   if ( m_range ) {
     return m_range->lower();
   }
  
   return -M_PI;
 }

◆ MINUS_INF()

double FilterRange::MINUS_INF ( ) const

inlineinherited

Define -infinity according to specific implementation.

Definition at line 242 of file FilterRange.h.

 {
   return -FLT_MAX;
 }

◆ operator=()

PhiFilterRange & PhiFilterRange::operator= ( const PhiFilterRange & obj )

Assignment operator:

Assignment operator.

Definition at line 31 of file PhiFilterRange.cxx.

 {
   if ( this != &range ) {
     FilterRange::operator=(range);
   }
  
   return *this;
 }

◆ PLUS_INF()

double FilterRange::PLUS_INF ( ) const

inlineinherited

Define +infinity according to specific implementation.

Definition at line 237 of file FilterRange.h.

 {
   return FLT_MAX;
 }

◆ precision()

double FilterRange::precision ( ) const

inlineinherited

Return the double precision for the comparaison of doubles.

Definition at line 204 of file FilterRange.h.

 {
   return m_precision;
 }

◆ setMax()

void PhiFilterRange::setMax ( const double maxValue )

inline

Definition at line 219 of file PhiFilterRange.h.

 {
   return setRange( getMin(), maxValue );
 }

◆ setMin()

void PhiFilterRange::setMin ( const double minValue )

inline

Definition at line 214 of file PhiFilterRange.h.

 {
   return setRange( minValue, getMax() );
 }

◆ setPrecision()

void FilterRange::setPrecision ( const double delta )

inlineinherited

Definition at line 256 of file FilterRange.h.

 {
   m_precision = delta;
 }

◆ setRange()

void PhiFilterRange::setRange	(	const double	lower,
		const double	upper
	)

inline

Non-const methods:

Definition at line 209 of file PhiFilterRange.h.

 {
   return addRange( lower, upper );
 }

◆ upper()

double PhiFilterRange::upper ( ) const

inline

Return the maximum value of the range.

Definition at line 181 of file PhiFilterRange.h.

 {
   if ( m_range ) {
     return m_range->upper();
   }
  
   return +M_PI;
 }

Member Data Documentation

◆ m_precision

double FilterRange::m_precision

protectedinherited

Setup the wanted double precision.

Default = 1e-6

Definition at line 151 of file FilterRange.h.

◆ m_range

std::optional<interval_t> FilterRange::m_range

protectedinherited

The boost interval wrapped by a boost optional.

This is to allow the instantiation of uninitialised ranges

Definition at line 147 of file FilterRange.h.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ interval_t

Constructor & Destructor Documentation

◆ PhiFilterRange() [1/3]

◆ PhiFilterRange() [2/3]

◆ PhiFilterRange() [3/3]

◆ ~PhiFilterRange()

Member Function Documentation

◆ addRange()

◆ atlasPhi()

◆ getMax()

◆ getMin()

◆ include()

◆ includeAll()

◆ isActive()

◆ isInRange()

◆ lower()

◆ MINUS_INF()

◆ operator=()

◆ PLUS_INF()

◆ precision()

◆ setMax()

◆ setMin()

◆ setPrecision()

◆ setRange()

◆ upper()

Member Data Documentation

◆ m_precision

◆ m_range