Class representing a triple of neighboring wire hits. More...

#include <CDCRLWireHitTriple.h>

Inheritance diagram for CDCRLWireHitTriple:

Classes
class	Shape
	Type for the different shapes of a triple of neighboring wire hits. More...

Public Member Functions
	CDCRLWireHitTriple ()=default
	Default constructor for ROOT.

	CDCRLWireHitTriple (const CDCRLWireHit &startRLWireHit, const CDCRLWireHit &middleRLWireHit, const CDCRLWireHit &endRLWireHit, int iCluster=0)
	Constructor taking three oriented wire hits.

CDCRLWireHitTriple	reversed () const
	Constructs the reverse triple from this one.

void	reverse ()
	Reverses the triple inplace.

CDCRLWireHitTriple	getAlias () const
	Returns the aliased version of this oriented wire hit triple.

bool	operator== (const CDCRLWireHitTriple &other) const
	Equality comparison considering all three oriented wire hits.

bool	operator< (const CDCRLWireHitTriple &other) const
	Establish a total ordering based on the three oriented wire hits.

Shape	getShape () const
	Getter for the shape of this triple if all three oriented wire hits are neighbors. Else ILLSHAPE.

CDC::ISuperLayer	getISuperLayer () const
	Getter for the common superlayer id of the pair.

CDC::EStereoKind	getStereoKind () const
	Getter for the common stereo type of the superlayer of the pair.

bool	isAxial () const
	Indicator if the underlying wires are axial.

const CDC::CDCWire &	getStartWire () const
	Getter for the wire the first oriented wire hit is based on.

const CDC::CDCWire &	getMiddleWire () const
	Getter for the wire the second oriented wire hit is based on.

const CDC::CDCWire &	getEndWire () const
	Getter for the wire the third oriented wire hit is based on.

bool	hasWire (const CDC::CDCWire &wire) const
	Indicator if any of the three oriented wire hits is based on the given wire.

ERightLeft	getStartRLInfo () const
	Getter for the right left passage information of the first oriented wire hit.

ERightLeft	getMiddleRLInfo () const
	Getter for the right left passage information of the second oriented wire hit.

ERightLeft	getEndRLInfo () const
	Getter for the right left passage information of the third oriented wire hit.

const CDCWireHit &	getStartWireHit () const
	Getter for the hit wire of the first oriented wire hit.

const CDCWireHit &	getMiddleWireHit () const
	Getter for the hit wire of the second oriented wire hit.

const CDCWireHit &	getEndWireHit () const
	Getter for the hit wire of the third oriented wire hit.

bool	hasWireHit (const CDCWireHit &wirehit) const
	Indicator if any of the three oriented wire hits is based on the given wire hit.

CDCRLWireHit &	getStartRLWireHit ()
	Getter for the first oriented wire hit.

CDCRLWireHit &	getMiddleRLWireHit ()
	Getter for the second oriented wire hit.

CDCRLWireHit &	getEndRLWireHit ()
	Getter for the third oriented wire hit.

const CDCRLWireHit &	getStartRLWireHit () const
	Constant getter for the first oriented wire hit.

const CDCRLWireHit &	getMiddleRLWireHit () const
	Constant getter for the second oriented wire hit.

const CDCRLWireHit &	getEndRLWireHit () const
	Constant getter for the third oriented wire hit.

CDCRLWireHitPair &	getRearRLWireHitPair ()
	Getter for the pair of second and third oriented wire hit.

const CDCRLWireHitPair &	getRearRLWireHitPair () const
	Constant getter for the pair of second and third oriented wire hit.

void	setStartRLWireHit (const CDCRLWireHit &startRLWireHit)
	Setter for the first oriented wire hit.

void	setMiddleRLWireHit (const CDCRLWireHit &middleRLWireHit)
	Setter for the second oriented wire hit.

void	setEndRLWireHit (const CDCRLWireHit &endRLWireHit)
	Setter for the third oriented wire hit.

void	setStartRLInfo (const ERightLeft startRLInfo)
	Setter for the right left passage information of the first oriented wire hit.

void	setMiddleRLInfo (const ERightLeft middleRLInfo)
	Setter for the right left passage information of the second oriented wire hit.

void	setEndRLInfo (const ERightLeft endRLInfo)
	Setter for the right left passage information of the third oriented wire hit.

int	getICluster () const
	Getter for the cluster id.

void	setICluster (int iCluster)
	Setter for the cluster id.

Protected Attributes
CDCRLWireHit	m_startRLWireHit
	Memory for the start oriented wire hit.

CDCRLWireHitPair	m_rearRLWireHitPair
	Memory for the second and third wire hits.

Friends
bool	operator< (const CDCRLWireHitTriple &rlWireHitTriple, const CDCRLWireHitPair &rlWireHitPair)
	Define oriented wire hit pairs to be coaligned with oriented wire hit triples on the first two oriented wire hits.

bool	operator< (const CDCRLWireHitPair &rlWireHitPair, const CDCRLWireHitTriple &rlWireHitTriple)
	Define oriented wire hit pairs to be coaligned with orient wire hit triples on the first two oriented wire hits.

Detailed Description

Class representing a triple of neighboring wire hits.

The first is taken as a single, while the second and the third are grouped into a pair. In this way we can save some object creations during lookups of a triple following this one, since the projection to the last pair can be done by reference.

Definition at line 37 of file CDCRLWireHitTriple.h.

Constructor & Destructor Documentation

◆ CDCRLWireHitTriple()

CDCRLWireHitTriple	(	const CDCRLWireHit &	startRLWireHit,
		const CDCRLWireHit &	middleRLWireHit,
		const CDCRLWireHit &	endRLWireHit,
		int	iCluster = 0 )

Constructor taking three oriented wire hits.

Definition at line 63 of file CDCRLWireHitTriple.cc.

  : m_startRLWireHit(startRLWireHit)
  , m_rearRLWireHitPair(middleRLWireHit, endRLWireHit, iCluster)
{
}

Member Function Documentation

◆ getAlias()

CDCRLWireHitTriple getAlias ( ) const

Returns the aliased version of this oriented wire hit triple.

Definition at line 88 of file CDCRLWireHitTriple.cc.

{
  return CDCRLWireHitTriple(getStartRLWireHit().getAlias(),
                            getMiddleRLWireHit().getAlias(),
                            getEndRLWireHit().getAlias(),
                            getICluster());
}

◆ getEndRLInfo()

ERightLeft getEndRLInfo ( ) const

inline

Getter for the right left passage information of the third oriented wire hit.

Definition at line 198 of file CDCRLWireHitTriple.h.

      {
        return getEndRLWireHit().getRLInfo();
      }

◆ getEndRLWireHit() [1/2]

CDCRLWireHit & getEndRLWireHit ( )

inline

Getter for the third oriented wire hit.

Definition at line 241 of file CDCRLWireHitTriple.h.

      {
        return getRearRLWireHitPair().getToRLWireHit();
      }

◆ getEndRLWireHit() [2/2]

const CDCRLWireHit & getEndRLWireHit ( ) const

inline

Constant getter for the third oriented wire hit.

Definition at line 259 of file CDCRLWireHitTriple.h.

      {
        return getRearRLWireHitPair().getToRLWireHit();
      }

◆ getEndWire()

const CDC::CDCWire & getEndWire ( ) const

inline

Getter for the wire the third oriented wire hit is based on.

Definition at line 174 of file CDCRLWireHitTriple.h.

      {
        return getEndRLWireHit().getWire();
      }

◆ getEndWireHit()

const CDCWireHit & getEndWireHit ( ) const

inline

Getter for the hit wire of the third oriented wire hit.

Definition at line 216 of file CDCRLWireHitTriple.h.

      {
        return getEndRLWireHit().getWireHit();
      }

◆ getICluster()

int getICluster ( ) const

inline

Getter for the cluster id.

Definition at line 313 of file CDCRLWireHitTriple.h.

      {
        return m_rearRLWireHitPair.getICluster();
      }

◆ getISuperLayer()

CDC::ISuperLayer getISuperLayer ( ) const

inline

Getter for the common superlayer id of the pair.

Definition at line 143 of file CDCRLWireHitTriple.h.

      {
        assert(getStartRLWireHit().getISuperLayer() == getRearRLWireHitPair().getISuperLayer());
        return getStartRLWireHit().getISuperLayer();
      }

◆ getMiddleRLInfo()

ERightLeft getMiddleRLInfo ( ) const

inline

Getter for the right left passage information of the second oriented wire hit.

Definition at line 192 of file CDCRLWireHitTriple.h.

      {
        return getMiddleRLWireHit().getRLInfo();
      }

◆ getMiddleRLWireHit() [1/2]

CDCRLWireHit & getMiddleRLWireHit ( )

inline

Getter for the second oriented wire hit.

