CDCAxialSegmentPair Class Reference

Class representing a pair of reconstructed axial segments in adjacent superlayer. More...

#include <CDCAxialSegmentPair.h>

Public Member Functions
	CDCAxialSegmentPair ()
	Default constructor setting the contained segments to nullptr.
	CDCAxialSegmentPair (const CDCAxialSegment2D *startSegment, const CDCAxialSegment2D *endSegment)
	Constructor from two segments.
	CDCAxialSegmentPair (const CDCAxialSegment2D *startSegment, const CDCAxialSegment2D *endSegment, const CDCTrajectory2D &trajectory2D)
	Constructor from two segments and an associated trajectory.
bool	operator== (CDCAxialSegmentPair const &rhs) const
	Equality comparison based on the pointers to the stored segments.
bool	operator< (CDCAxialSegmentPair const &rhs) const
	Total ordering scheme comparing the segment pointers.
bool	checkSegments () const
	Checks the references to the contained three segment for nullptrs.
ISuperLayer	getStartISuperLayer () const
	Getter for the superlayer id of the start segment.
ISuperLayer	getEndISuperLayer () const
	Getter for the superlayer id of the end segment.
const CDCAxialSegment2D *	getStartSegment () const
	Getter for the start segment.
void	setStartSegment (const CDCAxialSegment2D *startSegment)
	Setter for the start segment.
const CDCAxialSegment2D *	getEndSegment () const
	Getter for the end segment.
void	setEndSegment (const CDCAxialSegment2D *endSegment)
	Setter for the end segment.
void	setSegments (const CDCSegment2D *startSegment, const CDCSegment2D *endSegment)
	Setter for both segments simultaneously.
CDCTrajectory2D &	getTrajectory2D () const
	Getter for the trajectory of the two dimensional trajectory.
void	setTrajectory2D (const CDCTrajectory2D &trajectory2D) const
	Setter for the trajectory of the two dimensional trajectory.
void	clearTrajectory2D () const
	Invalidates the currently stored trajectory information.
void	unsetAndForwardMaskedFlag () const
	Unsets the masked flag of the segment pair's automaton cell, of the contained segments and of the contained wire hits.
void	setAndForwardMaskedFlag () const
	Sets the masked flag of the segment pair's automaton cell. Also forward the masked flag to the contained segments and the contained wire hits.
void	receiveMaskedFlag () const
	If one of the contained segments is marked as masked this segment pair is set be masked as well.
EForwardBackward	isCoaligned (const CDCTrajectory2D &trajectory2D) const
	Checks if the last entity in the vector lies greater or lower travel distance than the last entity.
AutomatonCell &	getAutomatonCell () const
	Mutable getter for the automaton cell.

Private Attributes
const CDCAxialSegment2D *	m_startSegment
	Reference to the start segment.
const CDCAxialSegment2D *	m_endSegment
	Reference to the end segment.
CDCTrajectory2D	m_trajectory2D
	Reference to the common trajectory.
AutomatonCell	m_automatonCell
	Automaton cell associated with the pair of segments.

Friends
bool	operator< (CDCAxialSegmentPair const &segmentPair, const CDCAxialSegment2D *axialSegment)
	Define reconstructed segments and segment triples as coaligned on the start segment.
bool	operator< (const CDCAxialSegment2D *axialSegment, CDCAxialSegmentPair const &segmentPair)
	Define reconstructed segments and segment pairs as coaligned on the start segment.

Detailed Description

Class representing a pair of reconstructed axial segments in adjacent superlayer.

Definition at line 31 of file CDCAxialSegmentPair.h.

Constructor & Destructor Documentation

CDCAxialSegmentPair() [1/3]

CDCAxialSegmentPair

(

)

Default constructor setting the contained segments to nullptr.

Definition at line 26 of file CDCAxialSegmentPair.cc.

  : m_startSegment(nullptr)
  , m_endSegment(nullptr)
{
}

CDCAxialSegmentPair() [2/3]

CDCAxialSegmentPair	(	const CDCAxialSegment2D *	startSegment,
		const CDCAxialSegment2D *	endSegment
	)

Constructor from two segments.

Definition at line 32 of file CDCAxialSegmentPair.cc.

  : m_startSegment(startSegment)
  , m_endSegment(endSegment)
{
  B2ASSERT("CDCAxialSegmentPair initialized with nullptr as start segment", startSegment);
  B2ASSERT("CDCAxialSegmentPair initialized with nullptr as end segment", endSegment);
}

CDCAxialSegmentPair() [3/3]

CDCAxialSegmentPair	(	const CDCAxialSegment2D *	startSegment,
		const CDCAxialSegment2D *	endSegment,
		const CDCTrajectory2D &	trajectory2D
	)

Constructor from two segments and an associated trajectory.

Definition at line 41 of file CDCAxialSegmentPair.cc.

  : m_startSegment(startSegment)
  , m_endSegment(endSegment)
  , m_trajectory2D(trajectory2D)
{
  B2ASSERT("CDCAxialSegmentPair initialized with nullptr as start segment", startSegment);
  B2ASSERT("CDCAxialSegmentPair initialized with nullptr as end segment", endSegment);
}

Member Function Documentation

checkSegments()

bool checkSegments ( ) const

inline

Checks the references to the contained three segment for nullptrs.

Definition at line 77 of file CDCAxialSegmentPair.h.

      {
        return not(m_startSegment == nullptr or m_endSegment == nullptr);
      }

clearTrajectory2D()

void clearTrajectory2D ( ) const

inline

Invalidates the currently stored trajectory information.

Definition at line 131 of file CDCAxialSegmentPair.h.

      { getTrajectory2D().clear(); }

getAutomatonCell()

AutomatonCell & getAutomatonCell ( ) const

inline

Mutable getter for the automaton cell.

Definition at line 152 of file CDCAxialSegmentPair.h.

      {
        return m_automatonCell;
      }

getEndISuperLayer()

ISuperLayer getEndISuperLayer

(

)

const

Getter for the superlayer id of the end segment.

Definition at line 57 of file CDCAxialSegmentPair.cc.

{
  return ISuperLayerUtil::getFrom(getEndSegment());
}

getEndSegment()

const CDCAxialSegment2D * getEndSegment ( ) const

inline

Getter for the end segment.

Definition at line 101 of file CDCAxialSegmentPair.h.

      {
        return m_endSegment;
      }

getStartISuperLayer()

ISuperLayer getStartISuperLayer

(

)

const

Getter for the superlayer id of the start segment.

Definition at line 52 of file CDCAxialSegmentPair.cc.

{
  return ISuperLayerUtil::getFrom(getStartSegment());
}

getStartSegment()

const CDCAxialSegment2D * getStartSegment ( ) const

inline

Getter for the start segment.

Definition at line 89 of file CDCAxialSegmentPair.h.

      {
        return m_startSegment;
      }

getTrajectory2D()

CDCTrajectory2D & getTrajectory2D ( ) const

inline

Getter for the trajectory of the two dimensional trajectory.

Definition at line 121 of file CDCAxialSegmentPair.h.

      {
        return m_trajectory2D;
      }

isCoaligned()

EForwardBackward isCoaligned

(

const CDCTrajectory2D &

trajectory2D

)

const

Checks if the last entity in the vector lies greater or lower travel distance than the last entity.

Returns:

• EForwardBackward::c_Forward if the last entity lies behind the first.
• EForwardBackward::c_Backward if the last entity lies before the first.

Definition at line 90 of file CDCAxialSegmentPair.cc.

{
  EForwardBackward startIsCoaligned = trajectory2D.isForwardOrBackwardTo(*(getStartSegment()));
  EForwardBackward endIsCoaligned = trajectory2D.isForwardOrBackwardTo(*(getEndSegment()));
  if (startIsCoaligned == EForwardBackward::c_Forward and
      endIsCoaligned == EForwardBackward::c_Forward) {
    return EForwardBackward::c_Forward;
  } else if (startIsCoaligned == EForwardBackward::c_Backward and
             endIsCoaligned == EForwardBackward::c_Backward) {
    return EForwardBackward::c_Backward;
  } else {
    return EForwardBackward::c_Invalid;
  }
}

operator<()

bool operator< ( CDCAxialSegmentPair const &  rhs ) const

inline

Total ordering scheme comparing the segment pointers.

Definition at line 55 of file CDCAxialSegmentPair.h.

      {
        return
          std::tie(m_startSegment, m_endSegment) <
          std::tie(rhs.m_startSegment, rhs.m_endSegment);
      }

operator==()

bool operator== ( CDCAxialSegmentPair const &  rhs ) const

inline

Equality comparison based on the pointers to the stored segments.

Definition at line 47 of file CDCAxialSegmentPair.h.

      {
        return
          std::tie(m_startSegment, m_endSegment) ==
          std::tie(rhs.m_startSegment, rhs.m_endSegment);
      }

receiveMaskedFlag()

void receiveMaskedFlag

(

)

const

If one of the contained segments is marked as masked this segment pair is set be masked as well.

Definition at line 78 of file CDCAxialSegmentPair.cc.

{
  const bool fromHits = true;
  getStartSegment()->receiveMaskedFlag(fromHits);
  getEndSegment()->receiveMaskedFlag(fromHits);
 
  if (getStartSegment()->getAutomatonCell().hasMaskedFlag() or
      getEndSegment()->getAutomatonCell().hasMaskedFlag()) {
    getAutomatonCell().setMaskedFlag();
  }
}

setAndForwardMaskedFlag()

void setAndForwardMaskedFlag

(

)

const

Sets the masked flag of the segment pair's automaton cell. Also forward the masked flag to the contained segments and the contained wire hits.

Definition at line 70 of file CDCAxialSegmentPair.cc.

{
  getAutomatonCell().setMaskedFlag();
  const bool toHits = true;
  getStartSegment()->setAndForwardMaskedFlag(toHits);
  getEndSegment()->setAndForwardMaskedFlag(toHits);
}

setEndSegment()

void setEndSegment ( const CDCAxialSegment2D *  endSegment )

inline

Setter for the end segment.

Definition at line 107 of file CDCAxialSegmentPair.h.

      {
        m_endSegment = endSegment;
      }

setSegments()

void setSegments ( const CDCSegment2D *  startSegment, const CDCSegment2D *  endSegment  )

inline

Setter for both segments simultaneously.

Definition at line 113 of file CDCAxialSegmentPair.h.

      {
        m_startSegment = startSegment;
        m_endSegment = endSegment;
        checkSegments();
      }

setStartSegment()

void setStartSegment ( const CDCAxialSegment2D *  startSegment )

inline

Setter for the start segment.

Definition at line 95 of file CDCAxialSegmentPair.h.

      {
        m_startSegment = startSegment;
      }

setTrajectory2D()

void setTrajectory2D ( const CDCTrajectory2D &  trajectory2D ) const

inline

Setter for the trajectory of the two dimensional trajectory.

Definition at line 127 of file CDCAxialSegmentPair.h.

      { m_trajectory2D =  trajectory2D; }

unsetAndForwardMaskedFlag()

void unsetAndForwardMaskedFlag

(

)

const

Unsets the masked flag of the segment pair's automaton cell, of the contained segments and of the contained wire hits.

Definition at line 62 of file CDCAxialSegmentPair.cc.

{
  getAutomatonCell().unsetMaskedFlag();
  const bool toHits = true;
  getStartSegment()->unsetAndForwardMaskedFlag(toHits);
  getEndSegment()->unsetAndForwardMaskedFlag(toHits);
}

Friends And Related Function Documentation

operator< [1/2]

bool operator< ( CDCAxialSegmentPair const &  segmentPair, const CDCAxialSegment2D *  axialSegment  )

friend

Define reconstructed segments and segment triples as coaligned on the start segment.

Definition at line 63 of file CDCAxialSegmentPair.h.

      {
        return segmentPair.getStartSegment() < axialSegment;
      }

operator< [2/2]

bool operator< ( const CDCAxialSegment2D *  axialSegment, CDCAxialSegmentPair const &  segmentPair  )

friend

Define reconstructed segments and segment pairs as coaligned on the start segment.

Definition at line 70 of file CDCAxialSegmentPair.h.

      {
        return axialSegment < segmentPair.getStartSegment();
      }

Member Data Documentation

m_automatonCell

AutomatonCell m_automatonCell

mutableprivate

Automaton cell associated with the pair of segments.

Definition at line 168 of file CDCAxialSegmentPair.h.

m_endSegment

const CDCAxialSegment2D* m_endSegment

private

Reference to the end segment.

Definition at line 162 of file CDCAxialSegmentPair.h.

m_startSegment

const CDCAxialSegment2D* m_startSegment

private

Reference to the start segment.

Definition at line 159 of file CDCAxialSegmentPair.h.

m_trajectory2D

CDCTrajectory2D m_trajectory2D

mutableprivate

Reference to the common trajectory.

Definition at line 165 of file CDCAxialSegmentPair.h.

---

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

• tracking/trackFindingCDC/eventdata/tracks/include/CDCAxialSegmentPair.h
• tracking/trackFindingCDC/eventdata/tracks/src/CDCAxialSegmentPair.cc