CDCRLWireHit Class Reference

Class representing an oriented hit wire including a hypotheses whether the causing track passes left or right. More...

#include <CDCRLWireHit.h>

Collaboration diagram for CDCRLWireHit:

Public Member Functions
	CDCRLWireHit ()=default
	Default constructor for ROOT.
	CDCRLWireHit (const CDCWireHit *wireHit, ERightLeft rlInfo=ERightLeft::c_Unknown)
	Constructs an oriented wire hit with unknown left right passage information.
	CDCRLWireHit (const CDCWireHit *wireHit, ERightLeft rlInfo, double driftLength, double driftLengthVariance)
	Constructs an oriented wire hit.
CDCRLWireHit	reversed () const
	Returns the oriented wire hit with the opposite right left information.
void	reverse ()
	Switches the right left passage to its opposite in place.
CDCRLWireHit	getAlias () const
	Returns the aliased version of this oriented wire hit - here same as reverse.
bool	operator== (const CDCRLWireHit &rhs) const
	Equality comparison based on wire hit, left right passage information.
bool	operator< (const CDCRLWireHit &rhs) const
	Total ordering relation based on wire hit and left right passage information in this order of importance.
	operator const Belle2::CDCHit * () const
	Make the wire hit automatically castable to its underlying cdcHit.
const CDCHit *	getHit () const
	Getter for the CDCHit pointer into the StoreArray.
Index	getStoreIHit () const
	Getter for the index of the underlying CDCHit in the StoreArray holding it.
const CDC::CDCWire &	getWire () const
	Getter for the wire the oriented hit associated to.
bool	isOnWire (const CDC::CDCWire &wire) const
	Checks if the oriented hit is associated with the give wire.
const WireID &	getWireID () const
	Getter for the WireID of the wire the hit is located on.
CDC::ISuperLayer	getISuperLayer () const
	Getter for the superlayer id.
CDC::EStereoKind	getStereoKind () const
	Getter for the stereo type of the underlying wire.
bool	isAxial () const
	Indicator if the underlying wire is axial.
const ROOT::Math::XYVector &	getRefPos2D () const
	The two dimensional reference position of the underlying wire.
double	getRefCylindricalR () const
	The distance from the beam line at reference position of the underlying wire.
const CDCWireHit &	getWireHit () const
	Getter for the wire hit associated with the oriented hit.
bool	hasWireHit (const CDCWireHit &wirehit) const
	Checks if the oriented hit is associated with the give wire hit.
double	getRefDriftLength () const
	Getter for the drift length at the reference position of the wire.
void	setRefDriftLength (double driftLength)
	Setter for the drift length at the reference position of the wire.
double	getSignedRefDriftLength () const
	Getter for the drift length at the reference position of the wire.
double	getRefDriftLengthVariance () const
	Getter for the variance of the drift length at the reference position of the wire.
void	setRefDriftLengthVariance (double driftLengthVariance)
	Setter for the variance of the drift length at the reference position of the wire.
ERightLeft	getRLInfo () const
	Getter for the right left passage information.
void	setRLInfo (const ERightLeft rlInfo)
	Setter for the right left passage information.
Vector2D	reconstruct2D (const CDCTrajectory2D &trajectory2D) const
	Reconstructs a position of primary ionisation on the drift circle.
Vector3D	reconstruct3D (const CDCTrajectory2D &trajectory2D, double z=0) const
	Attempts to reconstruct a three dimensional position (especially of stereo hits).

Static Public Member Functions
static CDCRLWireHit	average (const CDCRLWireHit &rlWireHit1, const CDCRLWireHit &rlWireHit2)
	Constructs the average of two wire hits with right left passage information.
static CDCRLWireHit	average (const CDCRLWireHit &rlWireHit1, const CDCRLWireHit &rlWireHit2, const CDCRLWireHit &rlWireHit3)
	Constructs the average of three wire hits with right left passage information.
static CDCRLWireHit	fromSimHit (const CDCWireHit *wirehit, const CDCSimHit &simhit)
	Constructs an oriented wire hit from a CDCSimHit and the associated wirehit.

Private Attributes
const CDCWireHit *	m_wireHit = nullptr
	Memory for the reference to the assiziated wire hit - not streamed (ROOT would deep-copy the pointed object and leak it on reading); m_iHit carries the CDCWireHit.
Index	m_iHit = c_InvalidIndex
	Index of the underlying CDCHit in its StoreArray, so the link survives serialisation.
double	m_refDriftLength = 0.0
	Memory for the reestimated drift length.
double	m_refDriftLengthVariance = 0.0
	Memory for the reestimated drift length variance.
ERightLeft	m_rlInfo = ERightLeft::c_Unknown
	Memory for the right left passage information of the oriented wire hit.

Friends
bool	operator< (const CDCRLWireHit &rlWireHit, const CDC::CDCWire &wire)
	Defines wires and oriented wire hits to be coaligned on the wire on which they are based.
bool	operator< (const CDC::CDCWire &wire, const CDCRLWireHit &rlWireHit)
	Defines oriented wire hits and wires to be coaligned on the wire on which they are based.
bool	operator< (const CDCRLWireHit &rlWireHit, const CDCWireHit &wireHit)
	Defines wire hits and oriented wire hits to be coaligned on the wire hit on which they are based.
bool	operator< (const CDCWireHit &wireHit, const CDCRLWireHit &rlWireHit)
	Defines oriented wire hits and wire hits to be coaligned on the wire hit on which they are based.

Detailed Description

Class representing an oriented hit wire including a hypotheses whether the causing track passes left or right.

The right left information is freely setable. More than one CDCRLWireHit can point to one CDCWireHit. For more information see

See also

CDCWireHit.

Definition at line 48 of file CDCRLWireHit.h.

Constructor & Destructor Documentation

CDCRLWireHit() [1/2]

CDCRLWireHit ( const CDCWireHit * wireHit, ERightLeft rlInfo = ERightLeft::c_Unknown )

explicit

Constructs an oriented wire hit with unknown left right passage information.

Parameters

wireHit	The wire hit the oriented hit is associated with.
rlInfo	The right left passage information of the wire relative to the track

Definition at line 44 of file CDCRLWireHit.cc.

  : CDCRLWireHit(wireHit, rlInfo, wireHit->getRefDriftLength(), wireHit->getRefDriftLengthVariance())
{
}

CDCRLWireHit() [2/2]

CDCRLWireHit	(	const CDCWireHit *	wireHit,
		ERightLeft	rlInfo,
		double	driftLength,
		double	driftLengthVariance )

Constructs an oriented wire hit.

Parameters

wireHit	The wire hit the oriented hit is associated with.
rlInfo	The right left passage information of the wire relative to the track
driftLength	The re-estimated drift length
driftLengthVariance	The re-estimated drift length variance

Definition at line 49 of file CDCRLWireHit.cc.

  : m_wireHit(wireHit)
  , m_iHit(wireHit ? wireHit->getStoreIHit() : c_InvalidIndex)
  , m_refDriftLength(driftLength)
  , m_refDriftLengthVariance(driftLengthVariance)
  , m_rlInfo(rlInfo)
{
}

Member Function Documentation

average() [1/2]

CDCRLWireHit average ( const CDCRLWireHit & rlWireHit1, const CDCRLWireHit & rlWireHit2 )

static

Constructs the average of two wire hits with right left passage information.

Takes the average of the estimated drift lengths.

Definition at line 61 of file CDCRLWireHit.cc.

{
  B2ASSERT("Average of two CDCRLWireHits with different wire hits requested.",
           rlWireHit1.getWireHit() == rlWireHit2.getWireHit());
 
  B2ASSERT("Average of two CDCRLWireHits with different right left passage information requested.",
           rlWireHit1.getRLInfo() == rlWireHit2.getRLInfo());
 
  ERightLeft rlInfo = rlWireHit1.getRLInfo();
  const CDCWireHit& wireHit = rlWireHit1.getWireHit();
 
  double driftLength = (rlWireHit1.getRefDriftLength() +
                        rlWireHit2.getRefDriftLength()) / 2.0;
 
  double driftLengthVariance = (rlWireHit1.getRefDriftLengthVariance() +
                                rlWireHit2.getRefDriftLengthVariance()) / 2.0;
 
  CDCRLWireHit result(&wireHit, rlInfo, driftLength, driftLengthVariance);
  return result;
}

average() [2/2]

CDCRLWireHit average ( const CDCRLWireHit & rlWireHit1, const CDCRLWireHit & rlWireHit2, const CDCRLWireHit & rlWireHit3 )

static

Constructs the average of three wire hits with right left passage information.

Takes the average of the estimated drift lengths.

Definition at line 83 of file CDCRLWireHit.cc.

{
  B2ASSERT("Average of three CDCRLWireHits with different wire hits requested.",
           rlWireHit1.getWireHit() == rlWireHit2.getWireHit() and
           rlWireHit2.getWireHit() == rlWireHit3.getWireHit());
 
  B2ASSERT("Average of three CDCRLWireHits with different right left passage information requested.",
           rlWireHit1.getRLInfo() == rlWireHit2.getRLInfo() and
           rlWireHit2.getRLInfo() == rlWireHit3.getRLInfo());
 
 
  ERightLeft rlInfo = rlWireHit1.getRLInfo();
  const CDCWireHit& wireHit = rlWireHit1.getWireHit();
 
  double driftLength = (rlWireHit1.getRefDriftLength() +
                        rlWireHit2.getRefDriftLength() +
                        rlWireHit3.getRefDriftLength()) / 3.0;
 
  double driftLengthVariance = (rlWireHit1.getRefDriftLengthVariance() +
                                rlWireHit2.getRefDriftLengthVariance() +
                                rlWireHit3.getRefDriftLengthVariance()) / 3.0;
 
  CDCRLWireHit result(&wireHit, rlInfo, driftLength, driftLengthVariance);
  return result;
}

fromSimHit()

CDCRLWireHit fromSimHit ( const CDCWireHit * wirehit, const CDCSimHit & simhit )

static

Constructs an oriented wire hit from a CDCSimHit and the associated wirehit.

This translates the sim hit to an oriented wire hit mainly to be able to compare the reconstructed values from the algorithm with the Monte Carlo information. It merely evaluates, if the true trajectory passes right or left of the wire.

Definition at line 112 of file CDCRLWireHit.cc.

{
  // find out if the wire is right or left of the track ( view in flight direction )
  Vector3D trackPosToWire{simhit.getPosWire() - simhit.getPosTrack()};
  Vector3D directionOfFlight{simhit.getMomentum()};
 
  ERightLeft rlInfo = trackPosToWire.xy().isRightOrLeftOf(directionOfFlight.xy());
 
  CDCRLWireHit rlWireHit(wirehit, rlInfo, simhit.getDriftLength(), CDCWireHit::c_simpleDriftLengthVariance);
 
  return rlWireHit;
}

getAlias()

CDCRLWireHit getAlias ( ) const

inline

Returns the aliased version of this oriented wire hit - here same as reverse.

Definition at line 112 of file CDCRLWireHit.h.

      {
        return reversed();
      }

getHit()

const CDCHit * getHit

(

)

const

Getter for the CDCHit pointer into the StoreArray.

Definition at line 126 of file CDCRLWireHit.cc.

{
  return getWireHit().getHit();
}

getISuperLayer()

ISuperLayer getISuperLayer

(

)

const

Getter for the superlayer id.

Definition at line 141 of file CDCRLWireHit.cc.

{
  return getWire().getISuperLayer();
}

getRefCylindricalR()

double getRefCylindricalR

(

)

const

The distance from the beam line at reference position of the underlying wire.

Definition at line 161 of file CDCRLWireHit.cc.

{
  return getWire().getRefCylindricalR();
}

getRefDriftLength()

double getRefDriftLength ( ) const

inline

Getter for the drift length at the reference position of the wire.

Definition at line 215 of file CDCRLWireHit.h.

      {
        return m_refDriftLength;
      }

getRefDriftLengthVariance()

double getRefDriftLengthVariance ( ) const

inline

Getter for the variance of the drift length at the reference position of the wire.

Definition at line 233 of file CDCRLWireHit.h.

      {
        return m_refDriftLengthVariance;
      }

getRefPos2D()

const ROOT::Math::XYVector & getRefPos2D

(

)

const

The two dimensional reference position of the underlying wire.

Definition at line 156 of file CDCRLWireHit.cc.

{
  return getWire().getRefPos2D();
}

getRLInfo()

ERightLeft getRLInfo ( ) const

inline

Getter for the right left passage information.

Definition at line 245 of file CDCRLWireHit.h.

      {
        return m_rlInfo;
      }

getSignedRefDriftLength()

double getSignedRefDriftLength ( ) const

inline

Getter for the drift length at the reference position of the wire.

Definition at line 227 of file CDCRLWireHit.h.

      {
        return static_cast<double>(getRLInfo()) * getRefDriftLength();
      }

getStereoKind()

EStereoKind getStereoKind

(

)

const

Getter for the stereo type of the underlying wire.

Definition at line 146 of file CDCRLWireHit.cc.

{
  return getWire().getStereoKind();
}

getStoreIHit()

Index getStoreIHit ( ) const

inline

Getter for the index of the underlying CDCHit in the StoreArray holding it.

Definition at line 173 of file CDCRLWireHit.h.

{ return m_iHit; }

getWire()

const CDCWire & getWire

(

)

const

Getter for the wire the oriented hit associated to.

Definition at line 131 of file CDCRLWireHit.cc.

{
  return getWireHit().getWire();
}

getWireHit()

const CDCWireHit & getWireHit ( ) const

inline

Getter for the wire hit associated with the oriented hit.

Definition at line 203 of file CDCRLWireHit.h.

      {
        return *m_wireHit;
      }

getWireID()

const WireID & getWireID

(

)

const

Getter for the WireID of the wire the hit is located on.

Definition at line 136 of file CDCRLWireHit.cc.

{
  return getWire().getWireID();
}

hasWireHit()

bool hasWireHit ( const CDCWireHit & wirehit ) const

inline

Checks if the oriented hit is associated with the give wire hit.

Definition at line 209 of file CDCRLWireHit.h.

      {
        return &getWireHit() == &wirehit;
      }

isAxial()

bool isAxial

(

)

const

Indicator if the underlying wire is axial.

Definition at line 151 of file CDCRLWireHit.cc.

{
  return getWire().isAxial();
}

isOnWire()

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

inline

Checks if the oriented hit is associated with the give wire.

Definition at line 179 of file CDCRLWireHit.h.

      {
        return &getWire() == &wire;
      }

operator const Belle2::CDCHit *()

operator const Belle2::CDCHit * ( ) const

inline

Make the wire hit automatically castable to its underlying cdcHit.

Definition at line 164 of file CDCRLWireHit.h.

      {
        return getHit();
      }

operator<()

bool operator< ( const CDCRLWireHit & rhs ) const

inline

Total ordering relation based on wire hit and left right passage information in this order of importance.

Definition at line 127 of file CDCRLWireHit.h.

      {
        return &getWireHit() < &rhs.getWireHit() or
               (&getWireHit() == &rhs.getWireHit() and (getRLInfo() < rhs.getRLInfo()));
      }

operator==()

bool operator== ( const CDCRLWireHit & rhs ) const

inline

Equality comparison based on wire hit, left right passage information.

Definition at line 118 of file CDCRLWireHit.h.

      {
        return &getWireHit() == &rhs.getWireHit() and getRLInfo() == rhs.getRLInfo();
      }

reconstruct2D()

Vector2D reconstruct2D

(

const CDCTrajectory2D &

trajectory2D

)

const

Reconstructs a position of primary ionisation on the drift circle.

The result is the position of closest approach on the drift circle to the trajectory.

All positions and the trajectory are interpreted to lie at z=0. Also the right left passage hypotheses does not play a role in the reconstruction in any way.

Definition at line 166 of file CDCRLWireHit.cc.

{
  const Vector2D& refPos2D = getRefPos2D();
  Vector2D recoPos2D = trajectory2D.getClosest(refPos2D);
 
  const Vector2D& wirePos2D = getWire().getRefPos2D();
  const double driftLength = getRefDriftLength();
 
  Vector2D disp2D = recoPos2D - wirePos2D;
 
  // Fix the displacement to lie on the drift circle.
  disp2D.normalizeTo(driftLength);
  return wirePos2D + disp2D;
}

reconstruct3D()

Vector3D reconstruct3D	(	const CDCTrajectory2D &	trajectory2D,
		double	z = 0 ) const

Attempts to reconstruct a three dimensional position (especially of stereo hits).

This method makes a distinct difference between axial and stereo hits:

• Stereo hits are moved out of the reference plane such that the oriented drift circle meets the trajectory in one point. Therefore the left right passage hypothesis has to be taken into account
• For axial hits the reconstructed position is ambiguous in the z coordinate. Also the drift circle cannot moved such that it would meet the trajectory. Hence we default to the result of reconstruct2D, which yield the closest approach of the drift circle to the trajectory in the reference plane.

Definition at line 181 of file CDCRLWireHit.cc.

{
  const EStereoKind stereoType = getStereoKind();
  const ERightLeft rlInfo = getRLInfo();
 
  if (stereoType == EStereoKind::c_StereoV or stereoType == EStereoKind::c_StereoU) {
    const WireLine& wireLine = getWire().getWireLine();
    const double signedDriftLength = isValid(rlInfo) ? static_cast<double>(rlInfo) * getRefDriftLength() : 0.0;
    return trajectory2D.reconstruct3D(wireLine, signedDriftLength, z);
 
  } else { /*if (stereoType == EStereoKind::c_Axial)*/
    const Vector2D recoPos2D = reconstruct2D(trajectory2D);
    // for axial wire we can not determine the z coordinate by looking at the xy projection only
    // we set it the basic assumption.
    return Vector3D(recoPos2D, z);
  }
}

reverse()

void reverse ( )

inline

Switches the right left passage to its opposite in place.

Definition at line 106 of file CDCRLWireHit.h.

      {
        m_rlInfo = NRightLeft::reversed(m_rlInfo);
      }

reversed()

CDCRLWireHit reversed ( ) const

inline

Returns the oriented wire hit with the opposite right left information.

Definition at line 97 of file CDCRLWireHit.h.

      {
        return CDCRLWireHit(m_wireHit,
                            NRightLeft::reversed(m_rlInfo),
                            m_refDriftLength,
                            m_refDriftLengthVariance);
      }

setRefDriftLength()

void setRefDriftLength ( double driftLength )

inline

Setter for the drift length at the reference position of the wire.

Definition at line 221 of file CDCRLWireHit.h.

      {
        m_refDriftLength = driftLength;
      }

setRefDriftLengthVariance()

void setRefDriftLengthVariance ( double driftLengthVariance )

inline

Setter for the variance of the drift length at the reference position of the wire.

Definition at line 239 of file CDCRLWireHit.h.

      {
        m_refDriftLengthVariance = driftLengthVariance;
      }

setRLInfo()

void setRLInfo ( const ERightLeft rlInfo )

inline

Setter for the right left passage information.

Definition at line 251 of file CDCRLWireHit.h.

      {
        m_rlInfo = rlInfo;
      }

Friends And Related Symbol Documentation

operator< [1/4]

bool operator< ( const CDC::CDCWire & wire, const CDCRLWireHit & rlWireHit )

friend

Defines oriented wire hits and wires to be coaligned on the wire on which they are based.

Definition at line 140 of file CDCRLWireHit.h.

      {
        return &wire < &rlWireHit.getWire();
      }

operator< [2/4]

bool operator< ( const CDCRLWireHit & rlWireHit, const CDC::CDCWire & wire )

friend

Defines wires and oriented wire hits to be coaligned on the wire on which they are based.

Definition at line 134 of file CDCRLWireHit.h.

      {
        return &rlWireHit.getWire() < &wire;
      }

operator< [3/4]

bool operator< ( const CDCRLWireHit & rlWireHit, const CDCWireHit & wireHit )

friend

Defines wire hits and oriented wire hits to be coaligned on the wire hit on which they are based.

Definition at line 149 of file CDCRLWireHit.h.

      {
        return &rlWireHit.getWireHit() < &wireHit;
      }

operator< [4/4]

bool operator< ( const CDCWireHit & wireHit, const CDCRLWireHit & rlWireHit )

friend

Defines oriented wire hits and wire hits to be coaligned on the wire hit on which they are based.

Definition at line 158 of file CDCRLWireHit.h.

      {
        return &wireHit < rlWireHit.m_wireHit;
      }

Member Data Documentation

m_iHit

Index m_iHit = c_InvalidIndex

private

Index of the underlying CDCHit in its StoreArray, so the link survives serialisation.

Definition at line 289 of file CDCRLWireHit.h.

m_refDriftLength

double m_refDriftLength = 0.0

private

Memory for the reestimated drift length.

Definition at line 292 of file CDCRLWireHit.h.

m_refDriftLengthVariance

double m_refDriftLengthVariance = 0.0

private

Memory for the reestimated drift length variance.

Definition at line 295 of file CDCRLWireHit.h.

m_rlInfo

ERightLeft m_rlInfo = ERightLeft::c_Unknown

private

Memory for the right left passage information of the oriented wire hit.

Definition at line 298 of file CDCRLWireHit.h.

m_wireHit

const CDCWireHit* m_wireHit = nullptr

private

Memory for the reference to the assiziated wire hit - not streamed (ROOT would deep-copy the pointed object and leak it on reading); m_iHit carries the CDCWireHit.

Definition at line 286 of file CDCRLWireHit.h.

---

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

• tracking/trackingUtilities/eventdata/hits/include/CDCRLWireHit.h
• tracking/trackingUtilities/eventdata/hits/src/CDCRLWireHit.cc