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

#include <BkgTruthClusterVarSet.h>

Inheritance diagram for BkgTruthClusterVarSet:

Public Types
using	Object = typename Super::Object
	Type from which variables should be extracted.

Public Member Functions
void	initialize () override
	Signal the initialisation of the event processing - requires the Monte Carlo information.

void	beginEvent () override
	Signal the beginning of a new event - loads the Monte Carlo information.

bool	extract (const CDCWireHitCluster *ptrCluster) final
	Generate and assign the contained variables.

std::vector< Named< Float_t * > >	getNamedVariables (const std::string &prefix) override
	Getter for the named references to the individual variables Base implementaton returns empty vector.

std::vector< Named< Float_t * > >	getNamedVariables ()
	Getter for the named references to the individual variables.

MayBePtr< Float_t >	find (const std::string &varName) override
	Pointer to the variable with the given name.

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	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
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< BkgTruthClusterVarNames >
	Type of the base class.

Private Attributes
FixedSizeNamedFloatTuple< BkgTruthClusterVarNames >	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 happend before.

bool	m_terminated = false
	Flag to keep track whether termination happend 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

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

Definition at line 50 of file BkgTruthClusterVarSet.h.

Member Typedef Documentation

◆ Object

using Object = typename Super::Object

inherited

Type from which variables should be extracted.

Definition at line 44 of file VarSet.h.

◆ Super

using Super = VarSet<BkgTruthClusterVarNames>

private

Type of the base class.

Definition at line 54 of file BkgTruthClusterVarSet.h.

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

overridevirtual

Signal the beginning of a new event - loads the Monte Carlo information.

Reimplemented from ProcessingSignalListener.

Definition at line 24 of file BkgTruthClusterVarSet.cc.

{
  Super::beginEvent();
  CDCMCManager::getInstance().fill();
}

◆ 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 CDCWireHitCluster * ptrCluster )

final

Generate and assign the contained variables.

Definition at line 30 of file BkgTruthClusterVarSet.cc.

{
  if (not ptrCluster) return false;
  const CDCWireHitCluster& cluster = *ptrCluster;
 
  int nBackgroundHits = 0;
 
  for (const CDCWireHit* wireHit : cluster) {
    const CDCHit* hit = wireHit->getHit();
 
    if (CDCMCHitLookUp::getInstance().isBackground(hit)) {
      ++nBackgroundHits;
    }
  }
 
  // Variables with Monte Carlo information should carry truth in their name.
  var<named("n_background_hits_truth")>() = nBackgroundHits;
  var<named("background_fraction_truth")>() = 1.0 * nBackgroundHits / cluster.size();
  var<named("weight")>() = cluster.size();
  var<named("truth")>() = (1.0 * nBackgroundHits / cluster.size() > 0.8) ? 0 : 1;
  return true;
}

◆ extract() [2/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() [3/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;
      }

◆ find()

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

inlineoverridevirtualinherited

Pointer to the variable with the given name.

Returns nullptr if not found.

Reimplemented from BaseVarSet< AVarNames::Object >.

Definition at line 64 of file VarSet.h.

      {
        return m_variables.find(varName);
      }

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

inlineoverridevirtualinherited

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

Reimplemented from BaseVarSet< AVarNames::Object >.

Definition at line 55 of file VarSet.h.

      {
        return m_variables.getNamedVariables(prefix);
      }

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

overridevirtual

Signal the initialisation of the event processing - requires the Monte Carlo information.

Reimplemented from ProcessingSignalListener.

Definition at line 18 of file BkgTruthClusterVarSet.cc.

{
  Super::initialize();
  CDCMCManager::getInstance().requireTruthInformation();
}

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

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happend 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 happend before.

Definition at line 55 of file ProcessingSignalListener.h.

◆ m_variables

FixedSizeNamedFloatTuple<BkgTruthClusterVarNames > 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/cluster/include/BkgTruthClusterVarSet.h
tracking/trackFindingCDC/filters/cluster/src/BkgTruthClusterVarSet.cc

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Object

◆ Super

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ extract() [1/3]

◆ extract() [2/3]

◆ extract() [3/3]

◆ find()

◆ finitevar()

◆ get()

◆ getNamedValues() [1/2]

◆ getNamedValues() [2/2]

◆ getNamedVariables() [1/2]

◆ getNamedVariables() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ named()

◆ terminate()

◆ var()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_variables

◆ nVars