Trk::DetAnnealingMaker Class Reference

This class implements an annealing maker. More...

#include <DetAnnealingMaker.h>

Inheritance diagram for Trk::DetAnnealingMaker:

Collaboration diagram for Trk::DetAnnealingMaker:

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
	DetAnnealingMaker (const std::string &t, const std::string &n, const IInterface *p)
	Default constructor due to Athena interface.
virtual void	reset (AnnealingState &state) const override
	Resets the annealing process to its beginning.
virtual void	anneal (AnnealingState &state) const override
	One more annealing step.
virtual double	getWeight (const AnnealingState &state, double chisq, const std::vector< double > &allchisq) const override
	Weight access method.
virtual double	getWeight (const AnnealingState &state, double chisq) const override
	Weight access method.
virtual bool	isEquilibrium (const AnnealingState &state) const override
	Equilibrium is reached (last scheduled temperature)
virtual double	actualTemp (const AnnealingState &state) const override
	Access to the actual temperature value.

Private Attributes
std::vector< double >	m_SetOfTemperatures
	A vector of temperatures, you will start from SetOfTemperature[0] and Anneal towards SetOfTemperature[last].
double	m_cutoff
	Weight will be insensitive to chi2 at order of magnitude of the cutoff...

Detailed Description

This class implements an annealing maker.

The weight implemented is phi(chi2)=exp[-1/2.*chi2/Temp]

Author

N. Giacinto Piacquadio (for the Freiburg Group)

Definition at line 21 of file DetAnnealingMaker.h.

Constructor & Destructor Documentation

DetAnnealingMaker()

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

Default constructor due to Athena interface.

Definition at line 22 of file DetAnnealingMaker.cxx.

                                                                                                   : 
    base_class(t,n,p),
    m_SetOfTemperatures(1,3),
    m_cutoff(9.)
  {   
    declareProperty("SetOfTemperatures",     m_SetOfTemperatures);           
    declareProperty("Cutoff", m_cutoff);    
  }

Member Function Documentation

actualTemp()

virtual double Trk::DetAnnealingMaker::actualTemp ( const AnnealingState & state ) const

inlineoverridevirtual

Access to the actual temperature value.

Definition at line 67 of file DetAnnealingMaker.h.

    {
      if (state >= m_SetOfTemperatures.size()) {
        return m_SetOfTemperatures.back();
      }
      return m_SetOfTemperatures[state];
    }

anneal()

void Trk::DetAnnealingMaker::anneal ( AnnealingState & state ) const

overridevirtual

One more annealing step.

Definition at line 49 of file DetAnnealingMaker.cxx.

                                                            {
 
//check if there are some temperatures
    if (m_SetOfTemperatures.empty()) 
    {
      ATH_MSG_ERROR( "The vector SetOfTemperatures for the annealing is empty" );
    }
    //go one step further
    ++state;
  }

finalize()

StatusCode Trk::DetAnnealingMaker::finalize ( )

overridevirtual

Definition at line 37 of file DetAnnealingMaker.cxx.

  {
    ATH_MSG_DEBUG( "Finalize successful"  );
    return StatusCode::SUCCESS;
  }

getWeight() [1/2]

double Trk::DetAnnealingMaker::getWeight ( const AnnealingState & state, double chisq ) const

overridevirtual

Weight access method.

Definition at line 73 of file DetAnnealingMaker.cxx.

  {
    double temp = actualTemp (state);
    return gauss(chisq,temp)/(gauss(m_cutoff,temp)+gauss(chisq,temp));
  }

getWeight() [2/2]

double Trk::DetAnnealingMaker::getWeight ( const AnnealingState & state, double chisq, const std::vector< double > & allchisq ) const

overridevirtual

Weight access method.

Definition at line 60 of file DetAnnealingMaker.cxx.

  {
    double temp = actualTemp (state);
    double allweight(0.);
    for (double ch : allchisq) {
      allweight+=gauss(ch,temp);
    }
    double actualweight(gauss(chisq,temp));
    return actualweight/(gauss(m_cutoff,temp)+allweight);
  }

initialize()

StatusCode Trk::DetAnnealingMaker::initialize ( )

overridevirtual

Definition at line 31 of file DetAnnealingMaker.cxx.

  { 
    ATH_MSG_DEBUG( "Initialize successful"  );
    return StatusCode::SUCCESS;
  }

isEquilibrium()

virtual bool Trk::DetAnnealingMaker::isEquilibrium ( const AnnealingState & state ) const

inlineoverridevirtual

Equilibrium is reached (last scheduled temperature)

Definition at line 59 of file DetAnnealingMaker.h.

    {
      return state >= m_SetOfTemperatures.size();
    }

reset()

void Trk::DetAnnealingMaker::reset ( AnnealingState & state ) const

overridevirtual

Resets the annealing process to its beginning.

Definition at line 43 of file DetAnnealingMaker.cxx.

  {
    state = 0;
    ATH_MSG_DEBUG( "Annealing reset"  );
  }

Member Data Documentation

m_cutoff

double Trk::DetAnnealingMaker::m_cutoff

private

Weight will be insensitive to chi2 at order of magnitude of the cutoff...

Definition at line 85 of file DetAnnealingMaker.h.

m_SetOfTemperatures

std::vector<double> Trk::DetAnnealingMaker::m_SetOfTemperatures

private

A vector of temperatures, you will start from SetOfTemperature[0] and Anneal towards SetOfTemperature[last].

Definition at line 80 of file DetAnnealingMaker.h.

---

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

• DetAnnealingMaker.h
• DetAnnealingMaker.cxx