Filter for the construction of axial to stereo segment pairs based on MC information. More...

#include <MCSegmentPairFilter.h>

Inheritance diagram for MCSegmentPairFilter:

Public Types
using	Object = CDCSegmentPair
	Type of the object to be analysed.

using	Interface = Filter< CDCSegmentPair >
	Mark this class as the basic interface.

Public Member Functions
	MCSegmentPairFilter (bool allowReverse=true)
	Constructor.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the set of parameters of the filter to the module parameter list.

Weight	operator() (const CDCSegmentPair &segmentPair) final
	Checks if a axial stereo segment pair is a good combination.

void	initialize () override
	Initialize the before event processing.

void	beginEvent () override
	Signal the beginning of a new event.

bool	needsTruthInformation () final
	Indicates that the filter requires Monte Carlo information.

virtual void	setAllowReverse (bool allowReverse)
	Setter for the allow reverse parameter.

bool	getAllowReverse () const
	Getter for the allow reverse parameter.

virtual Weight	operator() (const Object &obj)
	Function to evaluate the object.

Weight	operator() (const Object *obj)
	Function to evaluate the object.

virtual std::vector< float >	operator() (const std::vector< Object * > &objs)
	Function to evaluate a vector of objects Base implementation applies the function to each object.

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

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 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 = MCSymmetric< BaseSegmentPairFilter >
	Type of the super class.

Private Attributes
bool	m_param_requireRLPure = true
	Parameter : Switch to require the segment combination contain mostly correct rl information.

int	m_param_minSegmentSize = 4
	Parameter : Minimum segment size to pass as monte carlo truth.

bool	m_param_allowReverse
	Switch to indicate if the reversed version of the object shall also be accepted (default is true).

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 happened before.

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

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

Detailed Description

Filter for the construction of axial to stereo segment pairs based on MC information.

Definition at line 22 of file MCSegmentPairFilter.h.

Member Typedef Documentation

◆ Interface

using Interface = Filter<CDCSegmentPair >

inherited

Mark this class as the basic interface.

Definition at line 38 of file Filter.dcl.h.

◆ Object

using Object = CDCSegmentPair

inherited

Type of the object to be analysed.

Definition at line 35 of file Filter.dcl.h.

◆ Super

using Super = MCSymmetric<BaseSegmentPairFilter>

private

Type of the super class.

Definition at line 26 of file MCSegmentPairFilter.h.

Constructor & Destructor Documentation

◆ MCSegmentPairFilter()

MCSegmentPairFilter ( bool allowReverse = true )

explicit

Constructor.

Definition at line 24 of file MCSegmentPairFilter.cc.

  : Super(allowReverse)
{
}

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);
}

◆ beginEvent()

void beginEvent

overridevirtualinherited

Signal the beginning of a new event.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 43 of file MCSymmetricFilter.icc.h.

    {
      CDCMCManager::getInstance().fill();
      Super::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
	)

finalvirtual

Expose the set of parameters of the filter to the module parameter list.

Reimplemented from Filter< CDCSegmentPair >.

Definition at line 29 of file MCSegmentPairFilter.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
  moduleParamList->addParameter(prefixed(prefix, "requireRLPure"),
                                m_param_requireRLPure,
                                "Switch to require the segment combination contain mostly correct rl information",
                                m_param_requireRLPure);
 
 
  moduleParamList->addParameter(prefixed(prefix, "minSegmentSize"),
                                m_param_minSegmentSize,
                                "Minimum segment size to pass as monte carlo truth",
                                m_param_minSegmentSize);
 
}

◆ getAllowReverse()

bool getAllowReverse

inherited

Getter for the allow reverse parameter.

Definition at line 53 of file MCSymmetricFilter.icc.h.

    {
      return m_param_allowReverse;
    }

◆ 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

overridevirtualinherited

Initialize the before event processing.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 40 of file MCSymmetricFilter.icc.h.

    {
      CDCMCManager::getInstance().requireTruthInformation();
      Super::initialize();
    }

◆ needsTruthInformation()

bool needsTruthInformation

finalvirtualinherited

Indicates that the filter requires Monte Carlo information.

Reimplemented from Filter< CDCSegmentPair >.

Definition at line 46 of file MCSymmetricFilter.icc.h.

    {
      return true;
    }

◆ operator()() [1/4]

Weight operator() ( const CDCSegmentPair & segmentPair )

final

Checks if a axial stereo segment pair is a good combination.

Definition at line 46 of file MCSegmentPairFilter.cc.

{
  const CDCSegment2D* ptrFromSegment = segmentPair.getFromSegment();
  const CDCSegment2D* ptrToSegment = segmentPair.getToSegment();
 
  assert(ptrFromSegment);
  assert(ptrToSegment);
 
  const CDCSegment2D& fromSegment = *ptrFromSegment;
  const CDCSegment2D& toSegment = *ptrToSegment;
 
  if (static_cast<int>(fromSegment.size()) < m_param_minSegmentSize or
      static_cast<int>(toSegment.size()) < m_param_minSegmentSize) {
    return NAN;
  }
 
  const CDCMCSegment2DLookUp& mcSegmentLookUp = CDCMCSegment2DLookUp::getInstance();
 
  // Check if the segments are aligned correctly along the Monte Carlo track
  EForwardBackward pairFBInfo =
    m_param_requireRLPure
    ? mcSegmentLookUp.areAlignedInMCTrackWithRLCheck(ptrFromSegment, ptrToSegment)
    : mcSegmentLookUp.areAlignedInMCTrack(ptrFromSegment, ptrToSegment);
 
  if (pairFBInfo == EForwardBackward::c_Invalid) return NAN;
 
  if (pairFBInfo == EForwardBackward::c_Forward or
      (getAllowReverse() and pairFBInfo == EForwardBackward::c_Backward)) {
    // Final check for the distance between the segment
    Index fromNPassedSuperLayers = mcSegmentLookUp.getLastNPassedSuperLayers(ptrFromSegment);
    if (fromNPassedSuperLayers == c_InvalidIndex) return NAN;
 
    Index toNPassedSuperLayers = mcSegmentLookUp.getFirstNPassedSuperLayers(ptrToSegment);
    if (toNPassedSuperLayers == c_InvalidIndex) return NAN;
 
    if (abs(fromNPassedSuperLayers - toNPassedSuperLayers) > 1) return NAN;
 
    // Do fits
    if (not segmentPair.getTrajectory3D().isFitted()) {
      CDCTrajectory3D mcTrajectory3D = mcSegmentLookUp.getTrajectory3D(ptrFromSegment);
      if (pairFBInfo == EForwardBackward::c_Backward) {
        mcTrajectory3D.reverse();
      }
      segmentPair.setTrajectory3D(mcTrajectory3D);
    }
    return static_cast<double>(pairFBInfo) * static_cast<Weight>(fromSegment.size() + toSegment.size());
  }
  return NAN;
}

◆ operator()() [2/4]

Weight operator() ( const Object & obj )

virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters

obj	The object to be accepted or rejected.

Returns: A finite float value if the object is accepted. NAN if the object is rejected.

Definition at line 68 of file Filter.icc.h.

    {
      return 1;
    }

◆ operator()() [3/4]

Weight operator() ( const Object * obj )

inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters

obj	The object to be accepted or rejected.

Returns: A finit float value if the object is accepted. NAN if the object is rejected. Nullptr is always rejected.

Definition at line 78 of file Filter.icc.h.

    {
      return obj ? operator()(*obj) : NAN;
    }

◆ operator()() [4/4]

std::vector< float > operator() ( const std::vector< Object * > & objs )

virtualinherited

Function to evaluate a vector of objects Base implementation applies the function to each object.

Can be optimized for MVA filters

Parameters

objs	A vector of pointers to objects

Returns: A vector of float or NAN values. See above

Definition at line 86 of file Filter.icc.h.

    {
      std::vector<float> out;
      for (const auto& obj : objs) {
        out.push_back(operator()(obj));
      }
      return out;
    }

◆ setAllowReverse()

void setAllowReverse ( bool allowReverse )

virtualinherited

Setter for the allow reverse parameter.

Definition at line 50 of file MCSymmetricFilter.icc.h.

    {
      m_param_allowReverse = allowReverse;
    }

◆ 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_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened 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_param_allowReverse

bool m_param_allowReverse

privateinherited

Switch to indicate if the reversed version of the object shall also be accepted (default is true).

Definition at line 57 of file MCSymmetricFilter.dcl.h.

◆ m_param_minSegmentSize

int m_param_minSegmentSize = 4

private

Parameter : Minimum segment size to pass as monte carlo truth.

Definition at line 43 of file MCSegmentPairFilter.h.

◆ m_param_requireRLPure

bool m_param_requireRLPure = true

private

Parameter : Switch to require the segment combination contain mostly correct rl information.

Definition at line 40 of file MCSegmentPairFilter.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 happened before.

Definition at line 55 of file ProcessingSignalListener.h.

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

tracking/trackFindingCDC/filters/segmentPair/include/MCSegmentPairFilter.h
tracking/trackFindingCDC/filters/segmentPair/src/MCSegmentPairFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Interface

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ MCSegmentPairFilter()

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getAllowReverse()

◆ getNProcessingSignalListener()

◆ initialize()

◆ needsTruthInformation()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ setAllowReverse()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_param_allowReverse

◆ m_param_minSegmentSize

◆ m_param_requireRLPure

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated