Class filtering the neighborhood of axial stereo segment pairs with monte carlo information. More...

#include <MCSegmentPairRelationFilter.h>

Inheritance diagram for MCSegmentPairRelationFilter:

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

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

Public Member Functions
	MCSegmentPairRelationFilter (bool allowReverse=true)
	Constructor setting to default reversal symmetry.

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 CDCSegmentPair &fromSegmentPair, const CDCSegmentPair &toSegmentPair) final
	Main filter method returning the weight of the neighborhood relation.

void	setAllowReverse (bool allowReverse) final
	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.

std::vector< const CDCSegmentPair * >	getPossibleTos (const CDCSegmentPair from, const std::vector< const CDCSegmentPair > &segmentPairs) const final
	Returns the segment pairs form the range that continue on the to site of the given segment pair.

virtual std::vector< const CDCSegmentPair * >	getPossibleTos (const CDCSegmentPair from, const std::vector< const CDCSegmentPair > &objects) const
	Selects the objects possibly related to the given one from the given pool of objects.

virtual Weight	operator() (const const CDCSegmentPair &from, const const CDCSegmentPair &to)
	Main filter method returning the weight of the neighborhood relation.

virtual std::vector< float >	operator() (const std::vector< Relation< const CDCSegmentPair > * > &objs) override
	Filter over a vector of relations.

Weight	operator() (const Relation< const CDCSegmentPair > &relation) override
	Main filter method overriding the filter interface method.

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< BaseSegmentPairRelationFilter >
	Type of the super class.

Private Attributes
MCSegmentPairFilter	m_mcSegmentPairFilter
	Instance of the Monte Carlo axial stereo segment filter for rejection 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

Class filtering the neighborhood of axial stereo segment pairs with monte carlo information.

Definition at line 23 of file MCSegmentPairRelationFilter.h.

Member Typedef Documentation

◆ Interface

using Interface = Filter<AObject>

inherited

Mark this class as the basic interface.

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

◆ Object

using Object = AObject

inherited

Type of the object to be analysed.

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

◆ Super

using Super = MCSymmetric<BaseSegmentPairRelationFilter>

private

Type of the super class.

Definition at line 27 of file MCSegmentPairRelationFilter.h.

Constructor & Destructor Documentation

◆ MCSegmentPairRelationFilter()

MCSegmentPairRelationFilter ( bool allowReverse = true )

explicit

Constructor setting to default reversal symmetry.

Definition at line 20 of file MCSegmentPairRelationFilter.cc.

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

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< AObject >.

Definition at line 27 of file MCSegmentPairRelationFilter.cc.

{
  m_mcSegmentPairFilter.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();
}

◆ getPossibleTos() [1/2]

std::vector< const CDCSegmentPair * > getPossibleTos	(	const CDCSegmentPair *	from,
		const std::vector< const CDCSegmentPair * > &	objects
	)		const

virtualinherited

Selects the objects possibly related to the given one from the given pool of objects.

Definition at line 39 of file RelationFilter.icc.h.

    {
      return objects;
    }

◆ getPossibleTos() [2/2]

std::vector< const CDCSegmentPair * > getPossibleTos	(	const CDCSegmentPair *	from,
		const std::vector< const CDCSegmentPair * > &	segmentPairs
	)		const

finalinherited

Returns the segment pairs form the range that continue on the to site of the given segment pair.

Definition at line 29 of file BaseSegmentPairRelationFilter.cc.

{
  assert(std::is_sorted(segmentPairs.begin(), segmentPairs.end(), LessOf<Deref>()) &&
         "Expected segment pairs to be sorted");
 
  const CDCSegment2D* toSegment = from->getToSegment();
 
  ConstVectorRange<const CDCSegmentPair*> neighbors{
    std::equal_range(segmentPairs.begin(), segmentPairs.end(), &toSegment, LessOf<Deref>())};
  return {neighbors.begin(), neighbors.end()};
}

◆ initialize()

void initialize ( )

finalvirtual

Initialize the before event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 33 of file MCSegmentPairRelationFilter.cc.

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

◆ needsTruthInformation()

bool needsTruthInformation

finalvirtualinherited

Indicates that the filter requires Monte Carlo information.

Reimplemented from Filter< AObject >.

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

    {
      return true;
    }

◆ operator()() [1/7]

Weight operator()	(	const CDCSegmentPair &	fromSegmentPair,
		const CDCSegmentPair &	toSegmentPair
	)

final

Main filter method returning the weight of the neighborhood relation.

Return NAN if relation shall be rejected.

Definition at line 39 of file MCSegmentPairRelationFilter.cc.

