Base filter for CKF PXD states. More...

#include <LayerPXDRelationFilter.dcl.h>

Inheritance diagram for LayerPXDRelationFilter< AFilter, APrefilter >:

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
	LayerPXDRelationFilter ()
	Add the filter as listener.

	~LayerPXDRelationFilter ()
	Default destructor.

std::vector< CKFToPXDState * >	getPossibleTos (CKFToPXDState from, const std::vector< CKFToPXDState > &states) const override
	Return all states the given state is possible related to.

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

TrackFindingCDC::Weight	operator() (const CKFToPXDState &from, const CKFToPXDState &to) override
	Give a final weight to the possibilities by asking the filter.

void	initialize () override
	Receive signal before the start of the event processing.

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

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

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

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

Weight	operator() (const Relation< CKFToPXDState > &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.

virtual bool	needsTruthInformation ()
	Indicates if the filter requires Monte Carlo information.

void	beginEvent () override
	Receive and dispatch signal for the start of a new event.

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 = TrackFindingCDC::RelationFilter< CKFToPXDState >
	The parent class.

Private Attributes
int	m_param_hitJumping = 0
	Parameter: Make it possible to jump over N layers (if set to -1, read from DB).

int	m_layerJumpLowPt = m_param_hitJumping
	This are values that are actually used ('m_param_hitJumping==-1' means parameter is read from DB).

int	m_layerJumpHighPt = m_param_hitJumping
	This are values that are actually used ('m_param_hitJumping==-1' means parameter is read from DB).

double	m_layerJumpPtThreshold = -1
	This are values that are actually used ('m_param_hitJumping==-1' means parameter is read from DB).

AFilter	m_filter
	Filter for rejecting the states.

APrefilter	m_prefilter
	Loose pre-filter to reject possibleTos.

std::string	m_prefix = ""
	Used to get correct payload.

std::unique_ptr< DBObjPtr< CKFParameters > >	m_ckfParameters
	LayerJump parameter can be read from DB (use pointer as payload name contains 'prefix')

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

template<class AFilter, class APrefilter = AFilter>
class Belle2::LayerPXDRelationFilter< AFilter, APrefilter >

Base filter for CKF PXD states.

Definition at line 22 of file LayerPXDRelationFilter.dcl.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 = TrackFindingCDC::RelationFilter<CKFToPXDState>

private

The parent class.

Definition at line 24 of file LayerPXDRelationFilter.dcl.h.

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

Receive and dispatch signal for the start of a new event.

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

{
  Super::beginEvent();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginEvent();
  }
}

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

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ getPossibleTos()

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

◆ needsTruthInformation()

bool needsTruthInformation

virtualinherited

Indicates if the filter requires Monte Carlo information.

Reimplemented in MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, and OnVarSet< BaseSegmentPairRelationFilter >.

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

    {
      return false;
    }

◆ operator()() [1/6]

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

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()() [3/6]

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()() [4/6]

Weight operator() ( const Relation< CKFToPXDState > & 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()() [5/6]

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

virtual std::vector< float > operator() ( const std::vector< Relation< CKFToPXDState > * > & 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;
      }

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

std::unique_ptr<DBObjPtr<CKFParameters> > m_ckfParameters

private

LayerJump parameter can be read from DB (use pointer as payload name contains 'prefix')

Definition at line 65 of file LayerPXDRelationFilter.dcl.h.

◆ m_filter

AFilter m_filter

private

Filter for rejecting the states.

Definition at line 59 of file LayerPXDRelationFilter.dcl.h.

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

int m_layerJumpHighPt = m_param_hitJumping

private

This are values that are actually used ('m_param_hitJumping==-1' means parameter is read from DB).

Definition at line 55 of file LayerPXDRelationFilter.dcl.h.

◆ m_layerJumpLowPt

int m_layerJumpLowPt = m_param_hitJumping

private

This are values that are actually used ('m_param_hitJumping==-1' means parameter is read from DB).

Definition at line 53 of file LayerPXDRelationFilter.dcl.h.

◆ m_layerJumpPtThreshold

double m_layerJumpPtThreshold = -1

private

This are values that are actually used ('m_param_hitJumping==-1' means parameter is read from DB).

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

◆ m_param_hitJumping

int m_param_hitJumping = 0

private

Parameter: Make it possible to jump over N layers (if set to -1, read from DB).

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

◆ m_prefilter

APrefilter m_prefilter

private

Loose pre-filter to reject possibleTos.

Definition at line 61 of file LayerPXDRelationFilter.dcl.h.

◆ m_prefix

std::string m_prefix = ""

private

Used to get correct payload.

Definition at line 63 of file LayerPXDRelationFilter.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/ckf/pxd/filters/relations/include/LayerPXDRelationFilter.dcl.h
tracking/ckf/pxd/filters/relations/include/LayerPXDRelationFilter.icc.h

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Interface

◆ Object

◆ Super

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ endRun()

◆ getNProcessingSignalListener()

◆ getPossibleTos()

◆ needsTruthInformation()

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]

◆ operator()() [5/6]

◆ operator()() [6/6]

◆ terminate()

Member Data Documentation

◆ m_ckfParameters

◆ m_filter

◆ m_initialized

◆ m_initializedAs

◆ m_layerJumpHighPt

◆ m_layerJumpLowPt

◆ m_layerJumpPtThreshold

◆ m_param_hitJumping

◆ m_prefilter

◆ m_prefix

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated