Filter for the construction of track relations based on MC information. More...

#include <MCTrackRelationFilter.h>

Inheritance diagram for MCTrackRelationFilter:

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

using	Interface
	Mark this class as the basic interface.

Public Member Functions
	MCTrackRelationFilter (bool allowReverse=false)
	Constructor also setting the switch , if the reversed version of a track relation (in comparison to MC truth) shall be accepted.

TrackingUtilities::Weight	operator() (const TrackingUtilities::CDCTrack &fromTrack, const TrackingUtilities::CDCTrack &toTrack) final
	Checks if a track relation is a good combination.

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

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

void	initialize () override
	Initialize the before event processing.

void	initialize () override
	Initialize the before event processing.

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

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

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

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

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

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

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

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

std::vector< const TrackingUtilities::CDCTrack * >	getPossibleTos (const TrackingUtilities::CDCTrack from, const std::vector< const TrackingUtilities::CDCTrack > &tracks) const final
	Reinforce that the full range of tracks is possible as no particular default is applicable.

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

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

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

Weight	operator() (const Relation< const TrackingUtilities::CDCTrack > &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<BaseTrackRelationFilter>
	Type of the super class.

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

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 track relations based on MC information.

Definition at line 25 of file MCTrackRelationFilter.h.

Member Typedef Documentation

◆ Interface

using Interface

inherited

Mark this class as the basic interface.

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

◆ Object

using Object

inherited

Type of the object to be analysed.

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

◆ Super

using Super = MCSymmetric<BaseTrackRelationFilter>

private

Type of the super class.

Definition at line 29 of file MCTrackRelationFilter.h.

Constructor & Destructor Documentation

◆ MCTrackRelationFilter()

MCTrackRelationFilter ( bool allowReverse = false )

explicit

Constructor also setting the switch , if the reversed version of a track relation (in comparison to MC truth) shall be accepted.

Definition at line 22 of file MCTrackRelationFilter.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() [1/2]

void beginEvent ( )

overridevirtualinherited

Signal the beginning of a new event.

Reimplemented from CompositeProcessingSignalListener.

◆ beginEvent() [2/2]

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 DATCONSVDClusterizer, LayerPXDRelationFilter< AFilter, APrefilter >, LayerPXDRelationFilter< TrackingUtilities::ChooseableFilter< PXDPairFilterFactory > >, LayerPXDRelationFilter< TrackingUtilities::ChooseableFilter< PXDPairFilterFactory > >, LayerSVDRelationFilter< AFilter, APrefilter >, LayerSVDRelationFilter< TrackingUtilities::ChooseableFilter< SVDPairFilterFactory > >, LayerSVDRelationFilter< TrackingUtilities::ChooseableFilter< SVDPairFilterFactory > >, SectorMapBasedSVDPairFilter, SimplePXDStateFilter, SimpleSVDStateFilter, CutsFromDBWireHitFilter, WireHitCreator, MVA< Filter< AVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, FourHitFilter, LayerRelationFilter< AFilter >, LayerRelationFilter< TrackingUtilities::ChooseableFilter< RelationFilterFactory > >, LayerRelationFilter< TrackingUtilities::ChooseableFilter< RelationFilterFactory > >, QualityIndicatorFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, ThreeHitFilter, TrackCandidateResultRefiner, TwoHitVirtualIPFilter, and TwoHitVirtualIPQIFilter.

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() [1/2]

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

overridevirtualinherited

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

Reimplemented from CompositeProcessingSignalListener.

◆ exposeParameters() [2/2]

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

overridevirtualinherited

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

Reimplemented from CompositeProcessingSignalListener.

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

    {
      Super::exposeParameters(moduleParamList, prefix);
      moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "allowReverse"),
                                    m_param_allowReverse,
                                    "Indication whether the reverse to the truth is accepted"
                                    "preserving the propagation reversal symmetry.",
                                    m_param_allowReverse);
    }

◆ getAllowReverse()

bool getAllowReverse ( ) const

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 CDCTrack * > getPossibleTos	(	const TrackingUtilities::CDCTrack *	from,
		const std::vector< const TrackingUtilities::CDCTrack * > &	tracks ) const

finalinherited

Reinforce that the full range of tracks is possible as no particular default is applicable.

Definition at line 24 of file BaseTrackRelationFilter.cc.

{
  // All tracks a possible - no geometric selection here.
  return tracks;
}

◆ getPossibleTos() [2/2]

std::vector< const TrackingUtilities::CDCTrack * > getPossibleTos	(	const TrackingUtilities::CDCTrack *	from,
		const std::vector< const TrackingUtilities::CDCTrack * > &	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;
    }

◆ initialize() [1/2]

void initialize ( )

overridevirtualinherited

Initialize the before event processing.

Reimplemented from CompositeProcessingSignalListener.

◆ initialize() [2/2]

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() [1/2]

bool needsTruthInformation ( )

finalvirtualinherited

Indicates that the filter requires Monte Carlo information.

Reimplemented from Filter< Relation< const TrackingUtilities::CDCTrack > >.

◆ needsTruthInformation() [2/2]

bool needsTruthInformation ( )

finalvirtualinherited

Indicates that the filter requires Monte Carlo information.

Reimplemented from Filter< Relation< const TrackingUtilities::CDCTrack > >.

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

    {
      return true;
    }

◆ operator()() [1/7]

Weight operator()	(	const TrackingUtilities::CDCTrack &	fromTrack,
		const TrackingUtilities::CDCTrack &	toTrack )

final

Checks if a track relation is a good combination.

Definition at line 27 of file MCTrackRelationFilter.cc.

{
  const CDCMCTrackLookUp& mcTrackLookUp = CDCMCTrackLookUp::getInstance();
 
  // Check if the tracks are aligned correctly along the Monte Carlo track
  EForwardBackward pairFBInfo = mcTrackLookUp.areAlignedInMCTrack(&fromTrack, &toTrack);
  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 track
    Index fromNPassedSuperLayers = mcTrackLookUp.getLastNPassedSuperLayers(&fromTrack);
    if (fromNPassedSuperLayers == c_InvalidIndex) return NAN;
 
    Index toNPassedSuperLayers = mcTrackLookUp.getFirstNPassedSuperLayers(&toTrack);
    if (toNPassedSuperLayers == c_InvalidIndex) return NAN;
 
    if (fromNPassedSuperLayers == toNPassedSuperLayers) return NAN;
 
    // Limit loops to be merged to one
    Index fromNLoops = mcTrackLookUp.getLastNLoops(&fromTrack);
    Index toNLoops = mcTrackLookUp.getFirstNLoops(&toTrack);
    if (fromNLoops != toNLoops) return NAN;
 
    return fromTrack.size() + toTrack.size();
  }
 
  return NAN;
}

◆ operator()() [2/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.

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

    {
      return 1;
    }

◆ operator()() [3/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 69 of file Filter.icc.h.

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

◆ operator()() [4/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 77 of file Filter.icc.h.

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

◆ operator()() [5/7]

Weight operator()	(	const const TrackingUtilities::CDCTrack &	from,
		const const TrackingUtilities::CDCTrack &	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()() [6/7]

Weight operator() ( const Relation< const TrackingUtilities::CDCTrack > & 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()() [7/7]

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

inlineoverridevirtualinherited

Filter over a vector of relations.

We need to override it since derived 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 )

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< AQuadTree >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough< std::pair< TrackingUtilities::CDCRecoHit3D, const TrackingUtilities::CDCRLWireHit * >, FirstOfPairInBox< HitInHyperBox >, 4, 3, 2 > >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre< std::pair< TrackingUtilities::CDCRecoHit3D, const TrackingUtilities::CDCRLWireHit * >, FirstOfPairInBox< HitInQuadraticBox >, 2, 2 > >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre< std::pair< TrackingUtilities::CDCRecoHit3D, const TrackingUtilities::CDCRLWireHit * >, FirstOfPairInBox< HitInZ0TanLambdaBox >, 2, 2 > >, Recording< Filter< AVarSet::Object > >, Recording< Filter< typename AVarSet::Object > >, and Recording< Filter< typename AVarSet::Object > >.

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 [1/2]

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_allowReverse [2/2]

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 60 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/trackRelation/include/MCTrackRelationFilter.h
tracking/trackFindingCDC/filters/trackRelation/src/MCTrackRelationFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Interface

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ MCTrackRelationFilter()

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent() [1/2]

◆ beginEvent() [2/2]

◆ beginRun()

◆ endRun()

◆ exposeParameters() [1/2]

◆ exposeParameters() [2/2]

◆ getAllowReverse()

◆ getNProcessingSignalListener()

◆ getPossibleTos() [1/2]

◆ getPossibleTos() [2/2]

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ needsTruthInformation() [1/2]

◆ needsTruthInformation() [2/2]

◆ 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_param_allowReverse [1/2]

◆ m_param_allowReverse [2/2]

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated