A pair of oriented wire hits. More...

#include <CDCRLWireHitPair.h>

Inheritance diagram for CDCRLWireHitPair:

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

	CDCRLWireHitPair (const CDCRLWireHit &fromRLWireHit, const CDCRLWireHit &toRLWireHit, int iCluster=0)
	Constructor taking two oriented wire hits.

CDCRLWireHitPair	reversed () const
	Constructs a oriented wire hit pair that is the reverse of this one.

void	reverse ()
	Reverses the oriented wire hit pair inplace.

CDCRLWireHitPair	getAlias () const
	Returns the aliased version of this oriented wire hit pair.

bool	operator== (const CDCRLWireHitPair &other) const
	Equality comparision based the two oriented wire hits.

bool	operator< (const CDCRLWireHitPair &other) const
	Total ordering relation based on the from oriented wire hit first and the to oriented wire hit second.

WireNeighborKind	getNeighborKind () const
	Getter for the WireNeighborKind of the two underlying wires.

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

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 CDCWire &	getFromWire () const
	Getter for the wire the first oriented wire hit is based on.

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

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

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

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

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

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

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

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

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

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

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

void	setFromRLWireHit (const CDCRLWireHit &fromRLWireHit)
	Setter for the first oriented wire hit.

void	setToRLWireHit (const CDCRLWireHit &toRLWireHit)
	Setter for the second oriented wire hit.

void	setFromRLInfo (ERightLeft fromRLInfo)
	Setter for the right left passage information of the first oriented wire hit.

void	setToRLInfo (ERightLeft toRLInfo)
	Setter for the right left passage information of the second oriented wire hit.

int	getICluster () const
	Getter for the cluster id.

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

Protected Attributes
CDCRLWireHit	m_fromRLWireHit
	Memory for the reference to the first oriented wire hit.

CDCRLWireHit	m_toRLWireHit
	Memory for the reference to the second oriented wire hit.

int	m_iCluster = -1
	Memory for the cluster id of this facet.

Friends
bool	operator< (const CDCRLWireHitPair &rlWireHitPair, const CDCWireHit &wireHit)
	Defines wire hits and oriented wire hit pair as coaligned on the first wire hit.

bool	operator< (const CDCWireHit &wireHit, const CDCRLWireHitPair &rlWireHitPair)
	Defines wire hits and oriented wire hit pair as coaligned on the first wire hit.

Detailed Description

A pair of oriented wire hits.

Definition at line 27 of file CDCRLWireHitPair.h.

Constructor & Destructor Documentation

◆ CDCRLWireHitPair()

CDCRLWireHitPair	(	const CDCRLWireHit &	fromRLWireHit,
		const CDCRLWireHit &	toRLWireHit,
		int	iCluster = `0`
	)

Constructor taking two oriented wire hits.

Definition at line 22 of file CDCRLWireHitPair.cc.

  : m_fromRLWireHit(fromRLWireHit)
  , m_toRLWireHit(toRLWireHit)
  , m_iCluster(iCluster)
{
}

Member Function Documentation

◆ getAlias()

CDCRLWireHitPair getAlias ( ) const

Returns the aliased version of this oriented wire hit pair.

Definition at line 49 of file CDCRLWireHitPair.cc.

{
  return CDCRLWireHitPair(getFromRLWireHit().getAlias(), getToRLWireHit().getAlias(), getICluster());
}

◆ getFromRLInfo()

ERightLeft getFromRLInfo ( ) const

inline

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

Definition at line 137 of file CDCRLWireHitPair.h.

      {
        return getFromRLWireHit().getRLInfo();
      }

◆ getFromRLWireHit() [1/2]

CDCRLWireHit & getFromRLWireHit ( )

inline

Getter for the first oriented wire hit.

Definition at line 149 of file CDCRLWireHitPair.h.

      {
        return m_fromRLWireHit;
      }

◆ getFromRLWireHit() [2/2]

const CDCRLWireHit & getFromRLWireHit ( ) const

inline

Constant getter for the first oriented wire hit.

Definition at line 161 of file CDCRLWireHitPair.h.

      {
        return m_fromRLWireHit;
      }

◆ getFromWire()

const CDCWire & getFromWire ( ) const

inline

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

Definition at line 101 of file CDCRLWireHitPair.h.

      {
        return getFromRLWireHit().getWire();
      }

