MCSegmentTripleFilter Class Reference

Filter for the constuction of segment triples based on monte carlo information. More...

#include <MCSegmentTripleFilter.h>

Inheritance diagram for MCSegmentTripleFilter:

Collaboration diagram for MCSegmentTripleFilter:

Public Types
using	Object = CDCSegmentTriple
	Type of the object to be analysed.
using	Interface = Filter< CDCSegmentTriple >
	Mark this class as the basic interface.

Public Member Functions
	MCSegmentTripleFilter (bool allowReverse=true)
	Constructor initializing the symmetry flag.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
void	initialize () final
	Initialize the before event processing.
Weight	operator() (const CDCSegmentTriple &segmentTriple) final
	Check if the segment triple is aligned in the Monte Carlo track. Signals NAN if not.
void	setAllowReverse (bool allowReverse) override
	Setter for the allow reverse parameter.
void	beginEvent () override
	Signal the beginning of a new event.
bool	needsTruthInformation () final
	Indicates that the filter requires Monte Carlo information.
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< BaseSegmentTripleFilter >
	Type of the super class.

Private Member Functions
void	setTrajectoryOf (const CDCSegmentTriple &segmentTriple) const
	Sets the trajectories of the segment triple from Monte Carlo information. Is executed for good segment triples.

Private Attributes
MCAxialSegmentPairFilter	m_mcAxialSegmentPairFilter
	Instance of the cell filter to reject neighborhoods of false cells.
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 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

Filter for the constuction of segment triples based on monte carlo information.

Definition at line 27 of file MCSegmentTripleFilter.h.

Member Typedef Documentation

Interface

using Interface = Filter<CDCSegmentTriple >

inherited

Mark this class as the basic interface.

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

Object

using Object = CDCSegmentTriple

inherited

Type of the object to be analysed.

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

Super

using Super = MCSymmetric<BaseSegmentTripleFilter>

private

Type of the super class.

Definition at line 31 of file MCSegmentTripleFilter.h.

Constructor & Destructor Documentation

MCSegmentTripleFilter()

MCSegmentTripleFilter ( bool  allowReverse = true )

explicit

Constructor initializing the symmetry flag.

Definition at line 28 of file MCSegmentTripleFilter.cc.

                                                              :
  Super(allowReverse),
  m_mcAxialSegmentPairFilter(allowReverse)
{
  this->addProcessingSignalListener(&m_mcAxialSegmentPairFilter);
}

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 parameters to a module.

Reimplemented from Filter< CDCSegmentTriple >.

Definition at line 35 of file MCSegmentTripleFilter.cc.

{
  m_mcAxialSegmentPairFilter.exposeParameters(moduleParamList, prefix);
}

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 ( )

finalvirtual

Initialize the before event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 41 of file MCSegmentTripleFilter.cc.

{
  Super::initialize();
  setAllowReverse(m_mcAxialSegmentPairFilter.getAllowReverse());
}

needsTruthInformation()

bool needsTruthInformation

finalvirtualinherited

Indicates that the filter requires Monte Carlo information.

Reimplemented from Filter< CDCSegmentTriple >.

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

    {
      return true;
    }

operator()() [1/4]

Weight operator() ( const CDCSegmentTriple &  segmentTriple )

final

Check if the segment triple is aligned in the Monte Carlo track. Signals NAN if not.

Recheck the axial axial compatability

Definition at line 47 of file MCSegmentTripleFilter.cc.

{
  const CDCAxialSegment2D* ptrStartSegment = segmentTriple.getStartSegment();
  const CDCStereoSegment2D* ptrMiddleSegment = segmentTriple.getMiddleSegment();
  const CDCAxialSegment2D* ptrEndSegment = segmentTriple.getEndSegment();
 
  const CDCAxialSegment2D& startSegment = *ptrStartSegment;
  const CDCAxialSegment2D& middleSegment = *ptrMiddleSegment;
  const CDCAxialSegment2D& endSegment = *ptrEndSegment;
 
  Weight pairWeight =
    m_mcAxialSegmentPairFilter(CDCAxialSegmentPair(ptrStartSegment, ptrEndSegment));
 
  if (std::isnan(pairWeight)) return NAN;
 
  const CDCMCSegment2DLookUp& mcSegmentLookUp = CDCMCSegment2DLookUp::getInstance();
 
  // Check if the segments are aligned correctly along the Monte Carlo track
  EForwardBackward startToMiddleFBInfo = mcSegmentLookUp.areAlignedInMCTrack(ptrStartSegment, ptrMiddleSegment);
  if (startToMiddleFBInfo == EForwardBackward::c_Invalid) return NAN;
 
  EForwardBackward middleToEndFBInfo = mcSegmentLookUp.areAlignedInMCTrack(ptrMiddleSegment, ptrEndSegment);
  if (middleToEndFBInfo == EForwardBackward::c_Invalid) return NAN;
 
 
  if (startToMiddleFBInfo != middleToEndFBInfo) return NAN;
 
 
  if ((startToMiddleFBInfo == EForwardBackward::c_Forward and middleToEndFBInfo == EForwardBackward::c_Forward) or
      (getAllowReverse() and startToMiddleFBInfo == EForwardBackward::c_Backward and middleToEndFBInfo == EForwardBackward::c_Backward)) {
 
    // Do fits
    setTrajectoryOf(segmentTriple);
 
    Weight cellWeight = startSegment.size() + middleSegment.size() + endSegment.size();
    return startToMiddleFBInfo > 0 ? cellWeight : -cellWeight;
  }
 
  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 )

inlineoverridevirtual

Setter for the allow reverse parameter.

Reimplemented from MCSymmetric< BaseSegmentTripleFilter >.

Definition at line 53 of file MCSegmentTripleFilter.h.

      {
        Super::setAllowReverse(allowReverse);
        m_mcAxialSegmentPairFilter.setAllowReverse(allowReverse);
      }

setTrajectoryOf()

void setTrajectoryOf ( const CDCSegmentTriple &  segmentTriple ) const

private

Sets the trajectories of the segment triple from Monte Carlo information. Is executed for good segment triples.

Definition at line 91 of file MCSegmentTripleFilter.cc.

{
  if (segmentTriple.getTrajectorySZ().isFitted()) {
    // SZ trajectory has been fitted before. Skipping
    // A fit sz trajectory implies a 2d trajectory to be fitted, but not the other way around
    return;
  }
 
  const CDCAxialSegment2D* ptrStartSegment = segmentTriple.getStartSegment();
  if (not ptrStartSegment) {
    B2WARNING("Start segment of segmentTriple is nullptr. Could not set fits.");
    return;
  }
 
  const CDCMCSegment2DLookUp& mcSegmentLookUp = CDCMCSegment2DLookUp::getInstance();
 
  CDCTrajectory3D trajectory3D = mcSegmentLookUp.getTrajectory3D(ptrStartSegment);
  segmentTriple.setTrajectory3D(trajectory3D);
}

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 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_mcAxialSegmentPairFilter

MCAxialSegmentPairFilter m_mcAxialSegmentPairFilter

private

Instance of the cell filter to reject neighborhoods of false cells.

Definition at line 61 of file MCSegmentTripleFilter.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_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/filters/segmentTriple/include/MCSegmentTripleFilter.h
• tracking/trackFindingCDC/filters/segmentTriple/src/MCSegmentTripleFilter.cc