FilterVarSet< AFilter > Class Template Reference

Class to compute floating point variables from a filter response which can be recorded as a flat TNtuple or serve as input to a MVA method. More...

#include <FilterVarSet.dcl.h>

Inheritance diagram for FilterVarSet< AFilter >:

Public Types
using	Filter = AFilter
	Type of the filter.
using	Object = typename Filter::Object
	Type of the object from which the filter judgement should be extracted.

Public Member Functions
	FilterVarSet (const std::string &filterName="")
	Construct the varset making an instance of the template filter.
	FilterVarSet (const std::string &filterName, std::unique_ptr< Filter > ptrFilter)
	Construct the varset.
bool	extract (const Object *obj) final
	Generate filter weight variable from the object.
void	initialize () final
	Initialize the filter before event processing.
std::vector< Named< Float_t * > >	getNamedVariables (const std::string &prefix) override
	Getter for the named references to the individual variables Base implementation returns empty vector.
MayBePtr< Float_t >	find (const std::string &varName) override
	Pointer to the variable with the given name.
std::vector< Named< Float_t * > >	getNamedVariables ()
	Getter for the named references to the individual variables.
virtual bool	extract (const Object *obj)
	Main method that extracts the variable values from the complex object.
bool	extract (const Object &obj)
	Method for extraction from an object instead of a pointer.
std::map< std::string, Float_t >	getNamedValues (const std::string &prefix) const
	Getter for a map of names to float values.
std::map< std::string, Float_t >	getNamedValues () const
	Getter for a map of names to float values.
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.

Public Attributes
double	m_cut = NAN
	The cut on the filter output.
std::string	m_filterName
	Name of the filter.
std::string	m_filterNamePrefix
	Prefix to be put in front of the filter variables.
std::unique_ptr< Filter >	m_ptrFilter
	Filter from which to generate weight as a variable set;.

Protected Member Functions
Float_t	get () const
	Getter for the value of the ith variable. Static version.
Float_t &	var ()
	Reference getter for the value of the ith variable. Static version.
AssignFinite< Float_t >	finitevar ()
	Reference getter for the value of the ith variable. Transforms non-finite values to finite value.
void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.
int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Static Protected Member Functions
static constexpr int	named (const char *name)
	Getter for the index from the name.

Private Types
using	Super = VarSet< FilterVarNames< AFilter > >
	Type of the base class.

Private Attributes
FixedSizeNamedFloatTuple< FilterVarNames< AFilter > >	m_variables
	Memory for nVars floating point values.
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.

Static Private Attributes
static const size_t	nVars
	Number of floating point values represented by this class.

Detailed Description

template<class AFilter>
class Belle2::TrackFindingCDC::FilterVarSet< AFilter >

Class to compute floating point variables from a filter response which can be recorded as a flat TNtuple or serve as input to a MVA method.

The variables that are extracted from the filter response are the weight and a boolean whether the response was NaN.

Definition at line 47 of file FilterVarSet.dcl.h.

Member Typedef Documentation

Filter

using Filter = AFilter

Type of the filter.

Definition at line 55 of file FilterVarSet.dcl.h.

Object

using Object = typename Filter::Object

Type of the object from which the filter judgement should be extracted.

Definition at line 58 of file FilterVarSet.dcl.h.

Super

using Super = VarSet<FilterVarNames<AFilter> >

private

Type of the base class.

Definition at line 51 of file FilterVarSet.dcl.h.

Constructor & Destructor Documentation

FilterVarSet() [1/2]

FilterVarSet

(

const std::string &

filterName = ""

)

Construct the varset making an instance of the template filter.

Definition at line 47 of file FilterVarSet.icc.h.

      : Super()
      , m_filterName(filterName)
      , m_filterNamePrefix(filterName + '_')
      , m_ptrFilter(std::make_unique<Filter>())
    {
    }

FilterVarSet() [2/2]

FilterVarSet	(	const std::string &	filterName,
		std::unique_ptr< Filter >	ptrFilter
	)

Construct the varset.

Definition at line 56 of file FilterVarSet.icc.h.

      : Super()
      , m_filterName(filterName)
      , m_filterNamePrefix(filterName + '_')
      , m_ptrFilter(std::move(ptrFilter))
    {
    }

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

extract() [1/3]

bool extract ( const Object &  obj )

inlineinherited

Method for extraction from an object instead of a pointer.

Definition at line 56 of file BaseVarSet.h.

      {
        return extract(&obj);
      }

extract() [2/3]

virtual bool extract ( const Object *  obj )

inlinevirtualinherited

Main method that extracts the variable values from the complex object.

Returns indication whether the extraction could be completed successfully. Base implementation returns always true.

Parameters

obj	dummy object not used

Returns

: always true for the base implementation

Definition at line 50 of file BaseVarSet.h.

      {
        return true;
      }

extract() [3/3]

bool extract ( const Object *  obj )

final

Generate filter weight variable from the object.

Definition at line 66 of file FilterVarSet.icc.h.

    {
      bool extracted = Super::extract(obj);
      if (m_ptrFilter and obj) {
        Weight weight = (*m_ptrFilter)(*obj);
        this->template var<named("weight")>() = weight;
        this->template var<named("accept")>() = not std::isnan(weight) and not(weight < m_cut);
        this->template var<named("positive")>() = weight > 0 and not(weight < m_cut);
 
        // Forward the nested result.
        return extracted;
      } else {
        return false;
      }
    }

find()

MayBePtr< Float_t > find ( const std::string &  varName )

overridevirtual

Pointer to the variable with the given name.

Returns nullptr if not found.

Reimplemented from BaseVarSet< AVarNames::Object >.

Definition at line 108 of file FilterVarSet.icc.h.

    {
      if (varName.find(m_filterNamePrefix) == 0) {
        std::string varNameWithoutPrefix = varName.substr(m_filterNamePrefix.size());
        MayBePtr<Float_t> found = Super::find(varNameWithoutPrefix);
        if (found) return found;
      }
      return nullptr;
    }

finitevar()

AssignFinite< Float_t > finitevar ( )

inlineprotectedinherited

Reference getter for the value of the ith variable. Transforms non-finite values to finite value.

Definition at line 130 of file VarSet.h.

      {
        static_assert(I < nVars, "Requested variable index exceeds number of variables.");
        return AssignFinite<Float_t>(m_variables[I]);
      }

get()

Float_t get ( ) const

inlineprotectedinherited

Getter for the value of the ith variable. Static version.

Definition at line 85 of file VarSet.h.

      {
        static_assert(I < nVars, "Requested variable index exceeds number of variables.");
        return m_variables.get(I);
      }

getNamedValues() [1/2]

std::map< std::string, Float_t > getNamedValues ( ) const

inlineinherited

Getter for a map of names to float values.

Definition at line 95 of file BaseVarSet.h.

      {
        const std::string prefix = "";
        return this->getNamedValues(prefix);
      }

getNamedValues() [2/2]

std::map< std::string, Float_t > getNamedValues ( const std::string &  prefix ) const

inlineinherited

Getter for a map of names to float values.

Parameters

prefix

Name prefix to apply to all variable names.

Definition at line 83 of file BaseVarSet.h.

      {
        std::map<std::string, Float_t> result;
        std::vector<Named<Float_t*> > namedVariables = this->getNamedVariables(prefix);
        for (const Named<Float_t*>& namedVariable : namedVariables) {
          Float_t* variable = namedVariable;
          result[namedVariable.getName()] = *variable;
        }
        return result;
      }

getNamedVariables() [1/2]

std::vector< Named< Float_t * > > getNamedVariables ( )

inlineinherited

Getter for the named references to the individual variables.

Definition at line 73 of file BaseVarSet.h.

      {
        const std::string prefix = "";
        return this->getNamedVariables(prefix);
      }

getNamedVariables() [2/2]

std::vector< Named< Float_t * > > getNamedVariables ( const std::string &  prefix )

overridevirtual

Getter for the named references to the individual variables Base implementation returns empty vector.

Reimplemented from BaseVarSet< AVarNames::Object >.

Definition at line 102 of file FilterVarSet.icc.h.

    {
      return Super::getNamedVariables(prefix + m_filterNamePrefix);
    }

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

Initialize the filter before event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 83 of file FilterVarSet.icc.h.

    {
      ModuleParamList moduleParamList;
      const std::string prefix = "";
      m_ptrFilter->exposeParameters(&moduleParamList, prefix);
 
      // try to find the MVAFilter cut parameter and reset it such that we can set it
      std::vector<std::string> paramNames = moduleParamList.getParameterNames();
      if (std::count(paramNames.begin(), paramNames.end(), "cut")) {
        ModuleParam<double>& cutParam = moduleParamList.getParameter<double>("cut");
        m_cut = cutParam.getValue();
        cutParam.setDefaultValue(NAN);
      }
 
      this->addProcessingSignalListener(m_ptrFilter.get());
      Super::initialize();
    }

named()

static constexpr int named ( const char *  name )

inlinestaticconstexprprotectedinherited

Getter for the index from the name.

Looks through the associated names and returns the right index if found Returns nVars (one after the last element) if not found.

Parameters

name	Name of the sought variable

Returns

Index of the name, nVars if not found.

Definition at line 78 of file VarSet.h.

      {
        return index<nVars>(AVarNames::getName, name);
      }

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

var()

Float_t & var ( )

inlineprotectedinherited

Reference getter for the value of the ith variable. Static version.

Definition at line 93 of file VarSet.h.

      {
        static_assert(I < nVars, "Requested variable index exceeds number of variables.");
        return m_variables[I];
      }

Member Data Documentation

m_cut

double m_cut = NAN

The cut on the filter output.

Definition at line 88 of file FilterVarSet.dcl.h.

m_filterName

std::string m_filterName

Name of the filter.

Definition at line 91 of file FilterVarSet.dcl.h.

m_filterNamePrefix

std::string m_filterNamePrefix

Prefix to be put in front of the filter variables.

Definition at line 94 of file FilterVarSet.dcl.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_ptrFilter

std::unique_ptr<Filter> m_ptrFilter

Filter from which to generate weight as a variable set;.

Definition at line 97 of file FilterVarSet.dcl.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.

m_variables

FixedSizeNamedFloatTuple<FilterVarNames< AFilter > > m_variables

privateinherited

Memory for nVars floating point values.

Definition at line 138 of file VarSet.h.

nVars

const size_t nVars

staticprivateinherited

Number of floating point values represented by this class.

Definition at line 48 of file VarSet.h.

---

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

• tracking/trackFindingCDC/filters/base/include/FilterVarSet.dcl.h
• tracking/trackFindingCDC/filters/base/include/FilterVarSet.icc.h