Filter for the construction of good facets based on Monte Carlo information. More...

#include <MCFacetFilter.h>

Inheritance diagram for MCFacetFilter:

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
	MCFacetFilter (bool allowReverse=true)
	Constructor also setting the switch, if the reversed version of a facet (in comparison to MC truth) shall be accepted.

Weight	operator() (const CDCFacet &facet) final
	Main filter method returning the weight of the facet.

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

Private Member Functions
bool	operator() (const CDCRLWireHitTriple &rlWireHitTriple, int maxInTrackHitIdDifference)
	Indicated if the oriented triple is a correct hypotheses.

Private Attributes
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 good facets based on Monte Carlo information.

Definition at line 24 of file MCFacetFilter.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<BaseFacetFilter>

private

Type of the super class.

Definition at line 27 of file MCFacetFilter.h.

Constructor & Destructor Documentation

◆ MCFacetFilter()

MCFacetFilter ( bool allowReverse = true )

explicit

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

Definition at line 25 of file MCFacetFilter.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
	)

overridevirtualinherited

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

Reimplemented from Filter< AObject >.

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

    {
      Super::exposeParameters(moduleParamList, prefix);
      moduleParamList->addParameter(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

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

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

    {
      return true;
    }

◆ operator()() [1/5]

Weight operator() ( const CDCFacet & facet )

final

Main filter method returning the weight of the facet.

Returns NAN, if the cell shall be rejected.

Definition at line 30 of file MCFacetFilter.cc.

{
  const int maxInTrackHitIdDifference = 3;
  bool isCorrectFacet = operator()(facet, maxInTrackHitIdDifference);
 
  bool isCorrectReverseFacet =
    this->getAllowReverse() and operator()(facet.reversed(), maxInTrackHitIdDifference);
 
  if (isCorrectFacet) {
    if (facet.getFitLine()->isInvalid()) {
      facet.adjustFitLine();
    }
    return 3.0;
  } else if (isCorrectReverseFacet) {
    if (facet.getFitLine()->isInvalid()) {
      facet.adjustFitLine();
    }
    return -3.0;
  } else {
    return NAN;
  }
}

◆ operator()() [2/5]

bool operator()	(	const CDCRLWireHitTriple &	rlWireHitTriple,
		int	maxInTrackHitIdDifference
	)

private

Indicated if the oriented triple is a correct hypotheses.

Definition at line 53 of file MCFacetFilter.cc.

{
  const CDCMCHitLookUp& mcHitLookUp = CDCMCHitLookUp::getInstance();
 
  const CDCWireHit& startWireHit = rlWireHitTriple.getStartWireHit();
  const CDCWireHit& middleWireHit = rlWireHitTriple.getMiddleWireHit();
  const CDCWireHit& endWireHit = rlWireHitTriple.getEndWireHit();
 
  // First check if the track ids are in agreement
  ITrackType startMCTrackId = mcHitLookUp.getMCTrackId(startWireHit.getHit());
  ITrackType middleMCTrackId = mcHitLookUp.getMCTrackId(middleWireHit.getHit());
  ITrackType endMCTrackId = mcHitLookUp.getMCTrackId(endWireHit.getHit());
 
  if (startMCTrackId == INVALID_ITRACK or
      middleMCTrackId == INVALID_ITRACK or
      endMCTrackId == INVALID_ITRACK) {
    return false;
  }
 
  if (not(startMCTrackId == middleMCTrackId and middleMCTrackId == endMCTrackId)) {
    return false;
  }
 
  int startInTrackId = mcHitLookUp.getInTrackId(startWireHit.getHit());
  int middleInTrackId = mcHitLookUp.getInTrackId(middleWireHit.getHit());
  int endInTrackId = mcHitLookUp.getInTrackId(endWireHit.getHit());
 
  int startToMiddleInTrackDistance =  middleInTrackId - startInTrackId;
  int middleToEndInTrackDistance =  endInTrackId - middleInTrackId;
 
  // Now check the alignment in track
  bool distanceInTrackIsSufficientlyLow =
    0 < startToMiddleInTrackDistance and startToMiddleInTrackDistance <= maxInTrackHitIdDifference and
    0 < middleToEndInTrackDistance and middleToEndInTrackDistance <= maxInTrackHitIdDifference;
 
 
  if (not distanceInTrackIsSufficientlyLow) return false;
 
  // Now check the right left information in track
  ERightLeft startRLInfo = rlWireHitTriple.getStartRLInfo();
  ERightLeft middleRLInfo = rlWireHitTriple.getMiddleRLInfo();
  ERightLeft endRLInfo = rlWireHitTriple.getEndRLInfo();
 
  ERightLeft mcStartRLInfo = mcHitLookUp.getRLInfo(startWireHit.getHit());
  ERightLeft mcMiddleRLInfo = mcHitLookUp.getRLInfo(middleWireHit.getHit());
  ERightLeft mcEndRLInfo = mcHitLookUp.getRLInfo(endWireHit.getHit());
 
  if (startRLInfo == mcStartRLInfo and middleRLInfo == mcMiddleRLInfo and endRLInfo == mcEndRLInfo) {
    return true;
  } else {
    return false;
  }
}

◆ operator()() [3/5]

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/5]

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/5]

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

◆ 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_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/facet/include/MCFacetFilter.h
tracking/trackFindingCDC/filters/facet/src/MCFacetFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Interface

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ MCFacetFilter()

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getAllowReverse()

◆ getNProcessingSignalListener()

◆ initialize()

◆ needsTruthInformation()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ setAllowReverse()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_param_allowReverse

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated