CaloNavigator< T, TOPO > Class Template Reference

#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

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.

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

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

Member Function Documentation

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.

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

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

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.

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

Referenced by CosmicClusterAlgo::checkMaxima(), Multi5x5ClusterAlgo::checkMaxima(), EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), HybridClusterAlgo::makeDomino(), PreshowerClusterAlgo::makeOneCluster(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), CaloNavigator< T, TOPO >::offsetBy(), and IslandClusterAlgo::searchEast().

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

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.

References CaloNavigator< T, TOPO >::myTopology_.

{ return myTopology_; }

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.

Referenced by spr::chargeIsolation(), CosmicClusterAlgo::checkMaxima(), Multi5x5ClusterAlgo::checkMaxima(), ClusterShapeAlgo::Create_Map(), HybridClusterAlgo::e2Et(), HybridClusterAlgo::et25(), EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), HybridClusterAlgo::mainSearch(), HybridClusterAlgo::makeDomino(), PreshowerClusterAlgo::makeOneCluster(), CosmicClusterAlgo::prepareCluster(), Multi5x5ClusterAlgo::prepareCluster(), EEBadScFilter::scan5x5(), IslandClusterAlgo::searchEast(), IslandClusterAlgo::searchWest(), EcalMipGraphs::selectHits(), and EcalDisplaysByEvent::selectHits().

                                               {
  currentPoint_ = startingPoint_;
}

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.

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

Referenced by CosmicClusterAlgo::checkMaxima(), Multi5x5ClusterAlgo::checkMaxima(), EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), HybridClusterAlgo::mainSearch(), PreshowerClusterAlgo::makeOneCluster(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), CaloNavigator< T, TOPO >::offsetBy(), and IslandClusterAlgo::searchNorth().

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

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.

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 spr::chargeIsolation(), ClusterShapeAlgo::Create_Map(), HybridClusterAlgo::e2Et(), HybridClusterAlgo::et25(), CosmicClusterAlgo::prepareCluster(), Multi5x5ClusterAlgo::prepareCluster(), EEBadScFilter::scan5x5(), EcalMipGraphs::selectHits(), and EcalDisplaysByEvent::selectHits().

                                           {
    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_;
  }

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.

References CaloNavigator< T, TOPO >::currentPoint_.

{ return currentPoint_; }

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.

References CaloNavigator< T, TOPO >::currentPoint_.

Referenced by CosmicClusterAlgo::checkMaxima(), Multi5x5ClusterAlgo::checkMaxima(), EcalBoundaryInfoCalculator< EBDetId >::goBackOneCell(), HybridClusterAlgo::makeDomino(), IslandClusterAlgo::searchEast(), IslandClusterAlgo::searchNorth(), IslandClusterAlgo::searchSouth(), and IslandClusterAlgo::searchWest().

{ return currentPoint_; }

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.

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

                                                                  {
  startingPoint_ = startingPoint;
  home();
}

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;
}

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.

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

Referenced by CosmicClusterAlgo::checkMaxima(), Multi5x5ClusterAlgo::checkMaxima(), EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), HybridClusterAlgo::mainSearch(), PreshowerClusterAlgo::makeOneCluster(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), CaloNavigator< T, TOPO >::offsetBy(), and IslandClusterAlgo::searchSouth().

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

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.

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

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

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.

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

Referenced by CosmicClusterAlgo::checkMaxima(), Multi5x5ClusterAlgo::checkMaxima(), EndcapPiZeroDiscriminatorAlgo::findPi0Road(), PreshowerClusterAlgo::findRoad(), EcalClusterLazyToolsBase::getESHits(), HybridClusterAlgo::makeDomino(), PreshowerClusterAlgo::makeOneCluster(), EcalBoundaryInfoCalculator< EBDetId >::makeStepInDirection(), CaloNavigator< T, TOPO >::offsetBy(), and IslandClusterAlgo::searchWest().

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

Member Data Documentation

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().

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().

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::startingPoint_

mutableprotected

Definition at line 86 of file CaloNavigator.h.