FeasibleRLFacetFilter Class Reference

Filter for the construction of good facets investigating the feasibility of the right left passage hypotheses combination. More...

#include <FeasibleRLFacetFilter.h>

Inheritance diagram for FeasibleRLFacetFilter:

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
	FeasibleRLFacetFilter (bool hardRLCut=true)
	Constructor taking a flag if borderline feasible cases should be excluded.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the set of parameters of the filter to the module parameter list.
Weight	operator() (const CDCFacet &facet) final
	Main filter method returning the weight of the facet.
void	setHardRLCut (bool hardRLCut)
	Setter for the flag that the borderline cases should be excluded.
bool	getHardRLCut () const
	Getter for the flag that the borderline cases should be excluded.
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 = BaseFacetFilter
	Type of the super class.

Private Member Functions
bool	isFeasible (const CDCRLWireHitTriple &rlWireHitTriple) const
	Check if the hit triplet is a feasible combination for shape and rl passage information.

Private Attributes
bool	m_param_hardRLCut = true
	Switch for hard selection.
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 investigating the feasibility of the right left passage hypotheses combination.

If the given combination cannot be made by a track reject it.

Definition at line 30 of file FeasibleRLFacetFilter.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 = BaseFacetFilter

private

Type of the super class.

Definition at line 34 of file FeasibleRLFacetFilter.h.

Constructor & Destructor Documentation

FeasibleRLFacetFilter()

FeasibleRLFacetFilter ( bool  hardRLCut = true )

explicit

Constructor taking a flag if borderline feasible cases should be excluded.

Definition at line 22 of file FeasibleRLFacetFilter.cc.

  : m_param_hardRLCut(hardRLCut)
{
}

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  )

finalvirtual

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

Reimplemented from Filter< AObject >.

Definition at line 27 of file FeasibleRLFacetFilter.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
  moduleParamList->addParameter(prefixed(prefix, "hardRLCut"),
                                m_param_hardRLCut,
                                "Switch to disallow the boarderline possible hit and "
                                "right left passage information.",
                                m_param_hardRLCut);
}

getHardRLCut()

bool getHardRLCut ( ) const

inline

Getter for the flag that the borderline cases should be excluded.

Definition at line 59 of file FeasibleRLFacetFilter.h.

      {
        return m_param_hardRLCut;
      }

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

isFeasible()

bool isFeasible ( const CDCRLWireHitTriple &  rlWireHitTriple ) const

private

Check if the hit triplet is a feasible combination for shape and rl passage information.

Definition at line 47 of file FeasibleRLFacetFilter.cc.

{
  const CDCRLWireHitTriple::Shape shape = rlWireHitTriple.getShape();
  const short oClockDelta = shape.getOClockDelta();
  const short absOClockDelta = std::abs(oClockDelta);
  const short cellExtend = shape.getCellExtend();
 
  if (cellExtend + absOClockDelta > 6) {
    // funny formula, but basically checks the triple to be a progressing forward and not turning back in itself.
    return false;
  }
 
  const ERightLeft startRLInfo = rlWireHitTriple.getStartRLInfo();
  const ERightLeft middleRLInfo = rlWireHitTriple.getMiddleRLInfo();
  const ERightLeft endRLInfo = rlWireHitTriple.getEndRLInfo();
 
  const short stableTwist = -sign(shape.getOClockDelta()) * middleRLInfo;
  const bool startToMiddleIsCrossing = startRLInfo != middleRLInfo;
  const bool middleToEndIsCrossing = middleRLInfo != endRLInfo;
 
  const bool bothAreCrossing = startToMiddleIsCrossing and middleToEndIsCrossing;
 
  const bool startToMiddleIsLong = shape.getStartToMiddleCellDistance() > shape.getMiddleToEndCellDistance();
  const bool shortArmIsCrossing = startToMiddleIsLong ? middleToEndIsCrossing : startToMiddleIsCrossing;
 
  const bool onlyOneShortArm = isOdd(cellExtend);
  const bool shortArmsAreCrossing = bothAreCrossing or (onlyOneShortArm and shortArmIsCrossing);
  const bool noneAreCrossing = not startToMiddleIsCrossing and not middleToEndIsCrossing;
 
  const bool orthoHard = stableTwist > 0 and shortArmsAreCrossing;
  const bool ortho = stableTwist > 0 and not noneAreCrossing;
  const bool meta = stableTwist > 0 or noneAreCrossing;
  const bool para = not bothAreCrossing;
 
  // Redundant check saves a bit of computation time.
  if (oClockDelta == 0) {
    return para;
  }
 
  switch (cellExtend) {
    case 2:
      switch (absOClockDelta) {
        case 0:
          return para;
          break;
 
        case 2:
          return ortho or (not m_param_hardRLCut and meta);
          break;
 
        case 4:
          return orthoHard or (not m_param_hardRLCut and ortho);
          break;
      }
      break;
 
    case 3:
      switch (absOClockDelta) {
        case 0:
          return para;
          break;
 
        case 1:
          return meta;
          break;
 
        case 2:
          return orthoHard or (not m_param_hardRLCut and ortho);
          break;
 
        case 3:
          return orthoHard;
          break;
      }
      break;
 
    case 4:
      switch (absOClockDelta) {
        case 0:
          return para;
          break;
 
        case 1:
          return ortho or (not m_param_hardRLCut and meta);
          break;
 
        case 2:
          return orthoHard;
          break;
      }
      break;
  }
  return false;
}

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 CDCFacet &  facet )

final

Main filter method returning the weight of the facet.

Returns NAN if the cell shall be rejected.

Definition at line 38 of file FeasibleRLFacetFilter.cc.

{
  if (this->isFeasible(facet)) {
    return 3;
  } else {
    return NAN;
  }
}

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.

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

setHardRLCut()

void setHardRLCut ( bool  hardRLCut )

inline

Setter for the flag that the borderline cases should be excluded.

Definition at line 53 of file FeasibleRLFacetFilter.h.

      {
        m_param_hardRLCut = hardRLCut;
      }

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_hardRLCut

bool m_param_hardRLCut = true

private

Switch for hard selection.

Definition at line 70 of file FeasibleRLFacetFilter.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/FeasibleRLFacetFilter.h
• tracking/trackFindingCDC/filters/facet/src/FeasibleRLFacetFilter.cc