---

CaloNavigator< T > Class Template Reference

#include <RecoCaloTools/Navigation/interface/CaloNavigator.h>

List of all members.

Public Member Functions
	CaloNavigator (const T &home, const CaloSubdetectorTopology *topology)
	CaloNavigator (const T &home)
	CaloNavigator ()
	Default constructor.
virtual T	down () const
	move the navigator west
virtual T	east () const
	move the navigator east
const CaloSubdetectorTopology *	getTopology () const
	set the starting position
void	home () const
	move the navigator back to the starting point
virtual T	north () const
	move the navigator north
virtual T	offsetBy (int deltaX, int deltaY) const
	Free movement of arbitray steps.
T	operator * () const
	get the current position
T	pos () const
	get the current position
void	setHome (const T &startingPoint)
	set the starting position
void	setTopology (const CaloSubdetectorTopology *)
	set the starting position
virtual T	south () const
	move the navigator south
virtual T	up () const
	move the navigator west
virtual T	west () const
	move the navigator west
virtual	~CaloNavigator ()
	Default constructor.
Protected Attributes
T	currentPoint_
const CaloSubdetectorTopology *	myTopology_
T	startingPoint_

---

Detailed Description

template<class T>
class CaloNavigator< T >

Definition at line 7 of file CaloNavigator.h.

---

Constructor & Destructor Documentation

template<class T>

CaloNavigator< T >::CaloNavigator

(

)

[inline]

Default constructor.

Definition at line 11 of file CaloNavigator.h.

                  : myTopology_(0)
    {
    }

template<class T>

CaloNavigator< T >::CaloNavigator

(

const T &

home

)

[inline]

Definition at line 15 of file CaloNavigator.h.

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

template<class T>

CaloNavigator< T >::CaloNavigator	(	const T &	home,
		const CaloSubdetectorTopology *	topology
	)			[inline]

Definition at line 21 of file CaloNavigator.h.

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

template<class T>

virtual CaloNavigator< T >::~CaloNavigator

(

)

[inline, virtual]

Default constructor.

Definition at line 27 of file CaloNavigator.h.

{};

---

Member Function Documentation

template<class T>

virtual T CaloNavigator< T >::down

(

)

const [inline, virtual]

move the navigator west

Definition at line 101 of file CaloNavigator.h.

    { 
      if ((myTopology_->down(currentPoint_)).size()==1)
        currentPoint_=(myTopology_->down(currentPoint_))[0];
      else
        currentPoint_=T(0);
      return currentPoint_;
    } ;

template<class T>

virtual T CaloNavigator< T >::east

(

)

const [inline, virtual]

move the navigator east

Definition at line 71 of file CaloNavigator.h.

Referenced by Multi5x5ClusterAlgo::checkMaxima(), CosmicClusterAlgo::checkMaxima(), PreshowerClusterAlgo::findRoad(), HybridClusterAlgo::makeDomino(), PreshowerClusterAlgo::makeOneCluster(), CaloNavigator< EBDetId >::offsetBy(), and IslandClusterAlgo::searchEast().

    { 
      if ((myTopology_->east(currentPoint_)).size()==1)
        currentPoint_=(myTopology_->east(currentPoint_))[0];
      else
        currentPoint_=T(0);
      return currentPoint_;
    } ;

template<class T>

const CaloSubdetectorTopology* CaloNavigator< T >::getTopology

(

)

const [inline]

set the starting position

Definition at line 36 of file CaloNavigator.h.

    {
      return myTopology_;
    }

template<class T>

void CaloNavigator< T >::home

(

)

const [inline]

move the navigator back to the starting point

Definition at line 143 of file CaloNavigator.h.

References CaloNavigator< T >::currentPoint_, and CaloNavigator< T >::startingPoint_.

Referenced by Multi5x5ClusterAlgo::checkMaxima(), CosmicClusterAlgo::checkMaxima(), EcalClusterTools::covariances(), ClusterShapeAlgo::Create_Map(), SinglePionEfficiencyNew::eECALmatrix(), HybridClusterAlgo::et25(), PFClusterShapeAlgo::fill5x5Map(), PreshowerClusterAlgo::findRoad(), EcalClusterTools::localCovariances(), HybridClusterAlgo::mainSearch(), HybridClusterAlgo::makeDomino(), PreshowerClusterAlgo::makeOneCluster(), EcalClusterTools::matrixDetId(), EcalClusterTools::matrixEnergy(), Multi5x5ClusterAlgo::prepareCluster(), CosmicClusterAlgo::prepareCluster(), IslandClusterAlgo::searchEast(), IslandClusterAlgo::searchWest(), and CaloNavigator< T >::setHome().

{
  currentPoint_=startingPoint_;
}

template<class T>

virtual T CaloNavigator< T >::north

(

)

const [inline, virtual]

move the navigator north

Definition at line 51 of file CaloNavigator.h.

