Filter rejecting hits according to DB values. More...

#include <CutsFromDBWireHitFilter.h>

Inheritance diagram for CutsFromDBWireHitFilter:

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
	CutsFromDBWireHitFilter ()
	Default constructor.

virtual	~CutsFromDBWireHitFilter ()=default
	Default destructor.

void	initialize () final
	Called at the beginning of the processing.

void	beginRun () final
	Called when a new run is started.

Weight	operator() (const CDCWireHit &wireHit) final
	Basic filter method to override.

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	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 Member Functions
void	checkIfDBObjPtrIsValid ()
	Check if m_CDCWireHitRequirementsFromDB is valid and set m_DBPtrIsValidForCurrentRun accordingly.

template<typename T >
bool	isInRange (const T &value, const std::pair< T, T > &range) const
	Check if value >= range.first and value <= range.second If range.second == -1, then check only if value >= range.first.

template<typename T >
bool	isLessThanOrEqualTo (const T &value, const T &upper_value) const
	Check if value <= upper_value If upper_value == -1, then return true.

Private Attributes
std::unique_ptr< DBObjPtr< CDCWireHitRequirements > >	m_CDCWireHitRequirementsFromDB
	Cut values from the Data Base.

bool	m_DBPtrIsValidForCurrentRun
	Boolean asserting if DBObjPtr is valid for the current run.

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 rejecting hits according to DB values.

Definition at line 23 of file CutsFromDBWireHitFilter.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.

Constructor & Destructor Documentation

◆ CutsFromDBWireHitFilter()

CutsFromDBWireHitFilter ( )

Default constructor.

Definition at line 16 of file CutsFromDBWireHitFilter.cc.

                                                 :
  m_CDCWireHitRequirementsFromDB(nullptr), m_DBPtrIsValidForCurrentRun(false)
{
}

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

finalvirtual

Called when a new run is started.

Reimplemented from ProcessingSignalListener.

Definition at line 27 of file CutsFromDBWireHitFilter.cc.

{
  checkIfDBObjPtrIsValid();
}

◆ checkIfDBObjPtrIsValid()

void checkIfDBObjPtrIsValid ( )

private

Check if m_CDCWireHitRequirementsFromDB is valid and set m_DBPtrIsValidForCurrentRun accordingly.

Definition at line 32 of file CutsFromDBWireHitFilter.cc.

{
  if (!m_CDCWireHitRequirementsFromDB) {
    B2ERROR("std::unique_ptr<DBObjPtr<CDCWireHitRequirements> > m_CDCWireHitRequirementsFromDB not properly set.\n"
            "Cut not applied on CDCWireHit by CutsFromDBWireHitFilter.  { findlet: CutsFromDBWireHitFilter }");
    m_DBPtrIsValidForCurrentRun = false;
  } else {
    if (!((*m_CDCWireHitRequirementsFromDB).isValid())) {
      B2WARNING("DBObjPtr<CDCWireHitRequirements> not valid for current run.  { findlet: CutsFromDBWireHitFilter }\n"
                "Cut not applied on CDCWireHit by CutsFromDBWireHitFilter.  { findlet: CutsFromDBWireHitFilter }");
      m_DBPtrIsValidForCurrentRun = false;
    } else {
      m_DBPtrIsValidForCurrentRun = true;
    }
  }
}

◆ 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 LayerSVDRelationFilter< AFilter, APrefilter >, SectorMapBasedSVDPairFilter, MCAxialSegmentPairFilter, Chi2FacetFilter, FeasibleRLFacetFilter, RealisticFacetFilter, SimpleFacetFilter, MCFacetRelationFilter, MCSegmentPairFilter, MCSegmentPairRelationFilter, MCSegmentRelationFilter, MCSegmentTripleFilter, MCSegmentTripleRelationFilter, WholeWireHitRelationFilter, LayerRelationFilter< AFilter >, DuplicateCDCPathPairFilter, DistanceCDCStateFilter, ExtrapolateAndUpdateCDCStateFilter, RoughCDCfromEclStateFilter, RoughCDCStateFilter, AdvanceFilter< AState, AnAdvancer >, AngularDistancePXDPairFilter, CylinderDistancePXDPairFilter, InterceptDistancePXDPairFilter, LayerPXDRelationFilter< AFilter, APrefilter >, LoosePXDPairFilter, SensorPXDPairFilter, LooseSVDPairFilter, SensorSVDPairFilter, ResidualSVDStateFilter, PhiRecoTrackRelationFilter, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, Chi2FacetRelationFilter, SimpleFacetRelationFilter, PhiTrackRelationFilter, BridgingWireHitRelationFilter, FiveHitFilter, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, AngleAndTimeRelationFilter, and SimpleRelationFilter.

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

42 {

43 }

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

finalvirtual

Called at the beginning of the processing.

Reimplemented from ProcessingSignalListener.

Definition at line 21 of file CutsFromDBWireHitFilter.cc.

{
  m_CDCWireHitRequirementsFromDB = std::make_unique<DBObjPtr<CDCWireHitRequirements> >();
  checkIfDBObjPtrIsValid();
}

◆ isInRange()

bool isInRange	(	const T &	value,
		const std::pair< T, T > &	range
	)		const

private

Check if value >= range.first and value <= range.second If range.second == -1, then check only if value >= range.first.

Definition at line 52 of file CutsFromDBWireHitFilter.cc.

{
  if (range.second == -1) {
    return (value >= range.first);
  } else {
    return (value >= range.first) && (value <= range.second);
  }
}

◆ isLessThanOrEqualTo()

bool isLessThanOrEqualTo	(	const T &	value,
		const T &	upper_value
	)		const

private

Check if value <= upper_value If upper_value == -1, then return true.

Definition at line 64 of file CutsFromDBWireHitFilter.cc.

{
  if (upper_value == -1) {
    return true;
  } else {
    return value <= upper_value;
  }
}

◆ 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 CDCWireHit & wireHit )

final

Basic filter method to override.

Definition at line 73 of file CutsFromDBWireHitFilter.cc.

{
  const short ADC = (*wireHit.getHit()).getADCCount();
  const short TOT = (*wireHit.getHit()).getTOT();
  const float ADCOverTOT = (TOT != 0) ? static_cast<float>(ADC) / TOT : 0;
 
  if (m_DBPtrIsValidForCurrentRun) {
    if ((*wireHit.getHit()).getISuperLayer() == 0) {
      // First super layer (0)
      // Check if ADC, TOT and ADC/TOT are in the corresponding allowed ranges.
      if (isInRange<short>(ADC, (*m_CDCWireHitRequirementsFromDB)->getADCRangeFirstSuperLayer()) &&
          isInRange<short>(TOT, (*m_CDCWireHitRequirementsFromDB)->getTOTRangeFirstSuperLayer()) &&
          isInRange<float>(ADCOverTOT, (*m_CDCWireHitRequirementsFromDB)->getADCOverTOTRangeFirstSuperLayer()) &&
          isLessThanOrEqualTo<short>(ADC, (*m_CDCWireHitRequirementsFromDB)->getMaxADCGivenTOTFirstSuperLayer(TOT))) {
        // Hit accepted
        return ADC;
      } else {
        // Hit rejected
        return NAN;
      }
 
    } else {
      // Outer super layers (1-8)
      // Check if ADC, TOT and ADC/TOT are in the corresponding allowed ranges.
      if (isInRange<short>(ADC, (*m_CDCWireHitRequirementsFromDB)->getADCRangeOuterSuperLayers()) &&
          isInRange<short>(TOT, (*m_CDCWireHitRequirementsFromDB)->getTOTRangeOuterSuperLayers()) &&
          isInRange<float>(ADCOverTOT, (*m_CDCWireHitRequirementsFromDB)->getADCOverTOTRangeOuterSuperLayers()) &&
          isLessThanOrEqualTo<short>(ADC, (*m_CDCWireHitRequirementsFromDB)->getMaxADCGivenTOTOuterSuperLayers(TOT))) {
        // Hit accepted
        return ADC;
      } else {
        // Hit rejected
        return NAN;
      }
    }
  }
  // If the DB pointer is not valid, the hit is accepted (cf. B2WARNING above)
  return ADC;
}

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

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

std::unique_ptr<DBObjPtr<CDCWireHitRequirements> > m_CDCWireHitRequirementsFromDB

private

Cut values from the Data Base.

Definition at line 59 of file CutsFromDBWireHitFilter.h.

◆ m_DBPtrIsValidForCurrentRun

bool m_DBPtrIsValidForCurrentRun

private

Boolean asserting if DBObjPtr is valid for the current run.

Definition at line 62 of file CutsFromDBWireHitFilter.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.

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

tracking/trackFindingCDC/filters/wireHit/include/CutsFromDBWireHitFilter.h
tracking/trackFindingCDC/filters/wireHit/src/CutsFromDBWireHitFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Interface

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ CutsFromDBWireHitFilter()

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ checkIfDBObjPtrIsValid()

◆ endRun()

◆ exposeParameters()

◆ getNProcessingSignalListener()

◆ initialize()

◆ isInRange()

◆ isLessThanOrEqualTo()

◆ needsTruthInformation()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ terminate()

Member Data Documentation

◆ m_CDCWireHitRequirementsFromDB

◆ m_DBPtrIsValidForCurrentRun

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated