Small class which stores the filters/selectionVariables to be used for a secMap and has an interface for applying them. More...

#include <FilterMill.h>

Collaboration diagram for FilterMill< PointType >:

[legend]

Classes
struct	HitPair
	small struct containing pointers to two hits. More...

struct	HitQuadruplet
	small struct containing pointers to four hits. More...

struct	HitTriplet
	small struct containing pointers to three hits. More...

Public Types
using	TwoHitFunction = typename std::function< double(const PointType &, const PointType &)>
	typedef for more readable function-type - to be used for 2-hit-selectionVariables.

using	ThreeHitFunction = typename std::function< double(const PointType &, const PointType &, const PointType &)>
	typedef for more readable function-type - to be used for 3-hit-selectionVariables.

using	FourHitFunction = typename std::function< double(const PointType &, const PointType &, const PointType &, const PointType &)>
	typedef for more readable function-type - to be used for 4-hit-selectionVariables.

Public Member Functions
	FilterMill ()
	Constructor.

void	lockMill ()
	to block adding new filters, execute this member.

void	add2HitFilter (std::pair< const std::string, TwoHitFunction > newFilter)
	add new Filter for 2 Hits .

void	add3HitFilter (std::pair< std::string, ThreeHitFunction > newFilter)
	add new Filter for 3 Hits .

void	add4HitFilter (std::pair< std::string, FourHitFunction > newFilter)
	add new Filter for 4 Hits .

void	grindData2Hit (const HitPair &dataSet, std::vector< std::pair< std::string, double > > &collectedData) const
	on given dataSet, apply all filters stored in the mill and store the results in collectedData.

void	grindData3Hit (const HitTriplet &dataSet, std::vector< std::pair< std::string, double > > &collectedData) const
	on given dataSet, apply all filters stored in the mill and store the results in collectedData.

void	grindData4Hit (const HitQuadruplet &dataSet, std::vector< std::pair< std::string, double > > &collectedData) const
	on given dataSet, apply all filters stored in the mill and store the results in collectedData.

Protected Member Functions
void	checkLocked (const std::string &name) const
	to be executed by functions which shall work with unchangeable set of filters.

Protected Attributes
std::vector< std::pair< std::string, TwoHitFunction > >	m_2Hitfilters
	Contains all 2-hit-Filters and their names to be applied.

std::vector< std::pair< std::string, ThreeHitFunction > >	m_3Hitfilters
	Contains all 3-hit-Filters and their names to be applied.

std::vector< std::pair< std::string, FourHitFunction > >	m_4Hitfilters
	Contains all 4-hit-Filters and their names to be applied.

bool	m_locked = false
	Simple saveguard for not changin any filters after preparing phase.

Detailed Description

template<class PointType>
class Belle2::FilterMill< PointType >

Small class which stores the filters/selectionVariables to be used for a secMap and has an interface for applying them.

Definition at line 25 of file FilterMill.h.

Member Typedef Documentation

◆ FourHitFunction

using FourHitFunction = typename std::function<double(const PointType&, const PointType&, const PointType&, const PointType&)>

typedef for more readable function-type - to be used for 4-hit-selectionVariables.

Definition at line 38 of file FilterMill.h.

◆ ThreeHitFunction

using ThreeHitFunction = typename std::function<double(const PointType&, const PointType&, const PointType&)>

typedef for more readable function-type - to be used for 3-hit-selectionVariables.

Definition at line 34 of file FilterMill.h.

◆ TwoHitFunction

using TwoHitFunction = typename std::function<double(const PointType&, const PointType&)>

typedef for more readable function-type - to be used for 2-hit-selectionVariables.

Definition at line 30 of file FilterMill.h.

Constructor & Destructor Documentation

◆ FilterMill()

FilterMill ( )

inline

Constructor.

Definition at line 94 of file FilterMill.h.

94 :

95 m_locked(false) {}

Belle2::FilterMill::m_locked

bool m_locked

Simple saveguard for not changin any filters after preparing phase.

Definition: FilterMill.h:56

Member Function Documentation

◆ add2HitFilter()

void add2HitFilter ( std::pair< const std::string, TwoHitFunction > newFilter )

inline

add new Filter for 2 Hits .

Definition at line 103 of file FilterMill.h.

    {
      if (m_locked) {
        B2ERROR("FilterMill-add2HitFilter: someone tried to add filter " << newFilter.first <<
                " after lockdown! This is unintended behavior - doing nothing instead...");
        return;
      }
      B2DEBUG(20, "FilterMill::add2HitFilter: filter " << newFilter.first << " added");
      m_2Hitfilters.push_back(std::move(newFilter));
    }

◆ add3HitFilter()

void add3HitFilter ( std::pair< std::string, ThreeHitFunction > newFilter )

inline

add new Filter for 3 Hits .

Definition at line 116 of file FilterMill.h.

    {
      if (m_locked) {
        B2ERROR("FilterMill-add3HitFilter: someone tried to add filter " << newFilter.first <<
                " after lockdown! This is unintended behavior - doing nothing instead...");
        return;
      }
      B2DEBUG(20, "FilterMill::add3HitFilter: filter " << newFilter.first << " added");
      m_3Hitfilters.push_back(std::move(newFilter));
    }

◆ add4HitFilter()

void add4HitFilter ( std::pair< std::string, FourHitFunction > newFilter )

inline

add new Filter for 4 Hits .

Definition at line 129 of file FilterMill.h.

    {
      if (m_locked) {
        B2ERROR("FilterMill-add4HitFilter: someone tried to add filter " << newFilter.first <<
                " after lockdown! This is unintended behavior - doing nothing instead...");
        return;
      }
      B2DEBUG(20, "FilterMill::add4HitFilter: filter " << newFilter.first << " added");
      m_4Hitfilters.push_back(std::move(newFilter));
    }

◆ checkLocked()

void checkLocked ( const std::string & name ) const

inlineprotected

to be executed by functions which shall work with unchangeable set of filters.

Definition at line 60 of file FilterMill.h.

    {
      if (!m_locked) {
        B2WARNING("FilterMill-checkLocked: Function " << name <<
                  " was executed although the Mill was not locked yet. This might be unintended...");
      }
    }

◆ grindData2Hit()

void grindData2Hit	(	const HitPair &	dataSet,
		std::vector< std::pair< std::string, double > > &	collectedData
	)		const

inline

on given dataSet, apply all filters stored in the mill and store the results in collectedData.

Definition at line 142 of file FilterMill.h.

    {
      checkLocked("grindData2Hit");
      if (m_2Hitfilters.empty()) { B2DEBUG(20, "there are no 2-hit-filters stored, skipping grinding"); return; }
 
      std::vector<std::pair<std::string, double>> tempData;
      try {
        for (const auto& filterPack : m_2Hitfilters) {
 
          double result = filterPack.second(
                            *(dataSet.outer),
                            *(dataSet.inner));
          tempData.push_back({filterPack.first, result});
        }
      } catch (...) {
        std::string filterNames;
        for (const auto& filterPack : m_2Hitfilters) {
          filterNames += filterPack.first + " ";
        }
        B2WARNING("FilterMill:grindData2Hit: an exception was thrown by one of the Filters/SelectionVariables, that indicates strange input data, no data collected! Filters "
                  << filterNames << " were used and one of them did not work.");
        return;
      }
 
      collectedData.insert(collectedData.end(), tempData.begin(), tempData.end());
 
      B2DEBUG(20, "FilterMill::grindData2Hit: collectedData has now " << collectedData.size() << " entries");
    }

◆ grindData3Hit()

void grindData3Hit	(	const HitTriplet &	dataSet,
		std::vector< std::pair< std::string, double > > &	collectedData
	)		const

inline

on given dataSet, apply all filters stored in the mill and store the results in collectedData.

Definition at line 174 of file FilterMill.h.

    {
      checkLocked("grindData3Hit");
      if (m_3Hitfilters.empty()) { B2DEBUG(20, "there are no 3-hit-filters stored, skipping grinding"); return; }
 
      std::vector<std::pair<std::string, double>> tempData;
      try {
        for (const auto& filterPack : m_3Hitfilters) {
 
          double result = filterPack.second(
                            *(dataSet.outer),
                            *(dataSet.center),
                            *(dataSet.inner));
          tempData.push_back({filterPack.first, result});
        }
      } catch (...) {
        std::string filterNames;
        for (const auto& filterPack : m_2Hitfilters) {
          filterNames += filterPack.first + " ";
        }
        B2WARNING("FilterMill:grindData3Hit: an exception was thrown by one of the Filters/SelectionVariables, that indicates strange input data, no data collected! Filters "
                  << filterNames << " were used and one of them did not work.");
        return;
      }
      collectedData.insert(collectedData.end(), tempData.begin(), tempData.end());
 
      B2DEBUG(20, "FilterMill::grindData3Hit: collectedData has now " << collectedData.size() << " entries");
    }

◆ grindData4Hit()

void grindData4Hit	(	const HitQuadruplet &	dataSet,
		std::vector< std::pair< std::string, double > > &	collectedData
	)		const

inline

on given dataSet, apply all filters stored in the mill and store the results in collectedData.

Definition at line 206 of file FilterMill.h.

    {
      checkLocked("grindData4Hit");
      if (m_4Hitfilters.empty()) { B2DEBUG(20, "there are no 4-hit-filters stored, skipping grinding"); return; }
 
      std::vector<std::pair<std::string, double>> tempData;
      try {
        for (const auto& filterPack : m_4Hitfilters) {
 
          double result = filterPack.second(
                            *(dataSet.outer),
                            *(dataSet.outerCenter),
                            *(dataSet.innerCenter),
                            *(dataSet.inner));
          tempData.push_back({filterPack.first, result});
        }
      } catch (...) {
        B2WARNING("FilterMill:grindData4Hit: an exception was thrown by one of the Filters/SelectionVariables, that indicates strange input data, no data collected!");
        return;
      }
      collectedData.insert(collectedData.end(), tempData.begin(), tempData.end());
 
      B2DEBUG(20, "FilterMill::grindData4Hit: collectedData has now " << collectedData.size() << " entries");
    }

◆ lockMill()

void lockMill ( )

inline

to block adding new filters, execute this member.

Definition at line 99 of file FilterMill.h.

99{ m_locked = true; }

Member Data Documentation

◆ m_2Hitfilters

std::vector<std::pair<std::string, TwoHitFunction> > m_2Hitfilters

protected

Contains all 2-hit-Filters and their names to be applied.

Definition at line 44 of file FilterMill.h.

◆ m_3Hitfilters

std::vector<std::pair<std::string, ThreeHitFunction> > m_3Hitfilters

protected

Contains all 3-hit-Filters and their names to be applied.

Definition at line 48 of file FilterMill.h.

◆ m_4Hitfilters

std::vector<std::pair<std::string, FourHitFunction> > m_4Hitfilters

protected

Contains all 4-hit-Filters and their names to be applied.

Definition at line 52 of file FilterMill.h.

◆ m_locked

bool m_locked = false

protected

Simple saveguard for not changin any filters after preparing phase.

Definition at line 56 of file FilterMill.h.

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

tracking/trackFindingVXD/sectorMapTools/include/FilterMill.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ FourHitFunction

◆ ThreeHitFunction

◆ TwoHitFunction

Constructor & Destructor Documentation

◆ FilterMill()

Member Function Documentation

◆ add2HitFilter()

◆ add3HitFilter()

◆ add4HitFilter()

◆ checkLocked()

◆ grindData2Hit()

◆ grindData3Hit()

◆ grindData4Hit()

◆ lockMill()

Member Data Documentation

◆ m_2Hitfilters

◆ m_3Hitfilters

◆ m_4Hitfilters

◆ m_locked