A filter that records variables form given objects. More...

#include <UnionRecordingFilter.dcl.h>

Inheritance diagram for UnionRecording< AFilter >:

Public Types
using	Object = typename AFilter::Object
	Type of the object to be analysed.

Public Member Functions
	UnionRecording (std::unique_ptr< AFilterFactory > filterFactory, const std::string &defaultRootFileName="records.root", const std::string &defaultTreeName="records")
	Constructor of the filter.

	~UnionRecording ()
	Default destructor.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the set of parameters of the filter to the module parameter list.

void	initialize () override
	Initialize the recorder before event processing.

virtual std::vector< std::string >	getValidVarSetNames () const
	Getter for the list of valid names of concret variable sets.

virtual std::vector< std::string >	getValidFilterNames () const
	Getter for the names of valid filters.

virtual std::unique_ptr< AVarSet >	createVarSet (const std::string &name) const
	Create a variable set for the given name.

const std::vector< std::string > &	getVarSetNames () const
	Splits the comma separated variable names list into a vector of names.

void	terminate () override
	Initialize the recorder after event processing.

Weight	operator() (const Object &obj) final
	Function to evaluate the cluster for its backgroundness.

bool	needsTruthInformation () override
	Checks if any variables need Monte Carlo information.

std::unique_ptr< AVarSet >	releaseVarSet () &&
	Steal the set of variables form this filter - filter becomes disfunctional afterwards.

Protected Member Functions
MayBePtr< AFilter >	getSkimFilter () const
	Getter for the skim filter to select objects to be recorded.

void	setSkimFilter (std::unique_ptr< AFilter > skimFilter)
	Setter for the skim filter to select objects to be recorded.

AVarSet &	getVarSet () const
	Getter for the set of variables.

void	setVarSet (std::unique_ptr< AVarSet > varSet)
	Setter for the set of variables.

Private Types
using	Super = Recording< AFilter >
	Type of the super class.

using	AFilterFactory = FilterFactory< AFilter >
	Type of the factory used to produce FilterVarSets to be add to the recording.

using	AVarSet = BaseVarSet< Object >
	Type of the factory used to produce FilterVarSets to be add to the recording.

Private Attributes
std::vector< std::string >	m_param_varSetNames
	List of varsets that should be recorded.

std::string	m_param_skim = ""
	Name of the filter to selected to objects to be record.

std::unique_ptr< AFilterFactory >	m_filterFactory
	FilterFactory.

std::unique_ptr< Recorder >	m_recorder
	Recorder to write all variable sets of the encountered objects.

std::string	m_param_rootFileName
	Name of the ROOT file to which shall be written.

std::string	m_param_treeName
	Name of Tree to be written.

Weight	m_param_returnWeight
	Returns Weight when this filter is called.

std::unique_ptr< AFilter >	m_skimFilter = nullptr
	Skimming filter to select a subset of objects to be recorded.

std::unique_ptr< AVarSet >	m_varSet
	Instance of the variable set to be used in the filter.

Detailed Description

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

A filter that records variables form given objects.

It may record native varsets and/or weigths from other filters.

Definition at line 33 of file UnionRecordingFilter.dcl.h.

Member Typedef Documentation

◆ AFilterFactory

using AFilterFactory = FilterFactory<AFilter>

private

Type of the factory used to produce FilterVarSets to be add to the recording.

Definition at line 40 of file UnionRecordingFilter.dcl.h.

◆ AVarSet

using AVarSet = BaseVarSet<Object>

private

Type of the factory used to produce FilterVarSets to be add to the recording.

Definition at line 48 of file UnionRecordingFilter.dcl.h.

◆ Object

using Object = typename AFilter::Object

Type of the object to be analysed.

Definition at line 44 of file UnionRecordingFilter.dcl.h.

◆ Super

using Super = Recording<AFilter>

private

Type of the super class.

Definition at line 37 of file UnionRecordingFilter.dcl.h.

Constructor & Destructor Documentation

◆ UnionRecording()

UnionRecording	(	std::unique_ptr< AFilterFactory >	filterFactory,
		const std::string &	defaultRootFileName = `"records.root"`,
		const std::string &	defaultTreeName = `"records"`
	)

Constructor of the filter.

Definition at line 35 of file UnionRecordingFilter.icc.h.

      : Super(std::make_unique<UnionVarSet<Object>>(), defaultRootFileName, defaultTreeName)
      , m_filterFactory(std::move(filterFactory))
    {
    }

Member Function Documentation

◆ createVarSet()

auto createVarSet ( const std::string & name ) const

virtual

Create a variable set for the given name.

Reimplemented in UnionRecordingAxialSegmentPairFilter, UnionRecordingFacetFilter, UnionRecordingSegmentPairFilter, UnionRecordingSegmentPairRelationFilter, UnionRecordingTrackRelationFilter, UnionRecordingClusterFilter, UnionRecordingFacetRelationFilter, and UnionRecordingSegmentRelationFilter.

Definition at line 121 of file UnionRecordingFilter.icc.h.

                              {
      if (name.find("filter(") == 0 and name.rfind(")") == name.size() - 1)
      {
        B2INFO("Detected filter name");
        std::string filterName = name.substr(7, name.size() - 8);
        B2INFO("filterName = " << filterName);
        std::unique_ptr<AFilter> filter = m_filterFactory->create(filterName);
        if (not filter) {
          B2WARNING("Could not construct filter for name " << filterName);
          return std::unique_ptr<AVarSet>(nullptr);
        } else {
          AVarSet* filterVarSet = new FilterVarSet<AFilter>(filterName, std::move(filter));
          return std::unique_ptr<AVarSet>(filterVarSet);
        }
      } else {
        return std::unique_ptr<AVarSet>(nullptr);
      }
    }

◆ exposeParameters()

void exposeParameters	(	ModuleParamList *	moduleParamList,
		const std::string &	prefix
	)

override

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

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

    {
      Super::exposeParameters(moduleParamList, prefix);
 
      moduleParamList->addParameter(prefixed(prefix, "varSets"),
                                    m_param_varSetNames,
                                    "List of names refering to concrete variable sets."
                                    "Valid names: " +
                                    join(", ", this->getValidVarSetNames()),
                                    m_param_varSetNames);
 
      moduleParamList->addParameter(prefixed(prefix, "skim"),
                                    m_param_skim,
                                    "Filter name which object must pass to be recorded."
                                    "Valid names: " +
                                    join(", ", this->getValidFilterNames()),
                                    m_param_skim);
    }

◆ getSkimFilter()

MayBePtr< AFilter > getSkimFilter

protectedinherited

Getter for the skim filter to select objects to be recorded.

Definition at line 98 of file RecordingFilter.icc.h.

    {
      return m_skimFilter.get();
    }

◆ getValidFilterNames()

std::vector< std::string > getValidFilterNames

virtual

Getter for the names of valid filters.

Definition at line 104 of file UnionRecordingFilter.icc.h.

    {
      // Get all filter names and make a var set name for each.
      std::map<std::string, std::string> filterNamesAndDescriptions =
        m_filterFactory->getValidFilterNamesAndDescriptions();
 
      std::vector<std::string> filterNames;
      filterNames.reserve(filterNamesAndDescriptions.size());
      for (const auto& filterNameAndDescription :
           filterNamesAndDescriptions) {
        const std::string& filterName = filterNameAndDescription.first;
        filterNames.push_back(filterName);
      }
      return filterNames;
    }

◆ getValidVarSetNames()

std::vector< std::string > getValidVarSetNames

virtual

Getter for the list of valid names of concret variable sets.

Reimplemented in UnionRecordingAxialSegmentPairFilter, UnionRecordingFacetFilter, UnionRecordingSegmentPairFilter, UnionRecordingSegmentPairRelationFilter, UnionRecordingTrackRelationFilter, UnionRecordingClusterFilter, UnionRecordingFacetRelationFilter, and UnionRecordingSegmentRelationFilter.

Definition at line 91 of file UnionRecordingFilter.icc.h.

    {
      // Get all filter names and make a var set name for each.
      std::vector<std::string> varSetNames;
      std::vector<std::string> filterNames = getValidFilterNames();
      for (const std::string& filterName : filterNames) {
        std::string varSetName = "filter(" + filterName + ")";
        varSetNames.push_back(varSetName);
      }
      return varSetNames;
    }

◆ getVarSet()

auto getVarSet

protectedinherited

Getter for the set of variables.

Definition at line 80 of file FilterOnVarSet.icc.h.

    {
      return *m_varSet;
    }

◆ getVarSetNames()

const std::vector< std::string > & getVarSetNames

Splits the comma separated variable names list into a vector of names.

Definition at line 142 of file UnionRecordingFilter.icc.h.

    {
      return m_param_varSetNames;
    }

◆ initialize()

void initialize

override

Initialize the recorder before event processing.

Create the skimming filter

Create and add the concrete varsets from the varset parameter.

Definition at line 67 of file UnionRecordingFilter.icc.h.

    {
      if (m_param_skim != "") {
        std::unique_ptr<AFilter> skimFilter = m_filterFactory->create(m_param_skim);
        this->setSkimFilter(std::move(skimFilter));
      }
 
      auto multiVarSet = std::make_unique<UnionVarSet<Object>>();
 
      for (std::string name : getVarSetNames()) {
        std::unique_ptr<AVarSet> varSet = createVarSet(name);
        if (varSet) {
          multiVarSet->push_back(std::move(varSet));
        } else {
          B2WARNING("Could not create a variable set from name " << name);
        }
      }
      this->setVarSet(std::move(multiVarSet));
      Super::initialize();
    }

◆ needsTruthInformation()

bool needsTruthInformation

overrideinherited

Checks if any variables need Monte Carlo information.

Definition at line 49 of file FilterOnVarSet.icc.h.

    {
      bool result = Super::needsTruthInformation();
      if (result) return true;
 
      const std::vector<Named<Float_t*>>& namedVariables = m_varSet->getNamedVariables();
      for (const Named<Float_t*>& namedVariable : namedVariables) {
        std::string name = namedVariable.getName();
        // If the name contains the word truth it is considered to have Monte carlo information.
        if (name.find("truth") != std::string::npos) {
          return true;
        }
      }
      return false;
    }

◆ operator()()

Weight operator() ( const Object & obj )

finalinherited

Function to evaluate the cluster for its backgroundness.

Definition at line 82 of file RecordingFilter.icc.h.

    {
      if (m_skimFilter) {
        Weight skimWeight = (*m_skimFilter)(obj);
        if (std::isnan(skimWeight)) return NAN;
      }
 
      Weight extracted = Super::operator()(obj);
      if (not std::isnan(extracted)) {
        m_recorder->capture();
      }
 
      return m_param_returnWeight;
    }

◆ releaseVarSet()

auto releaseVarSet ( ) &&

inherited

Steal the set of variables form this filter - filter becomes disfunctional afterwards.

Definition at line 75 of file FilterOnVarSet.icc.h.

                                                                      {
      return std::move(m_varSet);
    }

◆ setSkimFilter()

void setSkimFilter ( std::unique_ptr< AFilter > skimFilter )

protectedinherited

Setter for the skim filter to select objects to be recorded.

Definition at line 104 of file RecordingFilter.icc.h.

    {
      m_skimFilter = std::move(skimFilter);
    }

◆ setVarSet()

void setVarSet ( std::unique_ptr< AVarSet > varSet )

protectedinherited

Setter for the set of variables.

Definition at line 86 of file FilterOnVarSet.icc.h.

    {
      m_varSet = std::move(varSet);
    }

◆ terminate()

void terminate

overrideinherited

Initialize the recorder after event processing.

Definition at line 74 of file RecordingFilter.icc.h.

    {
      m_recorder->write();
      m_recorder.reset();
      Super::terminate();
    }

Member Data Documentation

◆ m_filterFactory

std::unique_ptr<AFilterFactory> m_filterFactory

private

FilterFactory.

Definition at line 85 of file UnionRecordingFilter.dcl.h.

◆ m_param_returnWeight

Weight m_param_returnWeight

privateinherited

Returns Weight when this filter is called.

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

◆ m_param_rootFileName

std::string m_param_rootFileName

privateinherited

Name of the ROOT file to which shall be written.

Definition at line 82 of file RecordingFilter.dcl.h.

◆ m_param_skim

std::string m_param_skim = ""

private

Name of the filter to selected to objects to be record.

Definition at line 82 of file UnionRecordingFilter.dcl.h.

◆ m_param_treeName

std::string m_param_treeName

privateinherited

Name of Tree to be written.

Definition at line 85 of file RecordingFilter.dcl.h.

◆ m_param_varSetNames

std::vector<std::string> m_param_varSetNames

private

List of varsets that should be recorded.

Definition at line 79 of file UnionRecordingFilter.dcl.h.

◆ m_recorder

std::unique_ptr<Recorder> m_recorder

privateinherited

Recorder to write all variable sets of the encountered objects.

Definition at line 79 of file RecordingFilter.dcl.h.

◆ m_skimFilter

std::unique_ptr<AFilter> m_skimFilter = nullptr

privateinherited

Skimming filter to select a subset of objects to be recorded.

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

◆ m_varSet

std::unique_ptr<AVarSet> m_varSet

privateinherited

Instance of the variable set to be used in the filter.

Definition at line 71 of file FilterOnVarSet.dcl.h.

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

tracking/trackFindingCDC/filters/base/include/UnionRecordingFilter.dcl.h
tracking/trackFindingCDC/filters/base/include/UnionRecordingFilter.icc.h

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ AFilterFactory

◆ AVarSet

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ UnionRecording()

Member Function Documentation

◆ createVarSet()

◆ exposeParameters()

◆ getSkimFilter()

◆ getValidFilterNames()

◆ getValidVarSetNames()

◆ getVarSet()

◆ getVarSetNames()

◆ initialize()

◆ needsTruthInformation()

◆ operator()()

◆ releaseVarSet()

◆ setSkimFilter()

◆ setVarSet()

◆ terminate()

Member Data Documentation

◆ m_filterFactory

◆ m_param_returnWeight

◆ m_param_rootFileName

◆ m_param_skim

◆ m_param_treeName

◆ m_param_varSetNames

◆ m_recorder

◆ m_skimFilter

◆ m_varSet