Definition at line 235 of file CDCRLWireHitTriple.h.

      {
        return getRearRLWireHitPair().getFromRLWireHit();
      }

◆ getMiddleRLWireHit() [2/2]

const CDCRLWireHit & getMiddleRLWireHit ( ) const

inline

Constant getter for the second oriented wire hit.

Definition at line 253 of file CDCRLWireHitTriple.h.

      {
        return getRearRLWireHitPair().getFromRLWireHit();
      }

◆ getMiddleWire()

const CDC::CDCWire & getMiddleWire ( ) const

inline

Getter for the wire the second oriented wire hit is based on.

Definition at line 168 of file CDCRLWireHitTriple.h.

      {
        return getMiddleRLWireHit().getWire();
      }

◆ getMiddleWireHit()

const CDCWireHit & getMiddleWireHit ( ) const

inline

Getter for the hit wire of the second oriented wire hit.

Definition at line 210 of file CDCRLWireHitTriple.h.

      {
        return getMiddleRLWireHit().getWireHit();
      }

◆ getRearRLWireHitPair() [1/2]

CDCRLWireHitPair & getRearRLWireHitPair ( )

inline

Getter for the pair of second and third oriented wire hit.

Definition at line 265 of file CDCRLWireHitTriple.h.

      {
        return m_rearRLWireHitPair;
      }

◆ getRearRLWireHitPair() [2/2]

const CDCRLWireHitPair & getRearRLWireHitPair ( ) const

inline

Constant getter for the pair of second and third oriented wire hit.

Definition at line 271 of file CDCRLWireHitTriple.h.

      {
        return m_rearRLWireHitPair;
      }

◆ getShape()

CDCRLWireHitTriple::Shape getShape ( ) const

Getter for the shape of this triple if all three oriented wire hits are neighbors. Else ILLSHAPE.

Definition at line 96 of file CDCRLWireHitTriple.cc.

{
  const CDCWire& startWire = getStartWire();
  const CDCWire& middleWire = getMiddleWire();
  const CDCWire& endWire = getEndWire();
 
  WireNeighborKind startToMiddleNeighborKind = startWire.getNeighborKind(middleWire);
  WireNeighborKind middleToEndNeighborKind   = middleWire.getNeighborKind(endWire);
 
  if (not startToMiddleNeighborKind.isValid() or
      not middleToEndNeighborKind.isValid()) {
    return Shape();
  }
 
  // Neighbor types are marked on the clock. Difference is so to say an angular value apart from a 12 / (2 * pi) factor
  const short oClockDelta = middleToEndNeighborKind.getOClockDirection() - startToMiddleNeighborKind.getOClockDirection();
  const short startToMiddleCellDistance = startToMiddleNeighborKind.getCellDistance();
  const short middleToEndCellDistance =  middleToEndNeighborKind.getCellDistance();
  return Shape(startToMiddleCellDistance,
               middleToEndCellDistance,
               symmetricModuloFast(oClockDelta, 12));
}

◆ getStartRLInfo()

ERightLeft getStartRLInfo ( ) const

inline

Getter for the right left passage information of the first oriented wire hit.

Definition at line 186 of file CDCRLWireHitTriple.h.

      {
        return getStartRLWireHit().getRLInfo();
      }

◆ getStartRLWireHit() [1/2]

CDCRLWireHit & getStartRLWireHit ( )

inline

Getter for the first oriented wire hit.

Definition at line 229 of file CDCRLWireHitTriple.h.

      {
        return m_startRLWireHit;
      }

◆ getStartRLWireHit() [2/2]

const CDCRLWireHit & getStartRLWireHit ( ) const

inline

Constant getter for the first oriented wire hit.

Definition at line 247 of file CDCRLWireHitTriple.h.

      {
        return m_startRLWireHit;
      }

◆ getStartWire()

const CDC::CDCWire & getStartWire ( ) const

inline

Getter for the wire the first oriented wire hit is based on.

Definition at line 162 of file CDCRLWireHitTriple.h.

      {
        return getStartRLWireHit().getWire();
      }

◆ getStartWireHit()

const CDCWireHit & getStartWireHit ( ) const

inline

Getter for the hit wire of the first oriented wire hit.

Definition at line 204 of file CDCRLWireHitTriple.h.

      {
        return getStartRLWireHit().getWireHit();
      }

◆ getStereoKind()

CDC::EStereoKind getStereoKind ( ) const

inline

