SimpleSegmentTripleFilter Class Reference

Filter for the construction of segment triples based on simple criteria. More...

#include <SimpleSegmentTripleFilter.h>

Inheritance diagram for SimpleSegmentTripleFilter:

Public Types
using	Object = CDCSegmentTriple
	Type of the object to be analysed.
using	Interface = Filter< CDCSegmentTriple >
	Mark this class as the basic interface.

Public Member Functions
Weight	operator() (const CDCSegmentTriple &segmentTriple) final
	Checks if a triple of axial, stereo and axial segments is a good combination to be stored.
virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the set of parameters of the filter to the module parameter list.
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 = Filter< CDCSegmentTriple >
	Type of the base class.

Private Member Functions
const CDCRiemannFitter &	getFitter2D () const
	Returns the xy fitter instance that is used by this filter.
const CDCSZFitter &	getSZFitter () const
	Returns the sz fitter instance that is used by this filter.

Private Attributes
CDCSZFitter	m_szFitter
	Memory of the SZ fitter fitting sz lines to the stereo segments.
CDCRiemannFitter	m_riemannFitter
	Memory of the Riemann fitter for the circle fits.
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 segment triples based on simple criteria.

Definition at line 22 of file SimpleSegmentTripleFilter.h.

Member Typedef Documentation

Interface

using Interface = Filter<CDCSegmentTriple >

inherited

Mark this class as the basic interface.

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

Object

using Object = CDCSegmentTriple

inherited

Type of the object to be analysed.

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

Super

using Super = Filter<CDCSegmentTriple>

private

Type of the base class.

Definition at line 26 of file SimpleSegmentTripleFilter.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  )

virtualinherited

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

Note that not all filters have yet exposed their parameters in this way.

This method is deprecated as the exposeParams below uses a less compile heavy equivalent.

Reimplemented in MCSegmentTripleFilter, and MCSymmetric< BaseSegmentTripleFilter >.

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

    {
    }

getFitter2D()

const CDCRiemannFitter & getFitter2D ( ) const

inlineprivate

Returns the xy fitter instance that is used by this filter.

Definition at line 39 of file SimpleSegmentTripleFilter.h.

      { return m_riemannFitter; }

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

getSZFitter()

const CDCSZFitter & getSZFitter ( ) const

inlineprivate

Returns the sz fitter instance that is used by this filter.

Definition at line 43 of file SimpleSegmentTripleFilter.h.

      { return m_szFitter; }

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

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

    {
      return false;
    }

operator()() [1/4]

Weight operator() ( const CDCSegmentTriple &  segmentTriple )

final

Checks if a triple of axial, stereo and axial segments is a good combination to be stored.

Checks the proper alignment and the quality of connection between all three segments. Returns NAN if the connection shall not be made or a finit value be used as the cell weight of the cell to constructed.

Definition at line 23 of file SimpleSegmentTripleFilter.cc.

{
  const CDCAxialSegment2D* ptrStartSegment = segmentTriple.getStartSegment();
  const CDCStereoSegment2D* ptrMiddleSegment = segmentTriple.getMiddleSegment();
  const CDCAxialSegment2D* ptrEndSegment = segmentTriple.getEndSegment();
 
  assert(ptrStartSegment);
  assert(ptrMiddleSegment);
  assert(ptrEndSegment);
 
  const CDCAxialSegment2D& startSegment = *ptrStartSegment;
  const CDCStereoSegment2D& middleSegment = *ptrMiddleSegment;
  const CDCAxialSegment2D& endSegment = *ptrEndSegment;
 
  const double toleranceFraction = 0.0;
 
  // Check if the middle segment lies within the acceptable bounds in angular deviation
  {
    //get the remembered fits
    const CDCTrajectory2D& startFit = startSegment.getTrajectory2D();
    const CDCTrajectory2D& endFit = endSegment.getTrajectory2D();
 
    //use only the first and last hit for this check
    const CDCRecoHit2D& firstHit = middleSegment.front();
    const CDCRecoHit2D& lastHit = middleSegment.back();
 
    Vector3D firstRecoPos = firstHit.reconstruct3D(startFit);
    Vector3D lastRecoPos = lastHit.reconstruct3D(endFit);
 
    const CDCWire& firstWire = firstHit.getWire();
    const CDCWire& lastWire = lastHit.getWire();
 
    const bool agrees =
      firstWire.isInCellZBounds(firstRecoPos, toleranceFraction) and
      lastWire.isInCellZBounds(lastRecoPos, toleranceFraction);
 
    if (not agrees) return NAN;
  }
 
  // make more complex judgement on fitness
 
  // Get the combined fit of start and end axial segment
  CDCTrajectory2D trajectory2D =  getFitter2D().fit(*(segmentTriple.getStartSegment()),
                                                    *(segmentTriple.getEndSegment()));
 
  // Check if the middle segment is actually coaligned with the trajectory
  EForwardBackward fbInfo = trajectory2D.isForwardOrBackwardTo(middleSegment);
  if (fbInfo != EForwardBackward::c_Forward) return NAN;
 
  // Reconstruct the middle stereo segment
  CDCSegment3D reconstructedMiddle;
  for (const CDCRecoHit2D& recoHit2D : middleSegment) {
    reconstructedMiddle.push_back(CDCRecoHit3D::reconstruct(recoHit2D, trajectory2D));
    if (not reconstructedMiddle.back().isInCellZBounds(toleranceFraction)) {
      B2DEBUG(25, "  RecoHit out of CDC");
      return NAN;
    }
  }
 
  // Fit the sz slope and intercept
  CDCTrajectorySZ trajectorySZ;
  getSZFitter().update(trajectorySZ, middleSegment, trajectory2D);
  segmentTriple.setTrajectory3D(CDCTrajectory3D(trajectory2D, trajectorySZ));
 
  Weight result = startSegment.size() + middleSegment.size() + endSegment.size();
 
  return result;
}

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

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

    {
      return 1;
    }

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

    {
      return obj ? operator()(*obj) : 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 86 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_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_riemannFitter

CDCRiemannFitter m_riemannFitter

private

Memory of the Riemann fitter for the circle fits.

Definition at line 51 of file SimpleSegmentTripleFilter.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_szFitter

CDCSZFitter m_szFitter

private

Memory of the SZ fitter fitting sz lines to the stereo segments.

Definition at line 48 of file SimpleSegmentTripleFilter.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/segmentTriple/include/SimpleSegmentTripleFilter.h
• tracking/trackFindingCDC/filters/segmentTriple/src/SimpleSegmentTripleFilter.cc