◆ getFromWireHit()

const CDCWireHit & getFromWireHit ( ) const

inline

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

Definition at line 119 of file CDCRLWireHitPair.h.

      {
        return getFromRLWireHit().getWireHit();
      }

◆ getICluster()

int getICluster ( ) const

inline

Getter for the cluster id.

Definition at line 191 of file CDCRLWireHitPair.h.

      {
        return m_iCluster;
      }

◆ getISuperLayer()

ISuperLayer getISuperLayer ( ) const

inline

Getter for the common superlayer id of the pair.

Definition at line 82 of file CDCRLWireHitPair.h.

      {
        ISuperLayer result = getFromRLWireHit().getISuperLayer();
        return result == getToRLWireHit().getISuperLayer() ? result : ISuperLayerUtil::c_Invalid;
      }

◆ getNeighborKind()

WireNeighborKind getNeighborKind ( ) const

inline

Getter for the WireNeighborKind of the two underlying wires.

Definition at line 32 of file CDCRLWireHitPair.cc.

{
  return getFromWire().getNeighborKind(getToWire());
}

◆ getStereoKind()

EStereoKind getStereoKind ( ) const

inline

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

Definition at line 89 of file CDCRLWireHitPair.h.

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

◆ getToRLInfo()

ERightLeft getToRLInfo ( ) const

inline

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

Definition at line 143 of file CDCRLWireHitPair.h.

      {
        return getToRLWireHit().getRLInfo();
      }

◆ getToRLWireHit() [1/2]

CDCRLWireHit & getToRLWireHit ( )

inline

Getter for the second oriented wire hit.

Definition at line 155 of file CDCRLWireHitPair.h.

      {
        return m_toRLWireHit;
      }

◆ getToRLWireHit() [2/2]

const CDCRLWireHit & getToRLWireHit ( ) const

inline

Constant getter for the second oriented wire hit.

Definition at line 167 of file CDCRLWireHitPair.h.

      {
        return m_toRLWireHit;
      }

◆ getToWire()

const CDCWire & getToWire ( ) const

inline

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

Definition at line 107 of file CDCRLWireHitPair.h.

      {
        return getToRLWireHit().getWire();
      }

◆ getToWireHit()

const CDCWireHit & getToWireHit ( ) const

inline

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

Definition at line 125 of file CDCRLWireHitPair.h.

      {
        return getToRLWireHit().getWireHit();
      }

◆ hasWire()

bool hasWire ( const CDCWire & wire ) const

inline

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

Definition at line 113 of file CDCRLWireHitPair.h.

      {
        return getFromRLWireHit().isOnWire(wire) or getToRLWireHit().isOnWire(wire);
      }

◆ hasWireHit()

bool hasWireHit ( const CDCWireHit & wirehit ) const

inline

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

Definition at line 131 of file CDCRLWireHitPair.h.

      {
        return getFromRLWireHit().hasWireHit(wirehit) or getToRLWireHit().hasWireHit(wirehit);
      }

◆ isAxial()

bool isAxial ( ) const

inline

Indicator if the underlying wires are axial.

Definition at line 95 of file CDCRLWireHitPair.h.

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

◆ operator<()

bool operator< ( const CDCRLWireHitPair & other ) const

inline

Total ordering relation based on the from oriented wire hit first and the to oriented wire hit second.

Definition at line 57 of file CDCRLWireHitPair.h.

      {
        return getICluster() < other.getICluster() or
               (getICluster() == other.getICluster() and
                (getFromRLWireHit() < other.getFromRLWireHit() or
                 (getFromRLWireHit() == other.getFromRLWireHit() and
                  getToRLWireHit() < other.getToRLWireHit())));
      }

◆ operator==()

bool operator== ( const CDCRLWireHitPair & other ) const

inline

Equality comparision based the two oriented wire hits.

Definition at line 47 of file CDCRLWireHitPair.h.

      {
        return getFromRLWireHit() == other.getFromRLWireHit() and
               getToRLWireHit() == other.getToRLWireHit();
      }

◆ reverse()

void reverse ( )

Reverses the oriented wire hit pair inplace.

Definition at line 42 of file CDCRLWireHitPair.cc.

{
  std::swap(m_fromRLWireHit, m_toRLWireHit);
  m_fromRLWireHit.reverse();
  m_toRLWireHit.reverse();
}

◆ reversed()

CDCRLWireHitPair reversed ( ) const

Constructs a oriented wire hit pair that is the reverse of this one.

Definition at line 37 of file CDCRLWireHitPair.cc.

{
  return CDCRLWireHitPair(getToRLWireHit().reversed(), getFromRLWireHit().reversed(), getICluster());
}

◆ setFromRLInfo()

void setFromRLInfo ( ERightLeft fromRLInfo )

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

Definition at line 54 of file CDCRLWireHitPair.cc.

{
  m_fromRLWireHit.setRLInfo(fromRLInfo);
}

◆ setFromRLWireHit()

void setFromRLWireHit ( const CDCRLWireHit & fromRLWireHit )

inline

Setter for the first oriented wire hit.

Definition at line 173 of file CDCRLWireHitPair.h.

      {
        m_fromRLWireHit = fromRLWireHit;
      }

◆ setICluster()

void setICluster ( int iCluster )

inline

Setter for the cluster id.

Definition at line 197 of file CDCRLWireHitPair.h.

      {
        m_iCluster = iCluster;
      }

◆ setToRLInfo()

void setToRLInfo ( ERightLeft toRLInfo )

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

Definition at line 59 of file CDCRLWireHitPair.cc.

{
  m_toRLWireHit.setRLInfo(toRLInfo);
}

◆ setToRLWireHit()

void setToRLWireHit ( const CDCRLWireHit & toRLWireHit )

inline

Setter for the second oriented wire hit.

Definition at line 179 of file CDCRLWireHitPair.h.

      {
        m_toRLWireHit = toRLWireHit;
      }

Friends And Related Function Documentation

◆ operator< [1/2]

bool operator<	(	const CDCRLWireHitPair &	rlWireHitPair,
		const CDCWireHit &	wireHit
	)

friend

Defines wire hits and oriented wire hit pair as coaligned on the first wire hit.

Definition at line 67 of file CDCRLWireHitPair.h.

      {
        return rlWireHitPair.getFromRLWireHit() < wireHit;
      }

◆ operator< [2/2]

bool operator<	(	const CDCWireHit &	wireHit,
		const CDCRLWireHitPair &	rlWireHitPair
	)

friend

Defines wire hits and oriented wire hit pair as coaligned on the first wire hit.

Definition at line 73 of file CDCRLWireHitPair.h.

      {
        return wireHit < rlWireHitPair.getFromRLWireHit();
      }

Member Data Documentation

◆ m_fromRLWireHit

CDCRLWireHit m_fromRLWireHit

protected

Memory for the reference to the first oriented wire hit.

Definition at line 204 of file CDCRLWireHitPair.h.

◆ m_iCluster

int m_iCluster = -1

protected

Memory for the cluster id of this facet.

Definition at line 210 of file CDCRLWireHitPair.h.

◆ m_toRLWireHit

CDCRLWireHit m_toRLWireHit

protected

Memory for the reference to the second oriented wire hit.

Definition at line 207 of file CDCRLWireHitPair.h.

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

tracking/trackFindingCDC/eventdata/hits/include/CDCRLWireHitPair.h
tracking/trackFindingCDC/eventdata/hits/src/CDCRLWireHitPair.cc

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CDCRLWireHitPair()

Member Function Documentation

◆ getAlias()

◆ getFromRLInfo()

◆ getFromRLWireHit() [1/2]

◆ getFromRLWireHit() [2/2]

◆ getFromWire()

◆ getFromWireHit()

◆ getICluster()

◆ getISuperLayer()

◆ getNeighborKind()

◆ getStereoKind()

◆ getToRLInfo()

◆ getToRLWireHit() [1/2]

◆ getToRLWireHit() [2/2]

◆ getToWire()

◆ getToWireHit()

◆ hasWire()

◆ hasWireHit()

◆ isAxial()

◆ operator<()

◆ operator==()

◆ reverse()

◆ reversed()

◆ setFromRLInfo()

◆ setFromRLWireHit()

◆ setICluster()

◆ setToRLInfo()

◆ setToRLWireHit()

Friends And Related Function Documentation

◆ operator< [1/2]

◆ operator< [2/2]

Member Data Documentation

◆ m_fromRLWireHit

◆ m_iCluster

◆ m_toRLWireHit