Chi2FacetRelationFilter Class Reference

Class filtering the neighborhood of facets based on chi2 from a fit both facets. More...

#include <Chi2FacetRelationFilter.h>

Inheritance diagram for Chi2FacetRelationFilter:

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
	Chi2FacetRelationFilter ()
	Constructor with the default chi2 cut value and width parameter.
	Chi2FacetRelationFilter (double chi2Cut, double penaltyWidth)
	Constructor using given chi2 cut value and width parameter.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the set of parameters of the filter to the module parameter list.
void	initialize () final
	Initialise the parameter caches before the processing starts.
Weight	operator() (const CDCFacet &fromFacet, const CDCFacet &toFacet) final
	Main filter method returning the weight of the neighborhood relation.
std::vector< const CDCFacet * >	getPossibleTos (const CDCFacet *from, const std::vector< const CDCFacet * > &facets) const final
	Returns the selection of facets covering the range of possible neighboring facets of the given facet out of the sorted range given by the two other arguments.
virtual std::vector< const CDCFacet * >	getPossibleTos (const CDCFacet *from, const std::vector< const CDCFacet * > &objects) const
	Selects the objects possibly related to the given one from the given pool of objects.
virtual Weight	operator() (const const CDCFacet &from, const const CDCFacet &to)
	Main filter method returning the weight of the neighborhood relation.
virtual std::vector< float >	operator() (const std::vector< Relation< const CDCFacet > * > &objs) override
	Filter over a vector of relations.
Weight	operator() (const Relation< const CDCFacet > &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	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 = BaseFacetRelationFilter
	Type of the super class.

Private Attributes
std::vector< double >	m_param_chi2CutByISuperLayer {130.0}
	Parameter : The chi2 cut values distinguished by superlayer.
double	m_param_penaltyFactor = 200.0 / 130.0
	Parameter : The chi2 cut values distinguished by superlayer.
std::array< double, ISuperLayerUtil::c_N >	m_chi2CutByISuperLayer {}
	Memory for the chi2 cut values distinguished by superlayer.
std::array< double, ISuperLayerUtil::c_N >	m_penaltyWidthByISuperLayer {}
	Memory for the chi2 cut values distinguished by superlayer.
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

Class filtering the neighborhood of facets based on chi2 from a fit both facets.

Definition at line 27 of file Chi2FacetRelationFilter.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 = BaseFacetRelationFilter

private

Type of the super class.

Definition at line 31 of file Chi2FacetRelationFilter.h.

Constructor & Destructor Documentation

Chi2FacetRelationFilter() [1/2]

Chi2FacetRelationFilter

(

)

Constructor with the default chi2 cut value and width parameter.

Definition at line 24 of file Chi2FacetRelationFilter.cc.

  : m_param_chi2CutByISuperLayer{89.0, 130.0, 130.0, 130.0, 130.0, 130.0, 130.0, 130.0, 130.0}
{
}

Chi2FacetRelationFilter() [2/2]

Chi2FacetRelationFilter	(	double	chi2Cut,
		double	penaltyWidth
	)

Constructor using given chi2 cut value and width parameter.

Definition at line 30 of file Chi2FacetRelationFilter.cc.

  : m_param_chi2CutByISuperLayer{chi2Cut}
  , m_param_penaltyFactor(penaltyWidth / chi2Cut)
{
}

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 set of parameters of the filter to the module parameter list.

Reimplemented from Filter< AObject >.

Definition at line 36 of file Chi2FacetRelationFilter.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter(prefixed(prefix, "chi2CutByISuperLayer"),
                                m_param_chi2CutByISuperLayer,
                                "Acceptable chi2 values by superlayer id",
                                m_param_chi2CutByISuperLayer);
 
  moduleParamList->addParameter(prefixed(prefix, "penaltyFactor"),
                                m_param_penaltyFactor,
                                "Factor for cut value to obtain the width used in translation from chi2 values to weight penalties",
                                m_param_penaltyFactor);
}

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

getPossibleTos() [1/2]

std::vector< const CDCFacet * > getPossibleTos ( const CDCFacet *  from, const std::vector< const CDCFacet * > &  facets  ) const

finalinherited

Returns the selection of facets covering the range of possible neighboring facets of the given facet out of the sorted range given by the two other arguments.

Definition at line 30 of file BaseFacetRelationFilter.cc.

{
  const CDCRLWireHitPair& rearRLWireHitPair = from->getRearRLWireHitPair();
 
  ConstVectorRange<const CDCFacet*> neighbors{
    std::equal_range(facets.begin(), facets.end(), &rearRLWireHitPair, LessOf<Deref>())};
  return {neighbors.begin(), neighbors.end()};
}

getPossibleTos() [2/2]

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

initialize()

void initialize ( )

finalvirtual

Initialise the parameter caches before the processing starts.

Reimplemented from ProcessingSignalListener.

Definition at line 52 of file Chi2FacetRelationFilter.cc.

{
  Super::initialize();
  if (m_param_chi2CutByISuperLayer.size() == 1) {
    for (int iSL = 0; iSL < ISuperLayerUtil::c_N; ++iSL) {
      m_chi2CutByISuperLayer[iSL] = m_param_chi2CutByISuperLayer[0];
      m_penaltyWidthByISuperLayer[iSL] = m_param_chi2CutByISuperLayer[0] * m_param_penaltyFactor;
    }
  } else if (m_param_chi2CutByISuperLayer.size() == ISuperLayerUtil::c_N) {
    for (int iSL = 0; iSL < ISuperLayerUtil::c_N; ++iSL) {
      m_chi2CutByISuperLayer[iSL] = m_param_chi2CutByISuperLayer[iSL];
      m_penaltyWidthByISuperLayer[iSL] = m_param_chi2CutByISuperLayer[iSL] * m_param_penaltyFactor;
    }
  } else {
    B2ERROR("Expected chi2CutByISuperLayer to be of length 1 or "
            << ISuperLayerUtil::c_N
            << " received "
            << m_param_chi2CutByISuperLayer.size());
  }
 
}

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

Weight operator() ( const CDCFacet &  fromFacet, const CDCFacet &  toFacet  )

final

Main filter method returning the weight of the neighborhood relation.

Definition at line 74 of file Chi2FacetRelationFilter.cc.

{
  if (fromFacet.getStartWireHit().isOnWire(toFacet.getEndWire())) return NAN;
 
  constexpr const int nSteps = 0;
  const UncertainParameterLine2D fitLine = FacetFitter::fit(fromFacet, toFacet, nSteps);
  const double chi2 = fitLine.chi2();
 
  ISuperLayer iSL = fromFacet.getISuperLayer();
  if (chi2 > m_chi2CutByISuperLayer[iSL] or std::isnan(chi2)) {
    return NAN;
  } else {
    // Introducing a mini penalty to distinguish better facets.
    double penalty = std::erf(chi2 / m_penaltyWidthByISuperLayer[iSL]);
 
    // The facets contain three hits of the track each.
    // However they have 2 common hits which we have to subtract
    // to avoid double counting.
    // Also introduce a small penalty value to distinguish better continuations
    // in the graph
    return -2 - penalty;
  }
}

operator()() [2/7]

Weight operator() ( const const CDCFacet &  from, const const CDCFacet &  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()() [3/7]

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

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

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

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

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

std::array<double, ISuperLayerUtil::c_N> m_chi2CutByISuperLayer {}

private

Memory for the chi2 cut values distinguished by superlayer.

Definition at line 60 of file Chi2FacetRelationFilter.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_param_chi2CutByISuperLayer

std::vector<double> m_param_chi2CutByISuperLayer {130.0}

private

Parameter : The chi2 cut values distinguished by superlayer.

Definition at line 53 of file Chi2FacetRelationFilter.h.

m_param_penaltyFactor

double m_param_penaltyFactor = 200.0 / 130.0

private

Parameter : The chi2 cut values distinguished by superlayer.

Definition at line 56 of file Chi2FacetRelationFilter.h.

m_penaltyWidthByISuperLayer

std::array<double, ISuperLayerUtil::c_N> m_penaltyWidthByISuperLayer {}

private

Memory for the chi2 cut values distinguished by superlayer.

Definition at line 63 of file Chi2FacetRelationFilter.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/facetRelation/include/Chi2FacetRelationFilter.h
• tracking/trackFindingCDC/filters/facetRelation/src/Chi2FacetRelationFilter.cc