{
  Weight mcFromPairWeight = m_mcSegmentPairFilter(fromSegmentPair);
  Weight mcToPairWeight = m_mcSegmentPairFilter(toSegmentPair);
 
  ESign fromFBInfo = sign(mcFromPairWeight);
  ESign toFBInfo = sign(mcToPairWeight);
 
  if (isValid(fromFBInfo) and isValid(toFBInfo) and fromFBInfo == toFBInfo) {
    ESign commonFBInfo = fromFBInfo;
 
    size_t fromOverlapSize = fromSegmentPair.getToSegment()->size();
    size_t fromSize = fromOverlapSize + fromSegmentPair.getFromSegment()->size();
    Weight fromWeight = fromSegmentPair.getAutomatonCell().getCellWeight();
 
    size_t toOverlapSize = toSegmentPair.getFromSegment()->size();
    size_t toSize = toOverlapSize + toSegmentPair.getToSegment()->size();
    Weight toWeight = toSegmentPair.getAutomatonCell().getCellWeight();
    double overlapWeight =
      (fromWeight * fromOverlapSize / fromSize + toWeight * toOverlapSize / toSize) / 2.0;
 
    if (commonFBInfo < 0 and Super::getAllowReverse()) {
      return -std::fabs(overlapWeight);
    } else if (commonFBInfo > 0) {
      return std::fabs(overlapWeight);
    } else {
      return NAN;
    }
  } else {
    return NAN;
  }
}

◆ operator()() [2/7]

Weight operator()	(	const const CDCSegmentPair &	from,
		const const CDCSegmentPair &	to
	)

virtualinherited

Main filter method returning the weight of the neighborhood relation.

Return always returns NAN to reject all segment neighbors.

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

    {
      return 1;
    }

◆ operator()() [3/7]

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.

Reimplemented in SeedChargeCDCPathFilter, SizeCDCPathFilter, ArcLengthBasedCDCfromEclPathPairFilter, ArcLengthBasedCDCPathPairFilter, Chi2BasedCDCPathPairFilter, DistanceBasedCDCPathPairFilter, DuplicateCDCPathPairFilter, HitDistanceBasedCDCPathPairFilter, MCTruthCDCPathPairFilter, DistanceCDCStateFilter, ExtrapolateAndUpdateCDCStateFilter, MCTruthCDCStateFilter, MCTruthEclSeedFilter, RoughCDCfromEclStateFilter, RoughCDCStateFilter, FiveHitFilter, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, SimplePXDStateFilter, AllPXDStateFilter, ResidualSVDStateFilter, SimpleSVDStateFilter, AllSVDStateFilter, and RelationFilter< AObject >.

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

    {
      return 1;
    }

◆ operator()() [4/7]

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 58 of file Filter.icc.h.

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

◆ operator()() [5/7]

Weight operator() ( const Relation< const CDCSegmentPair > & relation )

overrideinherited

Main filter method overriding the filter interface method.

Checks the validity of the pointers in the relation and unpacks the relation to the method implementing the rejection.

Definition at line 69 of file RelationFilter.icc.h.

    {
      const AObject* from = relation.getFrom();
      const AObject* to = relation.getTo();
 
      if (from == to) return NAN; // Prevent relation to same.
      if ((from == nullptr) or (to == nullptr)) return NAN;
      return operator()(*from, *to);
    }

◆ operator()() [6/7]

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 64 of file Filter.icc.h.

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

◆ operator()() [7/7]

virtual std::vector< float > operator() ( const std::vector< Relation< const CDCSegmentPair > * > & objs )

inlineoverridevirtualinherited

Filter over a vector of relations.

We need to override it since derrived relation classes do not implement a call with a pointer to a relation.

Definition at line 51 of file RelationFilter.dcl.h.

      {
        std::vector<float> out(objs.size());
        for (size_t iObj = 0; iObj < objs.size(); iObj += 1) {
          if (objs[iObj]) {
            out[iObj] = operator()(*objs[iObj]);
          } else {
            out[iObj] = NAN;
          }
        }
        return out;
      }

◆ setAllowReverse()

void setAllowReverse ( bool allowReverse )

inlinefinalvirtual

Setter for the allow reverse parameter.

Reimplemented from MCSymmetric< BaseSegmentPairRelationFilter >.

Definition at line 48 of file MCSegmentPairRelationFilter.h.

                                                    {
        Super::setAllowReverse(allowReverse);
        m_mcSegmentPairFilter.setAllowReverse(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 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_mcSegmentPairFilter

MCSegmentPairFilter m_mcSegmentPairFilter

private

Instance of the Monte Carlo axial stereo segment filter for rejection of false cells.

Definition at line 55 of file MCSegmentPairRelationFilter.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/segmentPairRelation/include/MCSegmentPairRelationFilter.h
tracking/trackFindingCDC/filters/segmentPairRelation/src/MCSegmentPairRelationFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Interface

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ MCSegmentPairRelationFilter()

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getAllowReverse()

◆ getNProcessingSignalListener()

◆ getPossibleTos() [1/2]

◆ getPossibleTos() [2/2]

◆ initialize()

◆ needsTruthInformation()

◆ operator()() [1/7]

◆ operator()() [2/7]

◆ operator()() [3/7]

◆ operator()() [4/7]

◆ operator()() [5/7]

◆ operator()() [6/7]

◆ operator()() [7/7]

◆ setAllowReverse()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_mcSegmentPairFilter

◆ m_param_allowReverse

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated