Fits segments with the Riemann method. More...

#include <SegmentFitter.h>

Inheritance diagram for SegmentFitter:

Public Types
using	IOTypes = std::tuple< AIOTypes... >
	Types that should be served to apply on invokation.

using	IOVectors = std::tuple< std::vector< AIOTypes >... >
	Vector types that should be served to apply on invokation.

Public Member Functions
std::string	getDescription () override
	Short description of the findlet.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters to a module.

void	initialize () override
	Signals the beginning of the event processing.

void	apply (std::vector< CDCSegment2D > &outputSegments) override
	Main algorithm applying the fit to each segment.

virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.

void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.

void	beginEvent () override
	Receive and dispatch signal for the start of a new event.

void	endRun () override
	Receive and dispatch signal for the end of the run.

void	terminate () override
	Receive and dispatch Signal for termination of the event processing.

Protected Types
using	ToVector = typename ToVectorImpl< T >::Type
	Short hand for ToRangeImpl.

Protected Member Functions
void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.

int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Private Types
using	Super = Findlet< CDCSegment2D & >
	Type of the base class.

Private Attributes
bool	m_param_karimakiFit = false
	Parameter : Switch to use Karimaki fit.

std::string	m_param_fitPosString = "recoPos"
	Parameter : Option string which positional information from the hits should be used.

std::string	m_param_fitVarianceString = "proper"
	Parameter : Option string which variance information from the hits should be used.

bool	m_param_updateDriftLength = true
	Parameter : Switch to reestimate the drift length before the fit.

bool	m_param_updateRecoPos = false
	Parameter : Switch to reevaluate the position and right left passage information based in the fit.

EFitPos	m_fitPos = EFitPos::c_RecoPos
	Option which positional information from the hits should be used.

EFitVariance	m_fitVariance = EFitVariance::c_Proper
	Option which variance information from the hits should be used.

CDCRiemannFitter	m_riemannFitter
	Instance of the riemann fitter to be used.

CDCKarimakiFitter	m_karimakiFitter
	Instance of the karimaki fitter to be used.

DriftLengthEstimator	m_driftLengthEstimator
	Instance of the drift length estimator to be used.

std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.

bool	m_initialized = false
	Flag to keep track whether initialization happend before.

bool	m_terminated = false
	Flag to keep track whether termination happend before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Fits segments with the Riemann method.

Definition at line 34 of file SegmentFitter.h.

Member Typedef Documentation

◆ IOTypes

using IOTypes = std::tuple<AIOTypes...>

inherited

Types that should be served to apply on invokation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors = std::tuple< std::vector<AIOTypes>... >

inherited

Vector types that should be served to apply on invokation.

Definition at line 53 of file Findlet.h.

◆ Super

using Super = Findlet<CDCSegment2D&>

private

Type of the base class.

Definition at line 39 of file SegmentFitter.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

◆ apply()

void apply ( std::vector< CDCSegment2D > & outputSegments )

override

Main algorithm applying the fit to each segment.

Definition at line 87 of file SegmentFitter.cc.

{
  // Update the drift length
  if (m_param_updateDriftLength) {
    for (CDCSegment2D& segment : outputSegments) {
      m_driftLengthEstimator.updateDriftLength(segment);
    }
  }
 
  for (const CDCSegment2D& segment : outputSegments) {
    CDCObservations2D observations2D(m_fitPos, m_fitVariance);
    observations2D.appendRange(segment);
 
    if (m_param_karimakiFit or observations2D.size() < 4) {
      // Karimaki only works with the reconstructed position
      if (m_fitPos != EFitPos::c_RecoPos) {
        observations2D.clear();
        observations2D.setFitPos(EFitPos::c_RecoPos);
        observations2D.appendRange(segment);
      }
      CDCTrajectory2D trajectory2D = m_karimakiFitter.fit(observations2D);
      segment.setTrajectory2D(trajectory2D);
    } else {
 
      CDCTrajectory2D trajectory2D = m_riemannFitter.fit(observations2D);
      segment.setTrajectory2D(trajectory2D);
    }
  }
 
  if (m_param_updateRecoPos) {
    for (CDCSegment2D& segment : outputSegments) {
      const CDCTrajectory2D& trajectory2D = segment.getTrajectory2D();
      if (not trajectory2D.isFitted()) continue;
      int nRLChanges = 0;
      for (CDCRecoHit2D& recoHit2D : segment) {
        ERightLeft rlInfo = trajectory2D.isRightOrLeft(recoHit2D.getRefPos2D());
        if (rlInfo != recoHit2D.getRLInfo()) ++nRLChanges;
        recoHit2D.setRLInfo(rlInfo);
        const CDCRLWireHit& rlWireHit = recoHit2D.getRLWireHit();
        Vector2D recoPos2D = rlWireHit.reconstruct2D(trajectory2D);
        recoHit2D.setRecoPos2D(recoPos2D);
      }
      if (nRLChanges > 0) B2DEBUG(25, "RL changes " << nRLChanges);
    }
  }
}

◆ beginEvent()

void beginEvent ( )

overridevirtualinherited

Receive and dispatch signal for the start of a new event.

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

{
  Super::beginEvent();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginEvent();
  }
}

◆ beginRun()

void beginRun ( )

overridevirtualinherited

Receive and dispatch signal for the beginning of a new run.

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

{
  Super::beginRun();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginRun();
  }
}

◆ endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

◆ exposeParameters()

void exposeParameters	(	ModuleParamList *	moduleParamList,
		const std::string &	prefix
	)

overridevirtual

Expose the parameters to a module.

Reimplemented from Findlet< CDCSegment2D & >.

Definition at line 27 of file SegmentFitter.cc.

{
  moduleParamList->addParameter(prefixed(prefix, "karimakiFit"),
                                m_param_karimakiFit,
                                "Switch to select Karimaki method for fitting instead of Riemann fit",
                                m_param_karimakiFit);
 
  moduleParamList->addParameter(prefixed(prefix, "fitPos"),
                                m_param_fitPosString,
                                "Positional information of the hits to be used in the fit. "
                                "Options are 'recoPos', 'rlDriftCircle', 'wirePos'.",
                                m_param_fitPosString);
 
  moduleParamList->addParameter(prefixed(prefix, "fitVariance"),
                                m_param_fitVarianceString,
                                "Positional information of the hits to be used in the fit. "
                                "Options are 'unit', 'driftLength', 'pseudo', 'proper'.",
                                m_param_fitVarianceString);
 
  moduleParamList->addParameter(prefixed(prefix, "updateDriftLength"),
                                m_param_updateDriftLength,
                                "Switch to reestimate the drift length",
                                m_param_updateDriftLength);
 
  moduleParamList->addParameter(prefixed(prefix, "updateRecoPos"),
                                m_param_updateRecoPos,
                                "Switch to reestimate the position and right left passage information",
                                m_param_updateRecoPos);
 
  m_driftLengthEstimator.exposeParameters(moduleParamList, prefix);
}

◆ getDescription()

std::string getDescription ( )

overridevirtual

Short description of the findlet.

Reimplemented from Findlet< CDCSegment2D & >.

Definition at line 22 of file SegmentFitter.cc.

{
  return "Fits each segment with a selectable method";
}

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ initialize()

void initialize ( )

overridevirtual

Signals the beginning of the event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 60 of file SegmentFitter.cc.

{
  Super::initialize();
  if (m_param_fitPosString != std::string("")) {
    try {
      m_fitPos = getFitPos(m_param_fitPosString);
    } catch (std::invalid_argument& e) {
      B2ERROR("Unexpected fitPos parameter : '" << m_param_fitPosString);
    }
  }
 
  if (m_param_fitVarianceString != std::string("")) {
    try {
      m_fitVariance = getFitVariance(m_param_fitVarianceString);
    } catch (std::invalid_argument& e) {
      B2ERROR("Unexpected fitVariance parameter : '" << m_param_fitVarianceString);
    }
  }
 
  if (m_param_karimakiFit) {
    if (m_fitPos != EFitPos::c_RecoPos) {
      B2WARNING("Karimaki fitter only works with the reconstructed position as input.");
    }
    m_fitPos = EFitPos::c_RecoPos;
  }
}

◆ terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

Member Data Documentation

◆ m_driftLengthEstimator

DriftLengthEstimator m_driftLengthEstimator

private

Instance of the drift length estimator to be used.

Definition at line 84 of file SegmentFitter.h.

◆ m_fitPos

EFitPos m_fitPos = EFitPos::c_RecoPos

private

Option which positional information from the hits should be used.

Definition at line 72 of file SegmentFitter.h.

◆ m_fitVariance

EFitVariance m_fitVariance = EFitVariance::c_Proper

private

Option which variance information from the hits should be used.

Definition at line 75 of file SegmentFitter.h.

◆ m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happend before.

Definition at line 52 of file ProcessingSignalListener.h.

◆ m_initializedAs

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

◆ m_karimakiFitter

CDCKarimakiFitter m_karimakiFitter

private

Instance of the karimaki fitter to be used.

Definition at line 81 of file SegmentFitter.h.

◆ m_param_fitPosString

std::string m_param_fitPosString = "recoPos"

private

Parameter : Option string which positional information from the hits should be used.

Definition at line 60 of file SegmentFitter.h.

◆ m_param_fitVarianceString

std::string m_param_fitVarianceString = "proper"

private

Parameter : Option string which variance information from the hits should be used.

Definition at line 63 of file SegmentFitter.h.

◆ m_param_karimakiFit

bool m_param_karimakiFit = false

private

Parameter : Switch to use Karimaki fit.

Definition at line 57 of file SegmentFitter.h.

◆ m_param_updateDriftLength

bool m_param_updateDriftLength = true

private

Parameter : Switch to reestimate the drift length before the fit.

Definition at line 66 of file SegmentFitter.h.

◆ m_param_updateRecoPos

bool m_param_updateRecoPos = false

private

Parameter : Switch to reevaluate the position and right left passage information based in the fit.

Definition at line 69 of file SegmentFitter.h.

◆ m_riemannFitter

CDCRiemannFitter m_riemannFitter

private

Instance of the riemann fitter to be used.

Definition at line 78 of file SegmentFitter.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 52 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happend before.

Definition at line 55 of file ProcessingSignalListener.h.

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

tracking/trackFindingCDC/findlets/minimal/include/SegmentFitter.h
tracking/trackFindingCDC/findlets/minimal/src/SegmentFitter.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_driftLengthEstimator

◆ m_fitPos

◆ m_fitVariance

◆ m_initialized

◆ m_initializedAs

◆ m_karimakiFitter

◆ m_param_fitPosString

◆ m_param_fitVarianceString

◆ m_param_karimakiFit

◆ m_param_updateDriftLength

◆ m_param_updateRecoPos

◆ m_riemannFitter

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated