CDCSegment2D Class Reference

A reconstructed sequence of two dimensional hits in one super layer. More...

#include <CDCSegment2D.h>

Inheritance diagram for CDCSegment2D:

Public Member Functions
bool	operator< (const CDCSegment2D &segment2D) const
	Comparison of segments up to the super cluster id keeping them close together on sort.
Relation< const CDCSegment2D, const CDCSegment2D >	makeRelation (const CDCSegment2D *segment) const
	Helper constructor to create a relation in python.
WeightedRelation< const CDCSegment2D, const CDCSegment2D >	makeWeightedRelation (double weight, const CDCSegment2D *segment) const
	Helper constructor to create a relation in python.
std::vector< const CDCWire * >	getWireSegment () const
	Getter for the vector of wires the hits of this segment are based on in the same order.
CDCWireHitSegment	getWireHitSegment () const
	Getter for the vector of the wire hits of this segment are based on in the same order.
CDCRLWireHitSegment	getRLWireHitSegment () const
	Getter for the vector of right left oriented the hits of this segment.
CDCSegment2D	getAlias () const
	Getter for the alias version of the segment - fit not copied.
int	getNRLSwitches () const
	Getter for the number of changes in the right left passage in the segment.
double	getRLAsymmetry () const
	Getter for the sum of right left information relative to the size.
CDCSegment2D	reversed () const
	Makes a copy of the segment with the reversed hits in the opposite order.
void	reverse ()
	Reverses the order of hits and their right left passage hypotheses inplace.
AutomatonCell &	getAutomatonCell () const
	Mutable getter for the automaton cell.
AutomatonCell *	operator-> () const
	Indirection to the automaton cell for easier access to the flags.
void	unsetAndForwardMaskedFlag (bool toHits=false) const
	Unset the masked flag of the automaton cell of this segment and of all contained wire hits.
void	setAndForwardMaskedFlag (bool toHits=false) const
	Set the masked flag of the automaton cell of this segment and forward the masked flag to all contained wire hits.
void	receiveMaskedFlag (bool fromHits=false) const
	Check all contained wire hits if one has the masked flag.
int	getISuperCluster () const
	Getter for the global super cluster id.
void	setISuperCluster (int iSuperCluster) const
	Setter for the globale super cluster id.
void	receiveISuperCluster () const
	Setter for the super cluster id based on the hit content.
bool	isFullyTaken (unsigned int maxNotTaken=0) const
	Returns false, if there are more than N hits in the range which does not have a taken flag.
EStereoKind	getStereoKind () const
	Returns the common stereo type of all hits.
bool	isAxial () const
	Indicator if the underlying wires are axial.
ISuperLayer	getISuperLayer () const
	Returns the common super layer id of all stored tracking hits.
const std::vector< CDCRecoHit2D > &	items () const
	Legacy accessor for the items of the segments, still used in some corners.
CDCTrajectory2D &	getTrajectory2D () const
	Getter for the two dimensional trajectory fitted to the segment.
void	setTrajectory2D (const CDCTrajectory2D &trajectory2D) const
	Setter for the two dimensional trajectory fitted to the segment.
void	sortByArcLength2D ()
	Sort the recoHits according to their perpS information.
double	getAliasScore () const
	Getter for the flag that this segment may have an aliased version.
void	setAliasScore (double aliasScore)
	Setter for the flag that this segment may have an aliased version.

Static Public Member Functions
static CDCSegment2D	condense (const CDCTangentSegment &tangentSegment)
	Averages the reconstructed positions from hits that overlap in adjacent tangents in the given tangent segment.
static CDCSegment2D	condense (const std::vector< const CDCTangent * > &tangentPath)
	Averages the reconstructed positions from hits that overlap in adjacent tangents in the given tangent path.
static CDCSegment2D	condense (const CDCFacetSegment &facetSegment)
	Averages the reconstructed positions from hits that overlap in adjacent facets in the given facet segment.
static CDCSegment2D	condense (const std::vector< const CDCFacet * > &facetPath)
	Averages the reconstructed positions from hits that overlap in adjacent facet in the given facet path.
static CDCSegment2D	condense (const std::vector< const CDCSegment2D * > &segmentPath)
	Flattens a series of segments to one segment.
static CDCSegment2D	reconstructUsingTangents (const CDCRLWireHitSegment &rlWireHitSegment)
	Reconstruct from wire hits with attached right left passage hypotheses by constructing tangents between adjacent hits pairs and averaging the reconstructed position.
static CDCSegment2D	reconstructUsingFacets (const CDCRLWireHitSegment &rlWireHitSegment)
	Reconstruct from wire hits with attached right left passage hypotheses by constructing facets between adjacent hits triples and averaging the reconstructed position.

Public Attributes
T	elements
	STL member.

Private Attributes
AutomatonCell	m_automatonCell
	Memory for the automaton cell.
int	m_iSuperCluster = -1
	Memory for the global super cluster id.
CDCTrajectory2D	m_trajectory2D
	Memory for the two dimensional trajectory fitted to this segment.
double	m_aliasScore
	Boolean flag to indicate that this segment has a valid alias version.

Detailed Description

A reconstructed sequence of two dimensional hits in one super layer.

Definition at line 39 of file CDCSegment2D.h.

Member Function Documentation

condense() [1/5]

CDCSegment2D condense ( const CDCFacetSegment &  facetSegment )

static

Averages the reconstructed positions from hits that overlap in adjacent facets in the given facet segment.

Definition at line 236 of file CDCSegment2D.cc.

{
  const std::vector<CDCFacet>& facets = facetSegment;
  CDCSegment2D segment2D = ::condenseFacetSegment(facets);
  segment2D.setTrajectory2D(facetSegment.getTrajectory2D());
  segment2D.receiveISuperCluster();
  segment2D.setAliasScore(facetSegment.getAliasScore());
  return segment2D;
}

condense() [2/5]

CDCSegment2D condense ( const CDCTangentSegment &  tangentSegment )

static

Averages the reconstructed positions from hits that overlap in adjacent tangents in the given tangent segment.

Definition at line 215 of file CDCSegment2D.cc.

{
  const std::vector<CDCTangent>& tangents = tangentSegment;
  CDCSegment2D segment2D = ::condenseTangentSegment(tangents);
  segment2D.setTrajectory2D(tangentSegment.getTrajectory2D());
  segment2D.receiveISuperCluster();
  segment2D.setAliasScore(tangentSegment.getAliasScore());
  return segment2D;
}

condense() [3/5]

CDCSegment2D condense ( const std::vector< const CDCFacet * > &  facetPath )

static

Averages the reconstructed positions from hits that overlap in adjacent facet in the given facet path.

Definition at line 246 of file CDCSegment2D.cc.

{
  std::vector<std::reference_wrapper<const CDCFacet> > facets;
  facets.reserve(facetPath.size());
  for (const CDCFacet* facet : facetPath) {
    facets.push_back(std::ref(*facet));
  }
 
  return ::condenseFacetSegment(facets);
}

condense() [4/5]

CDCSegment2D condense ( const std::vector< const CDCSegment2D * > &  segmentPath )

static

Flattens a series of segments to one segment.

Does not copy any fit.

Definition at line 257 of file CDCSegment2D.cc.

{
  CDCSegment2D result;
  double aliasScore = 0;
  for (const CDCSegment2D* ptrSegment2D : segmentPath) {
    assert(ptrSegment2D);
    const CDCSegment2D& segment2D = *ptrSegment2D;
    if (result.empty()) {
      result = segment2D;
    } else {
      for (const CDCRecoHit2D& recoHit2D : segment2D) {
        result.push_back(recoHit2D);
      }
    }
    aliasScore = aliasScore + segment2D.getAliasScore();
  }
  result.receiveISuperCluster();
  result.setAliasScore(aliasScore);
  return result;
}

condense() [5/5]

CDCSegment2D condense ( const std::vector< const CDCTangent * > &  tangentPath )

static

Averages the reconstructed positions from hits that overlap in adjacent tangents in the given tangent path.

Definition at line 225 of file CDCSegment2D.cc.

{
  std::vector<std::reference_wrapper<const CDCTangent> > tangents;
  tangents.reserve(tangentPath.size());
  for (const CDCTangent* tangent : tangentPath) {
    tangents.push_back(std::ref(*tangent));
  }
 
  return ::condenseTangentSegment(tangents);
}

getAlias()

CDCSegment2D getAlias

(

)

const

Getter for the alias version of the segment - fit not copied.

Definition at line 344 of file CDCSegment2D.cc.

{
  CDCSegment2D segment;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    segment.push_back(recoHit2D.getAlias());
  }
  segment.setISuperCluster(getISuperCluster());
  segment.setAliasScore(getAliasScore());
  return segment;
}

getAliasScore()

