LVL1::CoordinateRange Class Reference

CoordinateRange class declaration. More...

#include <CoordinateRange.h>

Inheritance diagram for LVL1::CoordinateRange:

Collaboration diagram for LVL1::CoordinateRange:

Public Member Functions
	CoordinateRange (double phiMin, double phiMax, double etaMin, double etaMax)
	CoordinateRange ()
virtual	~CoordinateRange ()=default
void	setRanges (double phiMin, double phiMax, double etaMin, double etaMax)
	change coords of an existing CoordinateRange object
PhiRange	phiRange () const
Range	etaRange () const
bool	contains (Coordinate &coord) const
	returns true if the coordinate falls inside the coordinate range
void	setCoords (double phi, double eta)
	change coords of an existing Coordinate object
double	eta () const
	return eta
double	phi () const
	return phi

Protected Member Functions
void	checkBounds ()
	Ensure coords are sensible this could be done more intelligently, but at least it's readable!

Private Member Functions
void	setCentre ()
	calculates the centre of the ranges and sets the phi,eta coords to that

Private Attributes
PhiRange	m_phiRange
Range	m_etaRange
double	m_phi
double	m_eta

Static Private Attributes
static const double	m_twoPi = M_PI * 2.0

Detailed Description

CoordinateRange class declaration.

Class defining a "window" in eta–phi space.

Revision

734527

Date

2016-04-07 13:43:47 +0200 (Thu, 07 Apr 2016)

Definition at line 31 of file CoordinateRange.h.

Constructor & Destructor Documentation

CoordinateRange() [1/2]

LVL1::CoordinateRange::CoordinateRange	(	double	phiMin,
		double	phiMax,
		double	etaMin,
		double	etaMax )

Definition at line 15 of file CoordinateRange.cxx.

    : m_phiRange(phiMin, phiMax), m_etaRange(etaMin, etaMax) {
  checkBounds();
  setCentre();
}

CoordinateRange() [2/2]

LVL1::CoordinateRange::CoordinateRange

(

)

Definition at line 22 of file CoordinateRange.cxx.

    : m_phiRange(0.0, 0.0), m_etaRange(0.0, 0.0) {}

~CoordinateRange()

virtual LVL1::CoordinateRange::~CoordinateRange ( )

virtualdefault

Member Function Documentation

checkBounds()

void LVL1::Coordinate::checkBounds ( )

protectedinherited

Ensure coords are sensible this could be done more intelligently, but at least it's readable!

Todo

Tidy up and finish

Definition at line 52 of file Coordinate.cxx.

                               {
    if ( m_phi < 0 ) m_phi += m_twoPi;
    if ( m_phi > m_twoPi ) m_phi -= m_twoPi;
    return;
  }

contains()

bool LVL1::CoordinateRange::contains

(

Coordinate &

coord

)

const

returns true if the coordinate falls inside the coordinate range

Definition at line 40 of file CoordinateRange.cxx.

                                                      {
  return ((phiRange().contains(coord.phi())) &&
          (etaRange().contains(coord.eta())));
}

eta()

double LVL1::Coordinate::eta ( ) const

inherited

return eta

Definition at line 40 of file Coordinate.cxx.

                               {
    return m_eta;
  }

etaRange()

Range LVL1::CoordinateRange::etaRange

(

)

const

Definition at line 37 of file CoordinateRange.cxx.

{ return m_etaRange; }

phi()

double LVL1::Coordinate::phi ( ) const

inherited

return phi

Definition at line 45 of file Coordinate.cxx.

                               {
    return m_phi;
  }

phiRange()

PhiRange LVL1::CoordinateRange::phiRange

(

)

const

Definition at line 35 of file CoordinateRange.cxx.

{ return m_phiRange; }

setCentre()

void LVL1::CoordinateRange::setCentre ( )

private

calculates the centre of the ranges and sets the phi,eta coords to that

Definition at line 46 of file CoordinateRange.cxx.

                                    {
  double phi = m_phiRange.centre();
  double eta = m_etaRange.min() + ((m_etaRange.max() - m_etaRange.min()) / 2);
 
  Coordinate::setCoords(phi, eta);
  return;
}

setCoords()

void LVL1::Coordinate::setCoords ( double phi, double eta )

inherited

change coords of an existing Coordinate object

Definition at line 31 of file Coordinate.cxx.

                                                     {
 
    m_phi = phi; m_eta = eta;
    checkBounds();
    return;
 
  }

setRanges()

void LVL1::CoordinateRange::setRanges	(	double	phiMin,
		double	phiMax,
		double	etaMin,
		double	etaMax )

change coords of an existing CoordinateRange object

Definition at line 26 of file CoordinateRange.cxx.

                                               {
  m_phiRange.setRange(phiMin, phiMax);
  m_etaRange.setRange(etaMin, etaMax);
  checkBounds();
  setCentre();
  return;
}

Member Data Documentation

m_eta

double LVL1::Coordinate::m_eta

privateinherited

Definition at line 66 of file TrigT1/TrigT1Interfaces/TrigT1Interfaces/Coordinate.h.

m_etaRange

Range LVL1::CoordinateRange::m_etaRange

private

Definition at line 48 of file CoordinateRange.h.

m_phi

double LVL1::Coordinate::m_phi

privateinherited

Definition at line 65 of file TrigT1/TrigT1Interfaces/TrigT1Interfaces/Coordinate.h.

m_phiRange

PhiRange LVL1::CoordinateRange::m_phiRange

private

Definition at line 47 of file CoordinateRange.h.

m_twoPi

const double LVL1::Coordinate::m_twoPi = M_PI * 2.0

staticprivateinherited

Definition at line 67 of file TrigT1/TrigT1Interfaces/TrigT1Interfaces/Coordinate.h.

---

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

• CoordinateRange.h
• CoordinateRange.cxx