Referenced by Multi5x5ClusterAlgo::checkMaxima(), CosmicClusterAlgo::checkMaxima(), PreshowerClusterAlgo::findRoad(), HybridClusterAlgo::mainSearch(), PreshowerClusterAlgo::makeOneCluster(), CaloNavigator< EBDetId >::offsetBy(), and IslandClusterAlgo::searchNorth().

    { 
      if ((myTopology_->north(currentPoint_)).size()==1)
        currentPoint_=(myTopology_->north(currentPoint_))[0];
      else
        currentPoint_=T(0);
      return currentPoint_;
    } ;

template<class T>

virtual T CaloNavigator< T >::offsetBy	(	int	deltaX,
		int	deltaY
	)			const [inline, virtual]

Free movement of arbitray steps.

Definition at line 111 of file CaloNavigator.h.

Referenced by EcalClusterTools::covariances(), ClusterShapeAlgo::Create_Map(), SinglePionEfficiencyNew::eECALmatrix(), HybridClusterAlgo::et25(), PFClusterShapeAlgo::fill5x5Map(), EcalClusterTools::localCovariances(), EcalClusterTools::matrixDetId(), EcalClusterTools::matrixEnergy(), Multi5x5ClusterAlgo::prepareCluster(), and CosmicClusterAlgo::prepareCluster().

    {
      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>

T CaloNavigator< T >::operator *

(

void

)

const [inline]

get the current position

Definition at line 48 of file CaloNavigator.h.

{ return currentPoint_; } 

template<class T>

T CaloNavigator< T >::pos

(

)

const [inline]

get the current position

Definition at line 45 of file CaloNavigator.h.

Referenced by Multi5x5ClusterAlgo::checkMaxima(), CosmicClusterAlgo::checkMaxima(), HybridClusterAlgo::makeDomino(), IslandClusterAlgo::searchEast(), IslandClusterAlgo::searchNorth(), IslandClusterAlgo::searchSouth(), and IslandClusterAlgo::searchWest().

{ return currentPoint_; }

template<class T>

void CaloNavigator< T >::setHome

(

const T &

startingPoint

)

[inline]

set the starting position

Definition at line 136 of file CaloNavigator.h.

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

Referenced by CaloNavigator< EBDetId >::CaloNavigator(), EndcapPiZeroDiscriminatorAlgo::findPreshVector(), PreshowerClusterAlgo::findRoad(), and PreshowerClusterAlgo::makeOneCluster().

{
  startingPoint_=startingPoint;
  home();
}

template<class T>

void CaloNavigator< T >::setTopology

(

const CaloSubdetectorTopology *

topology

)

[inline]

set the starting position

Definition at line 149 of file CaloNavigator.h.

References CaloNavigator< T >::myTopology_.

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

template<class T>

virtual T CaloNavigator< T >::south

(

)

const [inline, virtual]

move the navigator south

Definition at line 61 of file CaloNavigator.h.

Referenced by Multi5x5ClusterAlgo::checkMaxima(), CosmicClusterAlgo::checkMaxima(), PreshowerClusterAlgo::findRoad(), HybridClusterAlgo::mainSearch(), PreshowerClusterAlgo::makeOneCluster(), CaloNavigator< EBDetId >::offsetBy(), and IslandClusterAlgo::searchSouth().

    { 
      if ((myTopology_->south(currentPoint_)).size()==1)
        currentPoint_=(myTopology_->south(currentPoint_))[0];
      else
        currentPoint_=T(0);
      return currentPoint_;
    } ;

template<class T>

virtual T CaloNavigator< T >::up

(

)

const [inline, virtual]

move the navigator west

Definition at line 91 of file CaloNavigator.h.

    { 
      if ((myTopology_->up(currentPoint_)).size()==1)
        currentPoint_=(myTopology_->up(currentPoint_))[0];
      else
        currentPoint_=T(0);
      return currentPoint_;
    } ;

template<class T>

virtual T CaloNavigator< T >::west

(

)

const [inline, virtual]

move the navigator west

Definition at line 81 of file CaloNavigator.h.

Referenced by Multi5x5ClusterAlgo::checkMaxima(), CosmicClusterAlgo::checkMaxima(), PreshowerClusterAlgo::findRoad(), HybridClusterAlgo::makeDomino(), PreshowerClusterAlgo::makeOneCluster(), CaloNavigator< EBDetId >::offsetBy(), and IslandClusterAlgo::searchWest().

    { 
      if ((myTopology_->west(currentPoint_)).size()==1)
        currentPoint_=(myTopology_->west(currentPoint_))[0];
      else
        currentPoint_=T(0);
      return currentPoint_;
    } ;

---

Member Data Documentation

template<class T>

T CaloNavigator< T >::currentPoint_ [mutable, protected]

Definition at line 132 of file CaloNavigator.h.

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

template<class T>

const CaloSubdetectorTopology* CaloNavigator< T >::myTopology_ [protected]

Definition at line 131 of file CaloNavigator.h.

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

template<class T>

T CaloNavigator< T >::startingPoint_ [mutable, protected]

Definition at line 132 of file CaloNavigator.h.

Referenced by CaloNavigator< T >::home(), and CaloNavigator< T >::setHome().

---

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

• RecoCaloTools/Navigation/interface/CaloNavigator.h

---