Filter for two hits plus a virtual IP. More...

#include <TwoHitVirtualIPFilter.h>

Inheritance diagram for TwoHitVirtualIPFilter:

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
TrackFindingCDC::Weight	operator() (const BasePathFilter::Object &pair) override
	Return the weight based on the ThreeHitVariables.

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

void	beginRun () override
	set BField value for estimator

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

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	initialize () override
	Receive and dispatch signal before the start of the event processing.

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 = ProcessingSignalListener
	Type of the base class.

Private Attributes
B2Vector3D	m_virtualIPPosition
	virtual IP vector

double	m_cosRZCut = 0.95
	cut for cosine in RZ between the two vectors (oHit - cHit) and (cHit - iHit)

double	m_circleIPDistanceCut = 2.0
	cut on the difference between circle radius and circle center position in the x-y plane to check if the track is compatible with passing through the IP

ThreeHitVariables	m_threeHitVariables
	Construct empty ThreeHitVariables instance.

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 two hits plus a virtual IP.

Basic working principle: use ThreeHitVariables and provide three B2Vector3D to each variable. These are oHit (outer hit), cHit (middle hit), and iHit (inner hit), which is the virtual IP, and then calculate the variables specified in ThreeHitVariables using the three positions.

Definition at line 25 of file TwoHitVirtualIPFilter.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 = ProcessingSignalListener

privateinherited

Type of the base class.

Definition at line 25 of file CompositeProcessingSignalListener.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();
  }
}

◆ beginRun()

void beginRun ( )

overridevirtual

set BField value for estimator

BeamSpot from DB

Reimplemented from CompositeProcessingSignalListener.

Definition at line 30 of file TwoHitVirtualIPFilter.cc.

{
  const double bFieldZ = BFieldManager::getField(0, 0, 0).Z() / Unit::T;
  m_threeHitVariables.setBFieldZ(bFieldZ);
 
  DBObjPtr<BeamSpot> beamSpotDB;
  if (beamSpotDB.isValid()) {
    const B2Vector3D& BeamSpotPosition = (*beamSpotDB).getIPPosition();
    m_virtualIPPosition.SetXYZ(BeamSpotPosition.X(), BeamSpotPosition.Y(), BeamSpotPosition.Z());
  } else {
    m_virtualIPPosition.SetXYZ(0., 0., 0.);
  }
}

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

overridevirtual

Expose the parameters.

Reimplemented from Filter< AObject >.

Definition at line 20 of file TwoHitVirtualIPFilter.cc.

{
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "cosRZCut"), m_cosRZCut,
                                "Cut on the absolute value of cosine between the vectors (oHit - cHit) and (cHit - iHit).",
                                m_cosRZCut);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "circleIPDistanceCut"), m_circleIPDistanceCut,
                                "Cut on the difference between circle radius and circle center to check whether the circle is compatible with passing through the IP.",
                                m_circleIPDistanceCut);
}

◆ 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

Receive and dispatch signal before the start of the event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 15 of file CompositeProcessingSignalListener.cc.

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

◆ 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/3]

TrackFindingCDC::Weight operator() ( const BasePathFilter::Object & pair )

overridevirtual

Return the weight based on the ThreeHitVariables.

Returns NAN if m_threeHitVariables.getCosAngleRZSimple() of the hit triplet is smaller than m_cosRZCut Returns NAN if m_threeHitVariables.getCircleDistanceIP() of the hit triplet is larger than m_circleIPDistanceCut Returns 1/m_threeHitVariables.getCircleDistanceIP() else

Reimplemented from Filter< AObject >.

Definition at line 47 of file TwoHitVirtualIPFilter.cc.

{
  const std::vector<TrackFindingCDC::WithWeight<const VXDHoughState*>>& previousHits = pair.first;
 
  // Do nothing if path is too short or too long
  if (previousHits.size() != 1) {
    return NAN;
  }
 
  const B2Vector3D& lastHitPos    = previousHits.at(0)->getHit()->getPosition();
  const B2Vector3D& currentHitPos = pair.second->getHit()->getPosition();
 
  // filter expects hits from outer to inner
  m_threeHitVariables.setHits(lastHitPos, currentHitPos, m_virtualIPPosition);
 
  if (m_threeHitVariables.getCosAngleRZSimple() < m_cosRZCut) {
    return NAN;
  }
 
  const double circleDistanceIP = m_threeHitVariables.getCircleDistanceIP();
 
  if (circleDistanceIP > m_circleIPDistanceCut) {
    return NAN;
  }
 
  return fabs(1.0 / circleDistanceIP);
}

◆ operator()() [2/3]

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

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

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

double m_circleIPDistanceCut = 2.0

private

cut on the difference between circle radius and circle center position in the x-y plane to check if the track is compatible with passing through the IP

Definition at line 45 of file TwoHitVirtualIPFilter.h.

◆ m_cosRZCut

double m_cosRZCut = 0.95

private

cut for cosine in RZ between the two vectors (oHit - cHit) and (cHit - iHit)

Definition at line 42 of file TwoHitVirtualIPFilter.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_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.

◆ m_threeHitVariables

ThreeHitVariables m_threeHitVariables

private

Construct empty ThreeHitVariables instance.

Definition at line 48 of file TwoHitVirtualIPFilter.h.

◆ m_virtualIPPosition

B2Vector3D m_virtualIPPosition

private

virtual IP vector

Definition at line 40 of file TwoHitVirtualIPFilter.h.

The documentation for this class was generated from the following files:

tracking/vxdHoughTracking/filters/pathFilters/include/TwoHitVirtualIPFilter.h
tracking/vxdHoughTracking/filters/pathFilters/src/TwoHitVirtualIPFilter.cc

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

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getNProcessingSignalListener()

◆ initialize()

◆ needsTruthInformation()

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ terminate()

Member Data Documentation

◆ m_circleIPDistanceCut

◆ m_cosRZCut

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_threeHitVariables

◆ m_virtualIPPosition