CDCSegmentPair Class Reference

Class representing a pair of one reconstructed axial segment and one stereo segment in adjacent superlayer. More...

#include <CDCSegmentPair.h>

Public Member Functions
	CDCSegmentPair ()
	Default constructor - for ROOT compatibility.
	CDCSegmentPair (const CDCSegment2D *fromSegment, const CDCSegment2D *toSegment)
	Constructor from two segments.
	CDCSegmentPair (const CDCSegment2D *fromSegment, const CDCSegment2D *toSegment, const CDCTrajectory3D &trajectory3D)
	Constructor from two segments and an associated trajectory.
bool	operator== (CDCSegmentPair const &rhs) const
	Equality comparison based on the pointers to the stored segments.
bool	operator< (CDCSegmentPair const &rhs) const
	Total ordering scheme comparing the segment pointers.
bool	checkSegmentsNonNullptr () const
	Checks if both stored segments are not nullptr. Returns true if check is succeeded.
bool	checkSegmentsStereoKinds () const
	Checks if the two segments are of different axial type.
bool	checkSegments () const
	Checks the references to the contained three segment for nullptrs and exactly one of them is axial and one is stereo.
CDC::EStereoKind	getFromStereoKind () const
	Getter for the stereo type of the first segment.
CDC::EStereoKind	getToStereoKind () const
	Getter for the stereo type of the second segment.
CDC::ISuperLayer	getFromISuperLayer () const
	Getter for the superlayer id of the from segment.
CDC::ISuperLayer	getToISuperLayer () const
	Getter for the superlayer id of the to segment.
std::size_t	size () const
	Getter for the total number of hits in this segment pair.
const CDCSegment2D *	getFromSegment () const
	Getter for the from segment.
void	setFromSegment (const CDCSegment2D *fromSegment)
	Setter for the from segment.
const CDCSegment2D *	getToSegment () const
	Getter for the to segment.
void	setToSegment (const CDCSegment2D *toSegment)
	Setter for the to segment.
const CDCSegment2D *	getStereoSegment () const
	Getter for the stereo segment.
const CDCSegment2D *	getAxialSegment () const
	Getter for the axial segment.
void	setSegments (const CDCSegment2D *fromSegment, const CDCSegment2D *toSegment)
	Setter for both segments simultaneously.
double	computeDeltaPhiAtSuperLayerBound () const
	Determines the angle between the last reconstructed position of the from segment and the first reconstructed position of the to segment.
double	computeFromIsBeforeTo () const
	Indicator if the from segment lies before the to segment.
double	computeToIsAfterFrom () const
	Indicator if the from segment lies before the to segment.
double	computeIsCoaligned () const
	Indicator if the from segment and the to segment have roughly the same travel direction.
double	computeFromIsBeforeToFitless () const
	Indicator if the from segment lies before the to segment, build without using the trajectories, which may not have been fitted yet.
double	computeToIsAfterFromFitless () const
	Indicator if the from segment lies before the to segment, build without using the trajectories, which may not have been fitted yet.
double	computeIsCoalignedFitless () const
	Indicator if the from segment and the to segment have roughly the same travel direction without using the common fit.
EForwardBackward	isCoaligned (const CDCTrajectory2D &trajectory2D) const
	Checks if the last entity in the vector lies greater or lower travel distance than the last entity.
void	setTrajectory3D (const CDCTrajectory3D &trajectory3D) const
	Setter for the three dimensional trajectory.
CDCTrajectory3D &	getTrajectory3D () const
	Getter for the three dimensional trajectory.
CDCTrajectory2D	getTrajectory2D () const
	Getter for the two dimensional projection of the common three dimensional trajectory.
CDCTrajectorySZ	getTrajectorySZ () const
	Getter for the sz projection of the common three dimensional trajectory.
void	clearTrajectory3D () const
	Invalides the currently stored trajectory information.
void	unsetAndForwardMaskedFlag () const
	Unsets the masked flag of the segment triple's automaton cell and of the three contained segments.
void	setAndForwardMaskedFlag () const
	Sets the masked flag of the segment triple's automaton cell and of the three contained segments.
void	receiveMaskedFlag () const
	If one of the contained segments is marked as masked this segment triple is set be masked as well.
AutomatonCell &	getAutomatonCell () const
	Mutable getter for the automaton cell.

Private Attributes
const CDCSegment2D *	m_fromSegment
	Reference to the from segment.
const CDCSegment2D *	m_toSegment
	Reference to the to segment.
CDCTrajectory3D	m_trajectory3D
	Memory for the common three dimensional trajectory.
AutomatonCell	m_automatonCell
	Automaton cell associated with the pair of segments.

Friends
bool	operator< (const CDCSegmentPair &segmentPair, const CDCSegment2D *segment)
	Define reconstructed segments and axial stereo segment pairs as coaligned on the from segment.
bool	operator< (const CDCSegment2D *segment, const CDCSegmentPair &segmentPair)
	Define reconstructed segments and axial stereo segment pairs as coaligned on the from segment.

Detailed Description

Class representing a pair of one reconstructed axial segment and one stereo segment in adjacent superlayer.

Definition at line 34 of file CDCSegmentPair.h.

Constructor & Destructor Documentation

CDCSegmentPair() [1/3]

CDCSegmentPair

(

)

Default constructor - for ROOT compatibility.

Definition at line 34 of file CDCSegmentPair.cc.

  : m_fromSegment(nullptr)
  , m_toSegment(nullptr)
{
}

CDCSegmentPair() [2/3]

CDCSegmentPair	(	const CDCSegment2D *	fromSegment,
		const CDCSegment2D *	toSegment )

Constructor from two segments.

Definition at line 40 of file CDCSegmentPair.cc.

  : m_fromSegment(fromSegment)
  , m_toSegment(toSegment)
{
  B2ASSERT("CDCSegmentPair initialized with nullptr as from segment", fromSegment);
  B2ASSERT("CDCSegmentPair initialized with nullptr as to segment", toSegment);
}

CDCSegmentPair() [3/3]

CDCSegmentPair	(	const CDCSegment2D *	fromSegment,
		const CDCSegment2D *	toSegment,
		const CDCTrajectory3D &	trajectory3D )

Constructor from two segments and an associated trajectory.

Definition at line 48 of file CDCSegmentPair.cc.

  : m_fromSegment(fromSegment)
  , m_toSegment(toSegment)
  , m_trajectory3D(trajectory3D)
{
  B2ASSERT("CDCSegmentPair initialized with nullptr as from segment", fromSegment);
  B2ASSERT("CDCSegmentPair initialized with nullptr as to segment", toSegment);
}

Member Function Documentation

checkSegments()

bool checkSegments ( ) const

inline

Checks the references to the contained three segment for nullptrs and exactly one of them is axial and one is stereo.

Definition at line 89 of file CDCSegmentPair.h.

      {
        return checkSegmentsNonNullptr() and checkSegmentsStereoKinds();
      }

checkSegmentsNonNullptr()

bool checkSegmentsNonNullptr ( ) const

inline

Checks if both stored segments are not nullptr. Returns true if check is succeeded.

Definition at line 75 of file CDCSegmentPair.h.

      {
        return getFromSegment() != nullptr and getToSegment() != nullptr;
      }

checkSegmentsStereoKinds()

bool checkSegmentsStereoKinds ( ) const

inline

Checks if the two segments are of different axial type.

Definition at line 81 of file CDCSegmentPair.h.

      {
        return (getFromStereoKind() == CDC::EStereoKind::c_Axial) xor
               (getToStereoKind() == CDC::EStereoKind::c_Axial);
      }

clearTrajectory3D()

void clearTrajectory3D ( ) const

inline

Invalides the currently stored trajectory information.

Definition at line 215 of file CDCSegmentPair.h.

      {
        getTrajectory3D().clear();
      }

computeDeltaPhiAtSuperLayerBound()

double computeDeltaPhiAtSuperLayerBound

(

)

const

Determines the angle between the last reconstructed position of the from segment and the first reconstructed position of the to segment.

Definition at line 127 of file CDCSegmentPair.cc.

{
  const CDCSegment2D* ptrFromSegment = getFromSegment();
  const CDCSegment2D* ptrToSegment = getToSegment();
 
  if (not ptrFromSegment) {
    return NAN;
  }
 
  if (not ptrToSegment) {
    return NAN;
  }
 
  const CDCSegment2D& fromSegment = *ptrFromSegment;
  const CDCSegment2D& toSegment = *ptrToSegment;
 
  if (fromSegment.empty() or toSegment.empty()) {
    return NAN;
  }
 
  const CDCRecoHit2D& lastRecoHit_fromSegment = fromSegment.back();
  const CDCRecoHit2D& firstRecoHit_toSegment = toSegment.front();
 
  const Vector2D lastPos2D_fromSegment = lastRecoHit_fromSegment.getRecoPos2D();
  const Vector2D firstPos2D_toSegment = firstRecoHit_toSegment.getRecoPos2D();
 
  return lastPos2D_fromSegment.angleWith(firstPos2D_toSegment);
}

computeFromIsBeforeTo()

double computeFromIsBeforeTo ( ) const

inline

Indicator if the from segment lies before the to segment.

Definition at line 159 of file CDCSegmentPair.h.

      {
        return computeFromIsBeforeToFitless();
      }

computeFromIsBeforeToFitless()

double computeFromIsBeforeToFitless

(

)

const

Indicator if the from segment lies before the to segment, build without using the trajectories, which may not have been fitted yet.

Definition at line 156 of file CDCSegmentPair.cc.

{
  const CDCSegment2D* ptrFromSegment = getFromSegment();
  const CDCSegment2D* ptrToSegment = getToSegment();
 
  if (not ptrFromSegment) {
    return NAN;
  }
 
  if (not ptrToSegment) {
    return NAN;
  }
 
  const CDCSegment2D& fromSegment = *ptrFromSegment;
  const CDCSegment2D& toSegment = *ptrToSegment;
 
  if (fromSegment.empty() or toSegment.empty()) {
    return NAN;
  }
 
  const CDCRecoHit2D& firstRecoHit_fromSegment = fromSegment.front();
  const CDCRecoHit2D& lastRecoHit_fromSegment = fromSegment.back();
 
  const CDCRecoHit2D& firstRecoHit_toSegment = toSegment.front();
 
  const Vector2D firstPos2D_fromSegment = firstRecoHit_fromSegment.getRecoPos2D();
  const Vector2D lastPos2D_fromSegment = lastRecoHit_fromSegment.getRecoPos2D();
  const Vector2D firstPos2D_toSegment = firstRecoHit_toSegment.getRecoPos2D();
 
  Vector2D firstToLast_fromSegment = lastPos2D_fromSegment - firstPos2D_fromSegment;
  Vector2D firstToFirst = firstPos2D_toSegment - firstPos2D_fromSegment;
 
  return firstToLast_fromSegment.angleWith(firstToFirst);
}

computeIsCoaligned()

double computeIsCoaligned ( ) const

inline

Indicator if the from segment and the to segment have roughly the same travel direction.

Definition at line 171 of file CDCSegmentPair.h.

      {
        return computeIsCoalignedFitless();
      }

computeIsCoalignedFitless()

double computeIsCoalignedFitless

(

)

const

Indicator if the from segment and the to segment have roughly the same travel direction without using the common fit.

Definition at line 226 of file CDCSegmentPair.cc.

{
  const CDCSegment2D* ptrFromSegment = getFromSegment();
  const CDCSegment2D* ptrToSegment = getToSegment();
 
  if (not ptrFromSegment) {
    return NAN;
  }
 
  if (not ptrToSegment) {
    return NAN;
  }
 
  const CDCSegment2D& fromSegment = *ptrFromSegment;
  const CDCSegment2D& toSegment = *ptrToSegment;
 
  if (fromSegment.empty() or toSegment.empty()) {
    return NAN;
  }
 
  const CDCRecoHit2D& firstRecoHit_fromSegment = fromSegment.front();
  const CDCRecoHit2D& lastRecoHit_fromSegment = fromSegment.back();
 
  const CDCRecoHit2D& firstRecoHit_toSegment = toSegment.front();
  const CDCRecoHit2D& lastRecoHit_toSegment = toSegment.back();
 
  const Vector2D firstPos2D_fromSegment = firstRecoHit_fromSegment.getRecoPos2D();
  const Vector2D lastPos2D_fromSegment = lastRecoHit_fromSegment.getRecoPos2D();
 
  const Vector2D firstPos2D_toSegment = firstRecoHit_toSegment.getRecoPos2D();
  const Vector2D lastPos2D_toSegment = lastRecoHit_toSegment.getRecoPos2D();
 
  Vector2D firstToLast_fromSegment = lastPos2D_fromSegment - firstPos2D_fromSegment;
  Vector2D firstToLast_toSegment = lastPos2D_toSegment - firstPos2D_toSegment;
 
  return firstToLast_fromSegment.angleWith(firstToLast_toSegment);
}

computeToIsAfterFrom()

double computeToIsAfterFrom ( ) const

inline

Indicator if the from segment lies before the to segment.

Definition at line 165 of file CDCSegmentPair.h.

      {
        return computeToIsAfterFromFitless();
      }

computeToIsAfterFromFitless()

double computeToIsAfterFromFitless

(

)

const

Indicator if the from segment lies before the to segment, build without using the trajectories, which may not have been fitted yet.

Definition at line 191 of file CDCSegmentPair.cc.

{
  const CDCSegment2D* ptrFromSegment = getFromSegment();
  const CDCSegment2D* ptrToSegment = getToSegment();
 
  if (not ptrFromSegment) {
    return NAN;
  }
 
  if (not ptrToSegment) {
    return NAN;
  }
 
  const CDCSegment2D& fromSegment = *ptrFromSegment;
  const CDCSegment2D& toSegment = *ptrToSegment;
 
  if (fromSegment.empty() or toSegment.empty()) {
    return NAN;
  }
 
  const CDCRecoHit2D& lastRecoHit_fromSegment = fromSegment.back();
 
  const CDCRecoHit2D& firstRecoHit_toSegment = toSegment.front();
  const CDCRecoHit2D& lastRecoHit_toSegment = toSegment.back();
 
  const Vector2D lastPos2D_fromSegment = lastRecoHit_fromSegment.getRecoPos2D();
  const Vector2D firstPos2D_toSegment = firstRecoHit_toSegment.getRecoPos2D();
  const Vector2D lastPos2D_toSegment = lastRecoHit_toSegment.getRecoPos2D();
 
  Vector2D firstToLast_toSegment = lastPos2D_toSegment - firstPos2D_toSegment;
  Vector2D lastToLast = lastPos2D_toSegment - lastPos2D_fromSegment;
 
  return firstToLast_toSegment.angleWith(lastToLast);
}

getAutomatonCell()

AutomatonCell & getAutomatonCell ( ) const

inline

Mutable getter for the automaton cell.

Definition at line 233 of file CDCSegmentPair.h.

      {
        return m_automatonCell;
      }

getAxialSegment()

const CDCSegment2D * getAxialSegment ( ) const

inline

Getter for the axial segment.

Definition at line 140 of file CDCSegmentPair.h.

      {
        return getFromStereoKind() == CDC::EStereoKind::c_Axial ? getFromSegment() : getToSegment();
      }

getFromISuperLayer()

ISuperLayer getFromISuperLayer

(

)

const

Getter for the superlayer id of the from segment.

Definition at line 72 of file CDCSegmentPair.cc.

{
  return getFromSegment() == nullptr ? ISuperLayerUtil::c_Invalid
         : getFromSegment()->back().getISuperLayer();
}

getFromSegment()

const CDCSegment2D * getFromSegment ( ) const

inline

Getter for the from segment.

Definition at line 110 of file CDCSegmentPair.h.

      {
        return m_fromSegment;
      }

getFromStereoKind()

EStereoKind getFromStereoKind

(

)

const

Getter for the stereo type of the first segment.

Definition at line 60 of file CDCSegmentPair.cc.

{
  return getFromSegment() == nullptr ? EStereoKind::c_Invalid
         : getFromSegment()->back().getStereoKind();
}

getStereoSegment()

const CDCSegment2D * getStereoSegment ( ) const

inline

Getter for the stereo segment.

Definition at line 134 of file CDCSegmentPair.h.

      {
        return getFromStereoKind() != CDC::EStereoKind::c_Axial ? getFromSegment() : getToSegment();
      }

getToISuperLayer()

ISuperLayer getToISuperLayer

(

)

const

Getter for the superlayer id of the to segment.

Definition at line 78 of file CDCSegmentPair.cc.

{
  return getToSegment() == nullptr ? ISuperLayerUtil::c_Invalid
         : getToSegment()->front().getISuperLayer();
}

getToSegment()

const CDCSegment2D * getToSegment ( ) const

inline

Getter for the to segment.

Definition at line 122 of file CDCSegmentPair.h.

      {
        return m_toSegment;
      }

getToStereoKind()

EStereoKind getToStereoKind

(

)

const

Getter for the stereo type of the second segment.

Definition at line 66 of file CDCSegmentPair.cc.

{
  return getToSegment() == nullptr ? EStereoKind::c_Invalid
         : getToSegment()->front().getStereoKind();
}

getTrajectory2D()

CDCTrajectory2D getTrajectory2D

(

)

const

Getter for the two dimensional projection of the common three dimensional trajectory.

Definition at line 89 of file CDCSegmentPair.cc.

{
  return getTrajectory3D().getTrajectory2D();
}

getTrajectory3D()

CDCTrajectory3D & getTrajectory3D ( ) const

inline

Getter for the three dimensional trajectory.

Definition at line 203 of file CDCSegmentPair.h.

      {
        return m_trajectory3D;
      }

getTrajectorySZ()

CDCTrajectorySZ getTrajectorySZ

(

)

const

Getter for the sz projection of the common three dimensional trajectory.

Definition at line 94 of file CDCSegmentPair.cc.

{
  return getTrajectory3D().getTrajectorySZ();
}

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 264 of file CDCSegmentPair.cc.

{
  EForwardBackward fromIsCoaligned = trajectory2D.isForwardOrBackwardTo(*(getFromSegment()));
  EForwardBackward toIsCoaligned = trajectory2D.isForwardOrBackwardTo(*(getToSegment()));
 
  if (fromIsCoaligned == EForwardBackward::c_Forward and
      toIsCoaligned == EForwardBackward::c_Forward) {
    return EForwardBackward::c_Forward;
  } else if (fromIsCoaligned == EForwardBackward::c_Backward and
             toIsCoaligned == EForwardBackward::c_Backward) {
    return EForwardBackward::c_Backward;
  } else {
    return EForwardBackward::c_Invalid;
  }
}

operator<()

bool operator< ( CDCSegmentPair const & rhs ) const

inline

Total ordering scheme comparing the segment pointers.

Definition at line 54 of file CDCSegmentPair.h.

      {
        return (getFromSegment() < rhs.getFromSegment() or
                (getFromSegment() == rhs.getFromSegment() and getToSegment() < rhs.getToSegment()));
      }

operator==()

bool operator== ( CDCSegmentPair const & rhs ) const

inline

Equality comparison based on the pointers to the stored segments.

Definition at line 48 of file CDCSegmentPair.h.

      {
        return getFromSegment() == rhs.getFromSegment() and getToSegment() == rhs.getToSegment();
      }

receiveMaskedFlag()

void receiveMaskedFlag

(

)

const

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

Definition at line 115 of file CDCSegmentPair.cc.

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

setAndForwardMaskedFlag()

void setAndForwardMaskedFlag

(

)

const

Sets the masked flag of the segment triple's automaton cell and of the three contained segments.

Definition at line 107 of file CDCSegmentPair.cc.

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

setFromSegment()

void setFromSegment ( const CDCSegment2D * fromSegment )

inline

Setter for the from segment.

Definition at line 116 of file CDCSegmentPair.h.

      {
        setSegments(fromSegment, getToSegment());
      }

setSegments()

void setSegments ( const CDCSegment2D * fromSegment, const CDCSegment2D * toSegment )

inline

Setter for both segments simultaneously.

Definition at line 146 of file CDCSegmentPair.h.

      {
        m_fromSegment = fromSegment;
        m_toSegment = toSegment;
        assert(checkSegmentsNonNullptr());
        assert(checkSegmentsStereoKinds());
      }

setToSegment()

void setToSegment ( const CDCSegment2D * toSegment )

inline

Setter for the to segment.

Definition at line 128 of file CDCSegmentPair.h.

      {
        setSegments(getFromSegment(), toSegment);
      }

setTrajectory3D()

void setTrajectory3D ( const CDCTrajectory3D & trajectory3D ) const

inline

Setter for the three dimensional trajectory.

Definition at line 197 of file CDCSegmentPair.h.

      {
        m_trajectory3D = trajectory3D;
      }

size()

std::size_t size

(

)

const

Getter for the total number of hits in this segment pair.

Definition at line 84 of file CDCSegmentPair.cc.

{
  return getFromSegment()->size() + getToSegment()->size();
}

unsetAndForwardMaskedFlag()

void unsetAndForwardMaskedFlag

(

)

const

Unsets the masked flag of the segment triple's automaton cell and of the three contained segments.

Definition at line 99 of file CDCSegmentPair.cc.

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

Friends And Related Symbol Documentation

operator< [1/2]

bool operator< ( const CDCSegment2D * segment, const CDCSegmentPair & segmentPair )

friend

Define reconstructed segments and axial stereo segment pairs as coaligned on the from segment.

Definition at line 69 of file CDCSegmentPair.h.

      {
        return segment < segmentPair.getFromSegment();
      }

operator< [2/2]

bool operator< ( const CDCSegmentPair & segmentPair, const CDCSegment2D * segment )

friend

Define reconstructed segments and axial stereo segment pairs as coaligned on the from segment.

Definition at line 62 of file CDCSegmentPair.h.

      {
        return segmentPair.getFromSegment() < segment;
      }

Member Data Documentation

m_automatonCell

AutomatonCell m_automatonCell

mutableprivate

Automaton cell associated with the pair of segments.

Definition at line 249 of file CDCSegmentPair.h.

m_fromSegment

const CDCSegment2D* m_fromSegment

private

Reference to the from segment.

Definition at line 240 of file CDCSegmentPair.h.

m_toSegment

const CDCSegment2D* m_toSegment

private

Reference to the to segment.

Definition at line 243 of file CDCSegmentPair.h.

m_trajectory3D

CDCTrajectory3D m_trajectory3D

mutableprivate

Memory for the common three dimensional trajectory.

Definition at line 246 of file CDCSegmentPair.h.

---

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

• tracking/trackingUtilities/eventdata/tracks/include/CDCSegmentPair.h
• tracking/trackingUtilities/eventdata/tracks/src/CDCSegmentPair.cc