Trk::FsmwMode1dFinder Class Reference

Algotool which calculates the mode of a unidimenensional distribution using the Fraction of Sample Mode with Weights algorithm, which is an iterative Least Median estimator. More...

#include <FsmwMode1dFinder.h>

Inheritance diagram for Trk::FsmwMode1dFinder:

Collaboration diagram for Trk::FsmwMode1dFinder:

Classes
struct	CompareTheTwoDoubleAndWeights
struct	CompareTheTwoDoubles

Public Member Functions
	FsmwMode1dFinder (const std::string &t, const std::string &n, const IInterface *p)
virtual	~FsmwMode1dFinder ()
virtual double	getMode (std::vector< DoubleAndWeight >) const override final
virtual double	getMode (std::vector< double >) const override final
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
double	m_fraction
double	m_firstfraction
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Algotool which calculates the mode of a unidimenensional distribution using the Fraction of Sample Mode with Weights algorithm, which is an iterative Least Median estimator.

It's like an iterative "Half Sample Mode", but the fraction you take at each step can be configured by the user (in the job option file).

Configuration possibilities: (1) fraction (default is 50 %)

Details on this and other kinds of mode finders can be found in Waltenberger's PhD thesis, done collaborating with CMS.

Author

Giaci.nosp@m.nto..nosp@m.Piacq.nosp@m.uadi.nosp@m.o@phy.nosp@m.sik..nosp@m.uni-f.nosp@m.reib.nosp@m.urg.d.nosp@m.e

Definition at line 37 of file FsmwMode1dFinder.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

FsmwMode1dFinder()

Trk::FsmwMode1dFinder::FsmwMode1dFinder	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 19 of file FsmwMode1dFinder.cxx.

                                                                                                 : 
    AthAlgTool(t,n,p),
    m_fraction(0.5),
    m_firstfraction(0.5)
  {   
    declareProperty("Fraction",     m_fraction);
    declareProperty("FirstFraction", m_firstfraction);
    declareInterface<IMode1dFinder>(this);
  }

~FsmwMode1dFinder()

Trk::FsmwMode1dFinder::~FsmwMode1dFinder ( )

virtualdefault

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

getMode() [1/2]

double Trk::FsmwMode1dFinder::getMode ( std::vector< double > Doubles ) const

finaloverridevirtual

Implements Trk::IMode1dFinder.

Definition at line 175 of file FsmwMode1dFinder.cxx.

                                                                  {
    
 
 
#ifdef FSMWMODE1DFINDER_DEBUG
    msg(MSG::DEBUG) << "entered FsmwMode1dFinder::GetMode " << endmsg;
#endif
  
    //first of all order the vector according to the double value
    std::sort(Doubles.begin(),Doubles.end(),CompareTheTwoDoubles() );
  
    //ok now begin to consider a certain number of elements according to the fraction
    std::vector<double>::const_iterator begin=Doubles.begin();
    std::vector<double>::const_iterator end=Doubles.end();
 
    //    double overallweight(0.);
    std::vector<double>::const_iterator best_begin=begin;
    std::vector<double>::const_iterator best_end=end;
 
#ifdef FSMWMODE1DFINDER_DEBUG
    msg(MSG::DEBUG) << "Size of incoming vector is" << Doubles.size() << endmsg;
#endif
    
 
    double last_value(1e100);
    
    bool isthelast=false;
    while (!isthelast) {
#ifdef FSMWMODE1DFINDER_DEBUG
      if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Before \"int step = (int)std::floor(m_fraction*(end-begin+1))\" " << endmsg;
#endif
    int step = (int)std::floor(m_fraction*(end-begin+1));
#ifdef FSMWMODE1DFINDER_DEBUG
      if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "After \"int step = (int)std::floor(m_fraction*(end-begin+1))\" " << endmsg;
#endif
    for (std::vector<double>::const_iterator i=begin;i!=(end-step+1);++i) {
#ifdef FSMWMODE1DFINDER_DEBUG
      if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Interval number unknown, value: " << i->first << endmsg;
#endif  
      //calculate the weight the interval should be divided into
      //      overallweight=0.;
      //for (std::vector<double>::const_iterator j=i;j!=i+step;j++) {
      //#ifdef FSMWMODE1DFINDER_DEBUG
      //if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "In the single interval, the component number unknown, value: " << j->first << " weight " 
      //<< j->second << endmsg;
      //#endif        
      //overallweight+=j->second;
      //}
      if ((*(i+step-1)-*i)<last_value) {
#ifdef FSMWMODE1DFINDER_DEBUG
    msg(MSG::DEBUG) << "New value: " << *(i+step-1)-*i << " while the previous one was " << 
        last_value << endmsg;
    if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Best case since ever now" << endmsg;
#endif        
    last_value=*(i+step-1)-*i;
    best_begin=i;
    best_end=i+step-1;
      }
    }
    
#ifdef FSMWMODE1DFINDER_DEBUG
    if(msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "Ended a cycle with success" << endmsg;
#endif
 
    //assign the new begin and end...
    begin=best_begin;
    end=best_end;
    last_value=1e100;
    
    //Now it should have returned the value with smallest (x2-x1)/weight
    if (best_end-best_begin<=2) isthelast=true;
  }
 
    if (best_end-best_begin==2)
    {
      std::vector<double>::const_iterator medium=begin;
      ++medium;
      return (*begin+*medium+*end)/3.;
    }
 
    //return the weighted mean of the best_begin and best_end
    return (*begin+*end)/2.;
    
    
  }

getMode() [2/2]

double Trk::FsmwMode1dFinder::getMode ( std::vector< DoubleAndWeight > DoubleAndWeights ) const

finaloverridevirtual

Implements Trk::IMode1dFinder.

Definition at line 38 of file FsmwMode1dFinder.cxx.

                                                                                    {
    
    if(DoubleAndWeights.empty()) return 0.;
    if(DoubleAndWeights.size() == 1) return DoubleAndWeights.begin()->first;
    
#ifdef FSMWMODE1DFINDER_DEBUG
    msg(MSG::DEBUG) << "entered FsmwMode1dFinder::GetMode " << endmsg;
#endif
    
  //first of all order the vector according to the double value
    std::sort(DoubleAndWeights.begin(),DoubleAndWeights.end(),CompareTheTwoDoubleAndWeights() );
  
    //ok now begin to consider a certain number of elements according to the fraction
    std::vector<DoubleAndWeight>::const_iterator begin=DoubleAndWeights.begin();
    std::vector<DoubleAndWeight>::const_iterator end=DoubleAndWeights.end();
 
    double overallweight(0.);
    std::vector<DoubleAndWeight>::const_iterator best_begin=begin;
    std::vector<DoubleAndWeight>::const_iterator best_end=end;
 
#ifdef FSMWMODE1DFINDER_DEBUG
    msg(MSG::DEBUG) << "Size of incoming vector is" << DoubleAndWeights.size() << endmsg;
#endif
    
 
    double last_value(1e100);
    
    bool isthelast=false;
 
    int counter=0;
    double fraction=m_firstfraction;
    while (!isthelast) {
 
      counter+=1;
      if (counter==2) {
    fraction = m_fraction;
      }
 
#ifdef FSMWMODE1DFINDER_DEBUG
      if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Before \"int step = (int)std::floor(fraction*(end-begin+1))\" " << endmsg;
#endif
    int step = (int)std::floor(fraction*(end-begin+1));
    overallweight=0.;
    {
      std::vector<DoubleAndWeight>::const_iterator i=begin;
      if (step>0) {
        std::vector<DoubleAndWeight>::const_iterator j_end=i+step-1;
      for (std::vector<DoubleAndWeight>::const_iterator j=i;j!=j_end;++j) {
#ifdef FSMWMODE1DFINDER_DEBUG
    if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "In the single interval, the component number unknown, value: " << j->first << " weight " 
    << j->second << endmsg;
#endif        
    overallweight+=j->second;
      }
      }
    }
 
    std::vector<DoubleAndWeight>::const_iterator i_last = begin+step-1;
 
#ifdef FSMWMODE1DFINDER_DEBUG
    if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "After \"int step = (int)std::floor(fraction*(end-begin+1))\" " << endmsg;
#endif
    for (std::vector<DoubleAndWeight>::const_iterator i=begin;i!=(end-step+1);++i, ++i_last) {
#ifdef FSMWMODE1DFINDER_DEBUG
      if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Interval number unknown, value: " << i->first << endmsg;
#endif  
 
      //calculate the weight the interval should be divided into
      overallweight+= i_last->second;
 
      #ifdef FSMWMODE1DFINDER_DEBUG
      if (debug_counter>0)
      {
        --debug_counter;
      double alt_overallweight=0.;
      for (std::vector<DoubleAndWeight>::const_iterator j=i;j!=i+step;j++) {
#ifdef FSMWMODE1DFINDER_DEBUG
    if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "In the single interval, the component number unknown, value: " << j->first << " weight " 
    << j->second << endmsg;
#endif        
    alt_overallweight+=j->second;
      }
      if (std::abs(alt_overallweight - overallweight) > alt_overallweight * std::numeric_limits<double>::epsilon() * 16 ) {
        ATH_MSG_ERROR("Weights differ: " << alt_overallweight  << " != " << overallweight);
      }
      }
      #endif
 
 
      double new_value = ((i+step-1)->first-i->first)/overallweight;
      if (new_value<last_value) {
#ifdef FSMWMODE1DFINDER_DEBUG
    msg(MSG::DEBUG) << "New value: " << ((i+step-1)->first-i->first)/overallweight << " while the previous one was " << 
        last_value << endmsg;
    if(msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Best case since ever now" << endmsg;
#endif        
    last_value=((i+step-1)->first-i->first)/overallweight;
    best_begin=i;
    best_end=i+step-1;
      }
      overallweight-= i->second;
 
    }
    
#ifdef FSMWMODE1DFINDER_DEBUG
    msg(MSG::DEBUG) << "Ended a cycle with success" << endmsg;
    if (begin==best_begin && end ==best_end) {
      ATH_MSG_ERROR( "No change at step=" << step );
    }
#endif
    //assign the new begin and end...
    begin=best_begin;
    end=best_end;
    last_value=1e100;
    
    //Now it should have returned the value with smallest (x2-x1)/weight
    if (best_end-best_begin<=2) isthelast=true;
  }
 
    //return the weighted mean of the best_begin and best_end
 
    //you are working only on first and last
    //(but what about taking all three ???)
 
    if (best_end-best_begin==2)
    {
      std::vector<DoubleAndWeight>::const_iterator medium=begin;
      ++medium;
      return (begin->first*begin->second+medium->first*medium->second+end->first*end->second)/(begin->second+medium->second+end->second);
    }
    
 
    return (begin->first*begin->second+end->first*end->second)/(begin->second+end->second);
    
  }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & Trk::IMode1dFinder::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 40 of file IMode1dFinder.h.

{ return IID_IMODE1DFINDER; };

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_firstfraction

double Trk::FsmwMode1dFinder::m_firstfraction

private

Definition at line 71 of file FsmwMode1dFinder.h.

m_fraction

double Trk::FsmwMode1dFinder::m_fraction

private

Definition at line 70 of file FsmwMode1dFinder.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• FsmwMode1dFinder.h
• FsmwMode1dFinder.cxx