CylinderDistancePXDPairFilter Class Reference

Base filter for CKF PXD states. More...

#include <CylinderDistancePXDPairFilter.h>

Inheritance diagram for CylinderDistancePXDPairFilter:

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 std::pair< const CKFToPXDState *, const CKFToPXDState * > &relation) override
	Return the weight based on azimuthal-angle separation.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters.
virtual bool	needsTruthInformation ()
	Indicates if the filter requires Monte Carlo information.
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	initialize () override
	Receive and dispatch signal before the start of the event processing.
void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.
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
bool	m_param_isBackwardCKF = true
	Is backward or forward ToPXDCKF?
double	m_param_CylinderExtrapolationToHitPhiCut = 0.1
	Filter potential relations in phi between seed states (based on MeasuredStateOnPlane) and hit states.
double	m_param_CylinderExtrapolationToHitThetaCut = 0.1
	Filter potential relations in theta between seed states (based on MeasuredStateOnPlane) and hit states.
double	m_param_RecoTrackToHitPhiCut = 0.5
	Filter potential relations in phi between seed states (based on RecoTracks) and hit states.
double	m_param_RecoTrackToHitThetaCut = 0.5
	Filter potential relations in theta between seed states (based on RecoTracks) and hit states.
double	m_param_HitHitPhiCut = 0.2
	Filter potential relations in phi between hit states.
double	m_param_HitHitThetaCut = 0.2
	Filter potential relations in theta between hit states.
const std::array< double, 2 >	c_PXDLayerRadii = {1.42854, 2.21218}
	PXD layer radii.
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

Base filter for CKF PXD states.

Definition at line 19 of file CylinderDistancePXDPairFilter.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.

Reimplemented in SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

{
  Super::beginEvent();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->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  )

overridevirtual

Expose the parameters.

Reimplemented from Filter< AObject >.

Definition at line 99 of file CylinderDistancePXDPairFilter.cc.

{
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "isBackwardCKF"), m_param_isBackwardCKF,
                                "Does this CKF extrapolate the tracks backward or forward?",
                                m_param_isBackwardCKF);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "cylinderExtrapolationToHitPhiCut"),
                                m_param_CylinderExtrapolationToHitPhiCut,
                                "Cut in phi for the difference between extrapolated position of the Seed to a cylinder with the radius of the ToState layer and the ToState.",
                                m_param_CylinderExtrapolationToHitPhiCut);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "cylinderExtrapolationToHitThetaCut"),
                                m_param_CylinderExtrapolationToHitThetaCut,
                                "Cut in theta for the difference between extrapolated position of the Seed to a cylinder with the radius of the ToState layer and the ToState.",
                                m_param_CylinderExtrapolationToHitThetaCut);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "recoTrackToHitPhiCut"), m_param_RecoTrackToHitPhiCut,
                                "Cut in phi for the difference between RecoTrack information and current hit-based state.",
                                m_param_RecoTrackToHitPhiCut);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "recoTrackToHitThetaCut"), m_param_RecoTrackToHitThetaCut,
                                "Cut in theta for the difference between RecoTrack information and current hit-based state.",
                                m_param_RecoTrackToHitThetaCut);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "hitHitPhiCut"), m_param_HitHitPhiCut,
                                "Cut in phi between two hit-based states.", m_param_HitHitPhiCut);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "hitHitThetaCut"), m_param_HitHitThetaCut,
                                "Cut in theta between two hit-based states.", m_param_HitHitThetaCut);
}

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.

Reimplemented in UnionVarSet< AObject >, UnionVarSet< Object >, VariadicUnionVarSet< AVarSets >, ResultStorer< Belle2::CKFToPXDResult >, ResultStorer< Belle2::CKFToSVDResult >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, OnVarSet< BaseSegmentPairRelationFilter >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreArrayLoader< const Belle2::SpacePoint >, StoreArrayLoader< DataStoreInputTypeRefType >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RelationVarSet< ABaseVarSet >, QualityIndicatorFilter, TwoHitVirtualIPQIFilter, MultiHoughSpaceFastInterceptFinder, RawTrackCandCleaner< AHit >, RawTrackCandCleaner< Belle2::vxdHoughTracking::VXDHoughState >, RecoTrackStorer, ROIFinder, SingleHoughSpaceFastInterceptFinder, SpacePointLoaderAndPreparer, TrackCandidateOverlapResolver, and TrackCandidateResultRefiner.

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

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

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

TrackFindingCDC::Weight operator() ( const std::pair< const CKFToPXDState *, const CKFToPXDState * > &  relation )

override

Return the weight based on azimuthal-angle separation.

Definition at line 24 of file CylinderDistancePXDPairFilter.cc.

{
  const CKFToPXDState& fromState = *(relation.first);
  const CKFToPXDState& toState = *(relation.second);
 
  const CKFToPXDState::stateCache& fromStateCache = fromState.getStateCache();
  const CKFToPXDState::stateCache& toStateCache = toState.getStateCache();
 
  B2ASSERT("You have filled the wrong states into this!", toStateCache.isHitState);
 
  if (not fromStateCache.isHitState) {
    // We are coming from an SVD / CDC-SVD track, so we can use its position to only look for matching ladders
    // RecoTracks were fitted before CKF, so the measured states on planes should exist
    const RecoTrack* seedRecoTrack = fromState.getSeed();
    genfit::MeasuredStateOnPlane measuredStateOnPlane =
      m_param_isBackwardCKF ? seedRecoTrack->getMeasuredStateOnPlaneFromFirstHit() : seedRecoTrack->getMeasuredStateOnPlaneFromLastHit();
 
    bool extrapolationSuccessful = true;
    try {
      measuredStateOnPlane.extrapolateToCylinder(c_PXDLayerRadii[toStateCache.geoLayer - 1]);
    }  catch (...) {
      B2DEBUG(20, "ToPXDCKF CylinderDistancePXDPairFilter: extrapolation to cylinder of layer " << toStateCache.geoLayer <<
              " with radius of " << c_PXDLayerRadii[toStateCache.geoLayer - 1] << " failed");
      extrapolationSuccessful = false;
    }
 
    if (extrapolationSuccessful) {
      const ROOT::Math::XYZVector& positionOnCylinder = ROOT::Math::XYZVector(measuredStateOnPlane.getPos());
 
      float phiDiff = positionOnCylinder.Phi() - toStateCache.phi;
      while (phiDiff > M_PI) phiDiff -= 2. * M_PI;
      while (phiDiff < -M_PI) phiDiff += 2. * M_PI;
      const float thetaDiff = positionOnCylinder.Theta() - toStateCache.theta;
      if (abs(phiDiff) < static_cast<float>(m_param_CylinderExtrapolationToHitPhiCut) and
          abs(thetaDiff) < static_cast<float>(m_param_CylinderExtrapolationToHitThetaCut)) {
        return 1.0;
      } else {
        return NAN;
      }
    } else {
      // We don't have have an extrapolated position on the layer of the ToState based on this Seed (RecoTrack), so use simple angular filters.
      float phiDiff = fromStateCache.phi - toStateCache.phi;
      while (phiDiff > M_PI) phiDiff -= 2. * M_PI;
      while (phiDiff < -M_PI) phiDiff += 2. * M_PI;
      const float thetaDiff = fromStateCache.theta - toStateCache.theta;
      if (abs(phiDiff) < static_cast<float>(m_param_RecoTrackToHitPhiCut) and
          abs(thetaDiff) < static_cast<float>(m_param_RecoTrackToHitThetaCut)) {
        return 1.0;
      }
      return NAN;
    }
  }
 
  // On same layer we already know from LayerPXDRelationFilter, that we only deal with overlaps in r-phi.
  // So it's sufficient here to check for same layer number to accept states in the overlap region.
  if (fromStateCache.geoLayer == toStateCache.geoLayer and
      fromStateCache.sensorID.getSensorNumber() == toStateCache.sensorID.getSensorNumber()) {
    // TODO: Checking for equality of sensor numbers seems not to harm the hit efficiency,
    // but maybe it's safer to allow for a sensor number difference of 1?
    return 1.0;
  }
 
  float phiDiff = fromStateCache.phi - toStateCache.phi;
  while (phiDiff > M_PI) phiDiff -= 2. * M_PI;
  while (phiDiff < -M_PI) phiDiff += 2. * M_PI;
  const float thetaDiff = fromStateCache.theta - toStateCache.theta;
 
  if (abs(phiDiff) < static_cast<float>(m_param_HitHitPhiCut) and
      abs(thetaDiff) < static_cast<float>(m_param_HitHitThetaCut)) {
    return 1.0;
  }
 
  return NAN;
}

operator()() [4/4]

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

c_PXDLayerRadii

const std::array<double, 2> c_PXDLayerRadii = {1.42854, 2.21218}

private

PXD layer radii.

Definition at line 42 of file CylinderDistancePXDPairFilter.h.

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_param_CylinderExtrapolationToHitPhiCut

double m_param_CylinderExtrapolationToHitPhiCut = 0.1

private

Filter potential relations in phi between seed states (based on MeasuredStateOnPlane) and hit states.

Definition at line 30 of file CylinderDistancePXDPairFilter.h.

m_param_CylinderExtrapolationToHitThetaCut

double m_param_CylinderExtrapolationToHitThetaCut = 0.1

private

Filter potential relations in theta between seed states (based on MeasuredStateOnPlane) and hit states.

Definition at line 32 of file CylinderDistancePXDPairFilter.h.

m_param_HitHitPhiCut

double m_param_HitHitPhiCut = 0.2

private

Filter potential relations in phi between hit states.

Definition at line 38 of file CylinderDistancePXDPairFilter.h.

m_param_HitHitThetaCut

double m_param_HitHitThetaCut = 0.2

private

Filter potential relations in theta between hit states.

Definition at line 40 of file CylinderDistancePXDPairFilter.h.

m_param_isBackwardCKF

bool m_param_isBackwardCKF = true

private

Is backward or forward ToPXDCKF?

Definition at line 28 of file CylinderDistancePXDPairFilter.h.

m_param_RecoTrackToHitPhiCut

double m_param_RecoTrackToHitPhiCut = 0.5

private

Filter potential relations in phi between seed states (based on RecoTracks) and hit states.

Definition at line 34 of file CylinderDistancePXDPairFilter.h.

m_param_RecoTrackToHitThetaCut

double m_param_RecoTrackToHitThetaCut = 0.5

private

Filter potential relations in theta between seed states (based on RecoTracks) and hit states.

Definition at line 36 of file CylinderDistancePXDPairFilter.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/ckf/pxd/filters/relations/include/CylinderDistancePXDPairFilter.h
• tracking/ckf/pxd/filters/relations/src/CylinderDistancePXDPairFilter.cc