double getAliasScore ( ) const

inlineinherited

Getter for the flag that this segment may have an aliased version.

Definition at line 90 of file CDCSegment.h.

      {
        return m_aliasScore;
      }

getAutomatonCell()

AutomatonCell & getAutomatonCell ( ) const

inline

Mutable getter for the automaton cell.

Definition at line 119 of file CDCSegment2D.h.

      {
        return m_automatonCell;
      }

getISuperCluster()

int getISuperCluster ( ) const

inline

Getter for the global super cluster id.

Definition at line 150 of file CDCSegment2D.h.

      {
        return m_iSuperCluster;
      }

getISuperLayer()

ISuperLayer getISuperLayer ( ) const

inlineinherited

Returns the common super layer id of all stored tracking hits.

This checks if all items are located in the same superlayer and returns the superlayer id of the later. Returns ISuperLayerUtil::c_Invalid, if the superlayer is not shared among the hits.

Definition at line 57 of file CDCSegment.h.

      {
        return ISuperLayerUtil::getFrom(this->front());
      }

getNRLSwitches()

int getNRLSwitches

(

)

const

Getter for the number of changes in the right left passage in the segment.

Definition at line 355 of file CDCSegment2D.cc.

{
  ERightLeft rlInfo = ERightLeft::c_Invalid;
  int nRLSwitches = -1;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    if (rlInfo != recoHit2D.getRLInfo()) {
      rlInfo = recoHit2D.getRLInfo();
      ++nRLSwitches;
    }
  }
  return nRLSwitches;
}

getRLAsymmetry()

double getRLAsymmetry

(

)

const

Getter for the sum of right left information relative to the size.

Definition at line 368 of file CDCSegment2D.cc.

{
  int rlSum = 0;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    if (isValid(recoHit2D.getRLInfo())) {
      rlSum += recoHit2D.getRLInfo();
    }
  }
  return static_cast<double>(rlSum) / size();
}

getRLWireHitSegment()

CDCRLWireHitSegment getRLWireHitSegment

(

)

const

Getter for the vector of right left oriented the hits of this segment.

Definition at line 379 of file CDCSegment2D.cc.

{
  CDCRLWireHitSegment rlWireHitSegment;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    rlWireHitSegment.push_back(recoHit2D.getRLWireHit());
  }
  rlWireHitSegment.setTrajectory2D(getTrajectory2D());
  rlWireHitSegment.setAliasScore(getAliasScore());
  return rlWireHitSegment;
}

getStereoKind()

EStereoKind getStereoKind ( ) const

inlineinherited

Returns the common stereo type of all hits.

This checks if all tracking hits are located in the same superlayer and
returns the stereo type of the later. Returns EStereoKind::c_Invalid if the superlayer
is not shared among the tracking hits.

Definition at line 39 of file CDCSegment.h.

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

getTrajectory2D()

CDCTrajectory2D & getTrajectory2D ( ) const

inlineinherited

Getter for the two dimensional trajectory fitted to the segment.

Definition at line 69 of file CDCSegment.h.

      {
        return m_trajectory2D;
      }

getWireHitSegment()

CDCWireHitSegment getWireHitSegment

(

)

const

Getter for the vector of the wire hits of this segment are based on in the same order.

Definition at line 333 of file CDCSegment2D.cc.

{
  CDCWireHitSegment wireHitSegment;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    wireHitSegment.push_back(&(recoHit2D.getWireHit()));
  }
  wireHitSegment.setTrajectory2D(getTrajectory2D());
  wireHitSegment.setAliasScore(getAliasScore());
  return wireHitSegment;
}

getWireSegment()

std::vector< const CDCWire * > getWireSegment

(

)

const

Getter for the vector of wires the hits of this segment are based on in the same order.

Definition at line 324 of file CDCSegment2D.cc.

{
  std::vector<const CDCWire*> wireSegment;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    wireSegment.push_back(&(recoHit2D.getWire()));
  }
  return wireSegment;
}

isAxial()

bool isAxial ( ) const

inlineinherited

Indicator if the underlying wires are axial.

Definition at line 45 of file CDCSegment.h.

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

isFullyTaken()

bool isFullyTaken

(

unsigned int

maxNotTaken = 0

)

const

Returns false, if there are more than N hits in the range which does not have a taken flag.

Definition at line 450 of file CDCSegment2D.cc.

{
  unsigned int notTakenCounter = 0;
  for (const CDCRecoHit2D& recoHit : *this) {
    if (not recoHit.getWireHit().getAutomatonCell().hasTakenFlag()) {
      notTakenCounter++;
      if (notTakenCounter > maxNotTaken) {
        return false;
      }
    }
  }
 
  return true;
}

items()

const std::vector< CDCRecoHit2D > & items ( ) const

inlineinherited

Legacy accessor for the items of the segments, still used in some corners.

Definition at line 63 of file CDCSegment.h.

      {
        return *this;
      }

makeRelation()

Relation< const CDCSegment2D > makeRelation

(

const CDCSegment2D *

segment

)

const

Helper constructor to create a relation in python.

Definition at line 307 of file CDCSegment2D.cc.

{
  return {this, segment};
}

makeWeightedRelation()

WeightedRelation< const CDCSegment2D > makeWeightedRelation	(	double	weight,
		const CDCSegment2D *	segment
	)		const

Helper constructor to create a relation in python.

Definition at line 312 of file CDCSegment2D.cc.

{
  return {this, weight, segment};
}

operator->()

AutomatonCell * operator-> ( ) const

inline

Indirection to the automaton cell for easier access to the flags.

Definition at line 125 of file CDCSegment2D.h.

      {
        return &m_automatonCell;
      }

operator<()

bool operator<

(

const CDCSegment2D &

segment2D

)

const

Comparison of segments up to the super cluster id keeping them close together on sort.

Definition at line 317 of file CDCSegment2D.cc.

{
  return (this->getISuperLayer() < segment2D.getISuperLayer()) or
         (not(segment2D.getISuperLayer() < this->getISuperLayer()) and
          this->getISuperCluster() < segment2D.getISuperCluster());
}

receiveISuperCluster()

void receiveISuperCluster

(

)

const

Setter for the super cluster id based on the hit content.

Definition at line 465 of file CDCSegment2D.cc.

{
  auto getISuperClusterOfHit = [](const CDCRecoHit2D & recoHit2d) -> int {
    return recoHit2d.getWireHit().getISuperCluster();
  };
  int iSuperCluster = common(*this, getISuperClusterOfHit, -1);
  setISuperCluster(iSuperCluster);
}

receiveMaskedFlag()

void receiveMaskedFlag

(

bool

fromHits = false

)

const

Check all contained wire hits if one has the masked flag.

Set the masked flag of this segment in case at least one of the contained wire hits is flagged as masked.

Definition at line 438 of file CDCSegment2D.cc.

{
  if (not fromHits) return;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    const CDCWireHit& wireHit = recoHit2D.getWireHit();
    if (wireHit.getAutomatonCell().hasMaskedFlag()) {
      getAutomatonCell().setMaskedFlag();
      return;
    }
  }
}

reconstructUsingFacets()

CDCSegment2D reconstructUsingFacets ( const CDCRLWireHitSegment &  rlWireHitSegment )

static

Reconstruct from wire hits with attached right left passage hypotheses by constructing facets between adjacent hits triples and averaging the reconstructed position.

Definition at line 297 of file CDCSegment2D.cc.

{
  if (rlWireHitSegment.size() < 3) {
    return reconstructUsingTangents(rlWireHitSegment);
  } else {
    CDCFacetSegment facetSegment = CDCFacetSegment::create(rlWireHitSegment);
    return condense(facetSegment);
  }
}

reconstructUsingTangents()

CDCSegment2D reconstructUsingTangents ( const CDCRLWireHitSegment &  rlWireHitSegment )

static

Reconstruct from wire hits with attached right left passage hypotheses by constructing tangents between adjacent hits pairs and averaging the reconstructed position.

Definition at line 278 of file CDCSegment2D.cc.

{
  if (rlWireHitSegment.size() == 1) {
    CDCSegment2D segment2D;
    Vector2D zeroDisp2D(0.0, 0.0);
    segment2D.emplace_back(rlWireHitSegment.front(), zeroDisp2D);
    segment2D.setTrajectory2D(rlWireHitSegment.getTrajectory2D());
    segment2D.receiveISuperCluster();
    segment2D.setAliasScore(rlWireHitSegment.getAliasScore());
    return segment2D;
  } else {
    CDCTangentSegment tangentSegment;
    createTangentSegment(rlWireHitSegment, tangentSegment);
    tangentSegment.setTrajectory2D(rlWireHitSegment.getTrajectory2D());
    tangentSegment.setAliasScore(rlWireHitSegment.getAliasScore());
    return condense(tangentSegment);
  }
}

reverse()

void reverse

(

)

Reverses the order of hits and their right left passage hypotheses inplace.

Definition at line 405 of file CDCSegment2D.cc.

{
  // Reverse the trajectory
  getTrajectory2D().reverse();
 
  // Reverse the left right passage hypotheses
  for (CDCRecoHit2D& recoHit2D : *this) {
    recoHit2D.reverse();
  }
  // Reverse the arrangement of hits.
  std::reverse(begin(), end());
}

reversed()

CDCSegment2D reversed

(

)

const

Makes a copy of the segment with the reversed hits in the opposite order.

Definition at line 390 of file CDCSegment2D.cc.

{
  CDCSegment2D reverseSegment;
  reverseSegment.reserve(size());
  for (const CDCRecoHit2D& recohit : reversedRange(*this)) {
    reverseSegment.push_back(recohit.reversed());
  }
 
  reverseSegment.setTrajectory2D(getTrajectory2D().reversed());
  reverseSegment.m_automatonCell = m_automatonCell;
  reverseSegment.setISuperCluster(getISuperCluster());
  reverseSegment.setAliasScore(getAliasScore());
  return reverseSegment;
}

setAliasScore()

void setAliasScore ( double  aliasScore )

inlineinherited

Setter for the flag that this segment may have an aliased version.

Definition at line 96 of file CDCSegment.h.

      {
        m_aliasScore = aliasScore;
      }

setAndForwardMaskedFlag()

void setAndForwardMaskedFlag

(

bool

toHits = false

)

const

Set the masked flag of the automaton cell of this segment and forward the masked flag to all contained wire hits.

Definition at line 428 of file CDCSegment2D.cc.

{
  getAutomatonCell().setMaskedFlag();
  if (not toHits) return;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    const CDCWireHit& wireHit = recoHit2D.getWireHit();
    wireHit.getAutomatonCell().setMaskedFlag();
  }
}

setISuperCluster()

void setISuperCluster ( int  iSuperCluster ) const

inline

Setter for the globale super cluster id.

Definition at line 156 of file CDCSegment2D.h.

      {
        m_iSuperCluster = iSuperCluster;
      }

setTrajectory2D()

void setTrajectory2D ( const CDCTrajectory2D &  trajectory2D ) const

inlineinherited

Setter for the two dimensional trajectory fitted to the segment.

Definition at line 75 of file CDCSegment.h.

      {
        m_trajectory2D = trajectory2D;
      }

sortByArcLength2D()

void sortByArcLength2D ( )

inlineinherited

Sort the recoHits according to their perpS information.

Definition at line 81 of file CDCSegment.h.

      {
        // cppcheck-suppress constParameter
        std::stable_sort(this->begin(), this->end(), [](const T & recoHit, const T & otherRecoHit) {
          return recoHit.getArcLength2D() < otherRecoHit.getArcLength2D();
        });
      }

unsetAndForwardMaskedFlag()

void unsetAndForwardMaskedFlag

(

bool

toHits = false

)

const

Unset the masked flag of the automaton cell of this segment and of all contained wire hits.

Definition at line 418 of file CDCSegment2D.cc.

{
  getAutomatonCell().unsetMaskedFlag();
  if (not toHits) return;
  for (const CDCRecoHit2D& recoHit2D : *this) {
    const CDCWireHit& wireHit = recoHit2D.getWireHit();
    wireHit.getAutomatonCell().unsetMaskedFlag();
  }
}

Member Data Documentation

m_aliasScore

double m_aliasScore

privateinherited

Boolean flag to indicate that this segment has a valid alias version.

Definition at line 106 of file CDCSegment.h.

m_automatonCell

AutomatonCell m_automatonCell

mutableprivate

Memory for the automaton cell.

It is declared mutable because it can vary rather freely despite of the hit content might be required fixed.

Definition at line 173 of file CDCSegment2D.h.

m_iSuperCluster

int m_iSuperCluster = -1

mutableprivate

Memory for the global super cluster id.

Definition at line 176 of file CDCSegment2D.h.

m_trajectory2D

CDCTrajectory2D m_trajectory2D

mutableprivateinherited

Memory for the two dimensional trajectory fitted to this segment.

Definition at line 103 of file CDCSegment.h.

---

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

• tracking/trackFindingCDC/eventdata/segments/include/CDCSegment2D.h
• tracking/trackFindingCDC/eventdata/segments/src/CDCSegment2D.cc