Getter for the common stereo type of the superlayer of the pair.

Definition at line 150 of file CDCRLWireHitTriple.h.

      {
        return CDC::ISuperLayerUtil::getStereoKind(getISuperLayer());
      }

◆ hasWire()

bool hasWire ( const CDC::CDCWire & wire ) const

inline

Indicator if any of the three oriented wire hits is based on the given wire.

Definition at line 180 of file CDCRLWireHitTriple.h.

      {
        return getStartRLWireHit().isOnWire(wire) or getRearRLWireHitPair().hasWire(wire);
      }

◆ hasWireHit()

bool hasWireHit ( const CDCWireHit & wirehit ) const

inline

Indicator if any of the three oriented wire hits is based on the given wire hit.

Definition at line 222 of file CDCRLWireHitTriple.h.

      {
        return getStartRLWireHit().hasWireHit(wirehit) or
               getRearRLWireHitPair().hasWireHit(wirehit);
      }

◆ isAxial()

bool isAxial ( ) const

inline

Indicator if the underlying wires are axial.

Definition at line 156 of file CDCRLWireHitTriple.h.

      {
        return getStereoKind() == CDC::EStereoKind::c_Axial;
      }

◆ operator<()

bool operator< ( const CDCRLWireHitTriple & other ) const

inline

Establish a total ordering based on the three oriented wire hits.

Definition at line 104 of file CDCRLWireHitTriple.h.

      {
        return getICluster() < other.getICluster() or
               (getICluster() == other.getICluster() and
                (getStartRLWireHit() <  other.getStartRLWireHit() or
                 (getStartRLWireHit() == other.getStartRLWireHit() and
                  getRearRLWireHitPair() < other.getRearRLWireHitPair())));
      }

◆ operator==()

bool operator== ( const CDCRLWireHitTriple & other ) const

inline

Equality comparison considering all three oriented wire hits.

Definition at line 96 of file CDCRLWireHitTriple.h.

      {
        return getStartRLWireHit() == other.getStartRLWireHit() and
               getRearRLWireHitPair() == other.getRearRLWireHitPair();
      }

◆ reverse()

void reverse ( )

Reverses the triple inplace.

Definition at line 80 of file CDCRLWireHitTriple.cc.

{
  CDCRLWireHit newEndRLWireHit = getStartRLWireHit().reversed();
  setMiddleRLWireHit(getEndRLWireHit().reversed());
  setMiddleRLWireHit(getMiddleRLWireHit().reversed());
  setEndRLWireHit(newEndRLWireHit);
}

◆ reversed()

CDCRLWireHitTriple reversed ( ) const

Constructs the reverse triple from this one.

Definition at line 72 of file CDCRLWireHitTriple.cc.

{
  return CDCRLWireHitTriple(getEndRLWireHit().reversed(),
                            getMiddleRLWireHit().reversed(),
                            getStartRLWireHit().reversed(),
                            getICluster());
}

◆ setEndRLInfo()

void setEndRLInfo ( const ERightLeft endRLInfo )

inline

Setter for the right left passage information of the third oriented wire hit.

Definition at line 307 of file CDCRLWireHitTriple.h.

      {
        getRearRLWireHitPair().setToRLInfo(endRLInfo);
      }

◆ setEndRLWireHit()

void setEndRLWireHit ( const CDCRLWireHit & endRLWireHit )

inline

Setter for the third oriented wire hit.

Definition at line 289 of file CDCRLWireHitTriple.h.

      {
        m_rearRLWireHitPair.setToRLWireHit(endRLWireHit);
      }

◆ setICluster()

void setICluster ( int iCluster )

inline

Setter for the cluster id.

Definition at line 319 of file CDCRLWireHitTriple.h.

      {
        m_rearRLWireHitPair.setICluster(iCluster);
      }

◆ setMiddleRLInfo()

void setMiddleRLInfo ( const ERightLeft middleRLInfo )

inline

Setter for the right left passage information of the second oriented wire hit.

Definition at line 301 of file CDCRLWireHitTriple.h.

      {
        getRearRLWireHitPair().setFromRLInfo(middleRLInfo);
      }

◆ setMiddleRLWireHit()

void setMiddleRLWireHit ( const CDCRLWireHit & middleRLWireHit )

inline

Setter for the second oriented wire hit.

Definition at line 283 of file CDCRLWireHitTriple.h.

      {
        m_rearRLWireHitPair.setFromRLWireHit(middleRLWireHit);
      }

◆ setStartRLInfo()

