#include <CaloNavigator.h>

Public Member Functions
	CaloNavigator (const T &home, const TOPO *topology)

T	down () const
	move the navigator west More...

T	east () const
	move the navigator east More...

const TOPO *	getTopology () const
	set the starting position More...

void	home () const
	move the navigator back to the starting point More...

T	north () const
	move the navigator north More...

T	offsetBy (int deltaX, int deltaY) const
	Free movement of arbitray steps. More...

T	operator* () const
	get the current position More...

T	pos () const
	get the current position More...

void	setHome (const T &startingPoint)
	set the starting position More...

void	setTopology (const TOPO *)
	set the starting position More...

T	south () const
	move the navigator south More...

T	up () const
	move the navigator west More...

T	west () const
	move the navigator west More...

Protected Attributes
T	currentPoint_

const TOPO *	myTopology_

T	startingPoint_

Detailed Description

template<class T, class TOPO = CaloSubdetectorTopology>
class CaloNavigator< T, TOPO >

Definition at line 7 of file CaloNavigator.h.

Constructor & Destructor Documentation

◆ CaloNavigator()

template<class T, class TOPO = CaloSubdetectorTopology>

CaloNavigator< T, TOPO >::CaloNavigator	(	const T &	home,
		const TOPO *	topology
	)

inline

Definition at line 9 of file CaloNavigator.h.

9 : myTopology_(topology) { setHome(home); }

References CaloNavigator< T, TOPO >::home(), and CaloNavigator< T, TOPO >::setHome().

Member Function Documentation

◆ down()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::down ( ) const

inline

move the navigator west

Definition at line 60 of file CaloNavigator.h.

                  {
     currentPoint_ = myTopology_->goDown(currentPoint_);
     return currentPoint_;
   };

References CaloNavigator< T, TOPO >::currentPoint_, and CaloNavigator< T, TOPO >::myTopology_.

◆ east()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::east ( ) const

inline

move the navigator east

Definition at line 42 of file CaloNavigator.h.

                  {
     currentPoint_ = myTopology_->goEast(currentPoint_);
     return currentPoint_;
   };

References CaloNavigator< T, TOPO >::currentPoint_, and CaloNavigator< T, TOPO >::myTopology_.

Referenced by EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), and CaloNavigator< T, TOPO >::offsetBy().

◆ getTopology()

template<class T, class TOPO = CaloSubdetectorTopology>

const TOPO* CaloNavigator< T, TOPO >::getTopology ( ) const

inline

set the starting position

Definition at line 18 of file CaloNavigator.h.

18 { return myTopology_; }

References CaloNavigator< T, TOPO >::myTopology_.

◆ home()

template<class T , class TOPO >

void CaloNavigator< T, TOPO >::home ( ) const

inline

move the navigator back to the starting point

Definition at line 96 of file CaloNavigator.h.

                                                {
   currentPoint_ = startingPoint_;
 }

Referenced by CaloNavigator< T, TOPO >::CaloNavigator(), ClusterShapeAlgo::Create_Map(), EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), EEBadScFilter::scan5x5(), IslandClusterAlgo::searchEast(), IslandClusterAlgo::searchWest(), EcalMipGraphs::selectHits(), and EcalDisplaysByEvent::selectHits().

◆ north()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::north ( ) const

inline

move the navigator north

Definition at line 30 of file CaloNavigator.h.

                   {
     currentPoint_ = myTopology_->goNorth(currentPoint_);
     return currentPoint_;
   };

References CaloNavigator< T, TOPO >::currentPoint_, and CaloNavigator< T, TOPO >::myTopology_.

Referenced by EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), and CaloNavigator< T, TOPO >::offsetBy().

◆ offsetBy()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::offsetBy	(	int	deltaX,
		int	deltaY
	)		const

inline

Free movement of arbitray steps.

Definition at line 66 of file CaloNavigator.h.

                                            {
     for (int x = 0; x < abs(deltaX) && currentPoint_ != T(0); x++) {
       if (deltaX > 0)
         east();
       else
         west();
     }
  
     for (int y = 0; y < abs(deltaY) && currentPoint_ != T(0); y++) {
       if (deltaY > 0)
         north();
       else
         south();
     }
  
     return currentPoint_;
   }

References funct::abs(), CaloNavigator< T, TOPO >::currentPoint_, CaloNavigator< T, TOPO >::east(), CaloNavigator< T, TOPO >::north(), CaloNavigator< T, TOPO >::south(), CaloNavigator< T, TOPO >::west(), x, and y.

Referenced by ClusterShapeAlgo::Create_Map(), EEBadScFilter::scan5x5(), EcalMipGraphs::selectHits(), and EcalDisplaysByEvent::selectHits().

◆ operator*()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::operator* ( void ) const

inline

get the current position

Definition at line 27 of file CaloNavigator.h.

27 { return currentPoint_; }

References CaloNavigator< T, TOPO >::currentPoint_.

◆ pos()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::pos ( ) const

inline

get the current position

Definition at line 24 of file CaloNavigator.h.

24 { return currentPoint_; }

References CaloNavigator< T, TOPO >::currentPoint_.

Referenced by EcalBoundaryInfoCalculator< EBDetId >::goBackOneCell().

◆ setHome()

template<class T , class TOPO >

void CaloNavigator< T, TOPO >::setHome ( const T & startingPoint )

inline

set the starting position

Definition at line 90 of file CaloNavigator.h.

                                                                   {
   startingPoint_ = startingPoint;
   home();
 }

Referenced by CaloNavigator< T, TOPO >::CaloNavigator(), ReducedESRecHitCollectionProducer::collectIds(), EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), and EcalBoundaryInfoCalculator< EBDetId >::goBackOneCell().

◆ setTopology()

template<class T , class TOPO >

void CaloNavigator< T, TOPO >::setTopology ( const TOPO * topology )

inline

set the starting position

Definition at line 101 of file CaloNavigator.h.

                                                                     {
   if (myTopology_ == 0)
     myTopology_ = topology;
   else
     return;
 }

References ecaldqm::topology().

◆ south()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::south ( ) const

inline

move the navigator south

Definition at line 36 of file CaloNavigator.h.

                   {
     currentPoint_ = myTopology_->goSouth(currentPoint_);
     return currentPoint_;
   };

References CaloNavigator< T, TOPO >::currentPoint_, and CaloNavigator< T, TOPO >::myTopology_.

Referenced by EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), and CaloNavigator< T, TOPO >::offsetBy().

◆ up()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::up ( ) const

inline

move the navigator west

Definition at line 54 of file CaloNavigator.h.

                {
     currentPoint_ = myTopology_->goUp(currentPoint_);
     return currentPoint_;
   };

References CaloNavigator< T, TOPO >::currentPoint_, and CaloNavigator< T, TOPO >::myTopology_.

◆ west()

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::west ( ) const

inline

move the navigator west

Definition at line 48 of file CaloNavigator.h.

                  {
     currentPoint_ = myTopology_->goWest(currentPoint_);
     return currentPoint_;
   };

References CaloNavigator< T, TOPO >::currentPoint_, and CaloNavigator< T, TOPO >::myTopology_.

Referenced by EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), and CaloNavigator< T, TOPO >::offsetBy().

Member Data Documentation

◆ currentPoint_

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::currentPoint_

mutableprotected

Definition at line 86 of file CaloNavigator.h.

Referenced by CaloNavigator< T, TOPO >::down(), CaloNavigator< T, TOPO >::east(), CaloNavigator< T, TOPO >::north(), CaloNavigator< T, TOPO >::offsetBy(), CaloNavigator< T, TOPO >::operator*(), CaloNavigator< T, TOPO >::pos(), CaloNavigator< T, TOPO >::south(), CaloNavigator< T, TOPO >::up(), and CaloNavigator< T, TOPO >::west().

◆ myTopology_

template<class T, class TOPO = CaloSubdetectorTopology>

const TOPO* CaloNavigator< T, TOPO >::myTopology_

protected

Definition at line 85 of file CaloNavigator.h.

Referenced by CaloNavigator< T, TOPO >::down(), CaloNavigator< T, TOPO >::east(), CaloNavigator< T, TOPO >::getTopology(), CaloNavigator< T, TOPO >::north(), CaloNavigator< T, TOPO >::south(), CaloNavigator< T, TOPO >::up(), and CaloNavigator< T, TOPO >::west().

◆ startingPoint_

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::startingPoint_

mutableprotected

Definition at line 86 of file CaloNavigator.h.

Public Member Functions

Protected Attributes

Detailed Description

template<class T, class TOPO = CaloSubdetectorTopology> class CaloNavigator< T, TOPO >

Constructor & Destructor Documentation

◆ CaloNavigator()

Member Function Documentation

◆ down()

◆ east()

◆ getTopology()

◆ home()

◆ north()

◆ offsetBy()

◆ operator*()

◆ pos()

◆ setHome()

◆ setTopology()

◆ south()

◆ up()

◆ west()

Member Data Documentation

◆ currentPoint_

◆ myTopology_

◆ startingPoint_

template<class T, class TOPO = CaloSubdetectorTopology>
class CaloNavigator< T, TOPO >