LVL1::PhiRange Class Reference

Range class declaration. More...

#include <PhiRange.h>

Collaboration diagram for LVL1::PhiRange:

Public Member Functions
	PhiRange ()
	PhiRange (double min, double max)
	~PhiRange ()=default
double	min () const
double	max () const
void	setRange (double min, double max)
	sets range
bool	contains (double number) const
	returns true if the range contains the number (i.e.
double	centre () const
	returns the centre of the two ranges.

Private Member Functions
void	checkValues ()
	This function makes sure m_min really is less than m_max.

Private Attributes
double	m_min
double	m_max

Detailed Description

Range class declaration.

Definition at line 17 of file PhiRange.h.

Constructor & Destructor Documentation

PhiRange() [1/2]

LVL1::PhiRange::PhiRange

(

)

Definition at line 19 of file PhiRange.cxx.

    : m_min( 0.0 ), m_max( 0.0 ) {
 
  }

PhiRange() [2/2]

LVL1::PhiRange::PhiRange	(	double	min,
		double	max )

Definition at line 24 of file PhiRange.cxx.

    : m_min( min ), m_max( max ) {
 
    checkValues();
  }

~PhiRange()

LVL1::PhiRange::~PhiRange ( )

default

Member Function Documentation

centre()

double LVL1::PhiRange::centre

(

)

const

returns the centre of the two ranges.

The ranges are assumed to be <PI. If this is not true, then this function will return a centre opposite the true centre.

Definition at line 93 of file PhiRange.cxx.

                                    {
    double diff = fabs( m_min - m_max );
    if ( diff > M_PI ) {
      // range must overlap 2PI
      double cent = ( m_min + ( m_max - m_min + 2 * M_PI ) / 2 );
      if ( cent < 0.0 )            return ( 2.0 * M_PI ) + cent;
      if ( cent > ( 2.0 * M_PI ) ) return cent -( 2.0 * M_PI );
      return cent;
    }
    // diff must be <=M_PI
    return ( m_min + ( ( m_max - m_min ) / 2 ) );
 
  }

checkValues()

void LVL1::PhiRange::checkValues ( )

private

This function makes sure m_min really is less than m_max.

This function makes sure m_min really is less than m_max, and checks that phi values are sensible.

Definition at line 63 of file PhiRange.cxx.

                             {
    // should really check for more extreme values.
 
//    double & tmpMin = m_min;
//    double& tmpMax = m_max;
 
    if ( m_min < 0.0 ) m_min = ( 2.0 * M_PI ) + m_min;
    if ( m_max > ( 2.0 * M_PI ) ) m_max -= ( 2.0 * M_PI );
 
    if ( fabs(m_min-m_max) > M_PI) {
      // RoI range must span 2PI wraparound. In which case m_min should have higher value, m_max lower
      if (m_min < m_max) {
         // swap them
         double temp = m_max;
         m_max = m_min;
         m_min = temp;        
      }
    }
    else if ( m_min >= m_max ) {
      // swap them
      double temp = m_max;
      m_max = m_min;
      m_min = temp;
    }
    //  }
    return;
  }

contains()

bool LVL1::PhiRange::contains

(

double

number

)

const

returns true if the range contains the number (i.e.

if min<=number<=max)

if min<=number<=max). Because with phi ranges it loops at phi=2PI, the assumption is made that phiMax-phiMin<PI. If this is not true, the output from this method will be wrong!

Definition at line 50 of file PhiRange.cxx.

                                               {
 
    double diff = fabs( m_min - m_max );
    if ( diff > M_PI ) {
      // range must overlap 2PI
      return ( ( m_min <= number && number <= ( 2 * M_PI ) )
               || ( ( 0 <= number && number <= m_max ) ) );
    }
    // diff must be <=M_PI
    return ( ( m_min <= number ) && ( number <= m_max ) );
  }

max()

double LVL1::PhiRange::max

(

)

const

Definition at line 34 of file PhiRange.cxx.

                             {
    return m_max;
  }

min()

double LVL1::PhiRange::min

(

)

const

Definition at line 30 of file PhiRange.cxx.

                             {
    return m_min;
  }

setRange()

void LVL1::PhiRange::setRange	(	double	min,
		double	max )

sets range

Definition at line 39 of file PhiRange.cxx.

                                                  {
    m_min = min;
    m_max = max;
    checkValues();
  }

Member Data Documentation

m_max

double LVL1::PhiRange::m_max

private

Definition at line 40 of file PhiRange.h.

m_min

double LVL1::PhiRange::m_min

private

Definition at line 39 of file PhiRange.h.

---

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

• PhiRange.h
• PhiRange.cxx