void setStartRLInfo ( const ERightLeft startRLInfo )

inline

Setter for the right left passage information of the first oriented wire hit.

Definition at line 295 of file CDCRLWireHitTriple.h.

      {
        m_startRLWireHit.setRLInfo(startRLInfo);
      }

◆ setStartRLWireHit()

void setStartRLWireHit ( const CDCRLWireHit & startRLWireHit )

inline

Setter for the first oriented wire hit.

Definition at line 277 of file CDCRLWireHitTriple.h.

      {
        m_startRLWireHit = startRLWireHit;
      }

Friends And Related Symbol Documentation

◆ operator< [1/2]

bool operator<	(	const CDCRLWireHitPair &	rlWireHitPair,
		const CDCRLWireHitTriple &	rlWireHitTriple )

friend

Define oriented wire hit pairs to be coaligned with orient wire hit triples on the first two oriented wire hits.

Definition at line 129 of file CDCRLWireHitTriple.h.

      {
        return rlWireHitPair.getICluster() < rlWireHitTriple.getICluster() or
               (rlWireHitPair.getICluster() == rlWireHitTriple.getICluster() and
                (rlWireHitPair.getFromRLWireHit() < rlWireHitTriple.getStartRLWireHit() or
                 (rlWireHitPair.getFromRLWireHit() == rlWireHitTriple.getStartRLWireHit() and
                  rlWireHitPair.getToRLWireHit() < rlWireHitTriple.getMiddleRLWireHit())));
      }

◆ operator< [2/2]

bool operator<	(	const CDCRLWireHitTriple &	rlWireHitTriple,
		const CDCRLWireHitPair &	rlWireHitPair )

friend

Define oriented wire hit pairs to be coaligned with oriented wire hit triples on the first two oriented wire hits.

Definition at line 117 of file CDCRLWireHitTriple.h.

      {
        return rlWireHitTriple.getICluster() < rlWireHitPair.getICluster() or
               (rlWireHitTriple.getICluster() == rlWireHitPair.getICluster() and
                (rlWireHitTriple.getStartRLWireHit() < rlWireHitPair.getFromRLWireHit() or
                 (rlWireHitTriple.getStartRLWireHit() == rlWireHitPair.getFromRLWireHit() and
                  rlWireHitTriple.getMiddleRLWireHit() < rlWireHitPair.getToRLWireHit())));
      }

Member Data Documentation

◆ m_rearRLWireHitPair

CDCRLWireHitPair m_rearRLWireHitPair

protected

Memory for the second and third wire hits.

Definition at line 329 of file CDCRLWireHitTriple.h.

◆ m_startRLWireHit

CDCRLWireHit m_startRLWireHit

protected

Memory for the start oriented wire hit.

Definition at line 326 of file CDCRLWireHitTriple.h.

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

tracking/trackingUtilities/eventdata/hits/include/CDCRLWireHitTriple.h
tracking/trackingUtilities/eventdata/hits/src/CDCRLWireHitTriple.cc

Classes

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CDCRLWireHitTriple()

Member Function Documentation

◆ getAlias()

◆ getEndRLInfo()

◆ getEndRLWireHit() [1/2]

◆ getEndRLWireHit() [2/2]

◆ getEndWire()

◆ getEndWireHit()

◆ getICluster()

◆ getISuperLayer()

◆ getMiddleRLInfo()

◆ getMiddleRLWireHit() [1/2]

◆ getMiddleRLWireHit() [2/2]

◆ getMiddleWire()

◆ getMiddleWireHit()

◆ getRearRLWireHitPair() [1/2]

◆ getRearRLWireHitPair() [2/2]

◆ getShape()

◆ getStartRLInfo()

◆ getStartRLWireHit() [1/2]

◆ getStartRLWireHit() [2/2]

◆ getStartWire()

◆ getStartWireHit()

◆ getStereoKind()

◆ hasWire()

◆ hasWireHit()

◆ isAxial()

◆ operator<()

◆ operator==()

◆ reverse()

◆ reversed()

◆ setEndRLInfo()

◆ setEndRLWireHit()

◆ setICluster()

◆ setMiddleRLInfo()

◆ setMiddleRLWireHit()

◆ setStartRLInfo()

◆ setStartRLWireHit()

Friends And Related Symbol Documentation

◆ operator< [1/2]

◆ operator< [2/2]

Member Data Documentation

◆ m_rearRLWireHitPair

◆ m_startRLWireHit