ESyS-Particle  2.3.4
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
esys::lsm::SphereFitter< TmplFitTraits > Class Template Referenceabstract

#include <SphereFitter.h>

Inheritance diagram for esys::lsm::SphereFitter< TmplFitTraits >:
Inheritance graph
[legend]
Collaboration diagram for esys::lsm::SphereFitter< TmplFitTraits >:
Collaboration graph
[legend]

Public Types

typedef TmplFitTraits FitTraits
 
typedef FitTraits::Validator Validator
 
typedef FitTraits::Particle Particle
 
typedef Validator::ParticleVector ParticleVector
 
typedef FitTraits::Plane3D Plane3D
 

Public Member Functions

 SphereFitter (const std::string &name, Validator &validator)
 
virtual ~SphereFitter ()
 
virtual Particle getFitParticle (const Particle &particle, const ParticleVector &neighbours, const Plane3D &plane)=0
 
void incrGetFit ()
 
void incrFailedFit ()
 
void incrSuccessfulFit ()
 
const std::string & getName () const
 
void write (std::ostream &oStream) const
 
std::string toString () const
 
bool particleIsValid (const Particle &particle) const
 

Static Public Member Functions

static Particle getInvalidParticle ()
 

Protected Member Functions

Validator & getValidator ()
 
const Validator & getValidator () const
 

Private Attributes

Validator * m_pValidator
 
int m_successfulFitCount
 
int m_getFitCount
 
int m_failedFitCount
 
std::string m_name
 

Member Typedef Documentation

◆ FitTraits

template<typename TmplFitTraits >
typedef TmplFitTraits esys::lsm::SphereFitter< TmplFitTraits >::FitTraits

◆ Particle

template<typename TmplFitTraits >
typedef FitTraits::Particle esys::lsm::SphereFitter< TmplFitTraits >::Particle

◆ ParticleVector

template<typename TmplFitTraits >
typedef Validator::ParticleVector esys::lsm::SphereFitter< TmplFitTraits >::ParticleVector

◆ Plane3D

template<typename TmplFitTraits >
typedef FitTraits::Plane3D esys::lsm::SphereFitter< TmplFitTraits >::Plane3D

◆ Validator

template<typename TmplFitTraits >
typedef FitTraits::Validator esys::lsm::SphereFitter< TmplFitTraits >::Validator

Constructor & Destructor Documentation

◆ SphereFitter()

template<typename TmplFitTraits >
esys::lsm::SphereFitter< TmplFitTraits >::SphereFitter ( const std::string &  name,
Validator &  validator 
)
inline

◆ ~SphereFitter()

template<typename TmplFitTraits >
virtual esys::lsm::SphereFitter< TmplFitTraits >::~SphereFitter ( )
inlinevirtual

Member Function Documentation

◆ getFitParticle()

template<typename TmplFitTraits >
virtual Particle esys::lsm::SphereFitter< TmplFitTraits >::getFitParticle ( const Particle &  particle,
const ParticleVector &  neighbours,
const Plane3D &  plane 
)
pure virtual

Implemented in esys::lsm::ThreeDPlaneSphereFitter< TmplFitTraits >, esys::lsm::TwoDPlaneSphereFitter< TmplFitTraits >, esys::lsm::ThreeDSphereSphereFitter< TmplFitTraits >, esys::lsm::TwoDSphereSphereFitter< TmplFitTraits >, esys::lsm::TwoDSphereFitter< TmplFitTraits >, and esys::lsm::ThreeDSphereFitter< TmplFitTraits >.

◆ getInvalidParticle()

template<typename TmplFitTraits >
static Particle esys::lsm::SphereFitter< TmplFitTraits >::getInvalidParticle ( )
inlinestatic

Referenced by esys::lsm::TwoDPlaneSphereFitter< TmplFitTraits >::findAFit(), esys::lsm::ThreeDPlaneSphereFitter< TmplFitTraits >::findAFit(), esys::lsm::ThreeDSphereFitter< TmplFitTraits >::findAFit(), esys::lsm::TwoDSphereFitter< TmplFitTraits >::findAFit(), esys::lsm::TwoDSphereSphereFitter< TmplFitTraits >::findAFit(), esys::lsm::ThreeDSphereSphereFitter< TmplFitTraits >::findAFit(), esys::lsm::ThreeDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::ThreeDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDPlaneSphereFitter< TmplFitTraits >::getFitParticle(), and esys::lsm::ThreeDPlaneSphereFitter< TmplFitTraits >::getFitParticle().

Here is the caller graph for this function:

◆ getName()

template<typename TmplFitTraits >
const std::string& esys::lsm::SphereFitter< TmplFitTraits >::getName ( ) const
inline

References esys::lsm::SphereFitter< TmplFitTraits >::m_name.

Referenced by esys::lsm::SphereFitter< TmplFitTraits >::write().

Here is the caller graph for this function:

◆ getValidator() [1/2]

template<typename TmplFitTraits >
Validator& esys::lsm::SphereFitter< TmplFitTraits >::getValidator ( )
inlineprotected

References esys::lsm::SphereFitter< TmplFitTraits >::m_pValidator.

Referenced by esys::lsm::SphereFitter< TmplFitTraits >::particleIsValid().

Here is the caller graph for this function:

◆ getValidator() [2/2]

template<typename TmplFitTraits >
const Validator& esys::lsm::SphereFitter< TmplFitTraits >::getValidator ( ) const
inlineprotected

References esys::lsm::SphereFitter< TmplFitTraits >::m_pValidator.

◆ incrFailedFit()

template<typename TmplFitTraits >
void esys::lsm::SphereFitter< TmplFitTraits >::incrFailedFit ( )
inline

References esys::lsm::SphereFitter< TmplFitTraits >::m_failedFitCount.

Referenced by esys::lsm::ThreeDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::ThreeDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDPlaneSphereFitter< TmplFitTraits >::getFitParticle(), and esys::lsm::ThreeDPlaneSphereFitter< TmplFitTraits >::getFitParticle().

Here is the caller graph for this function:

◆ incrGetFit()

template<typename TmplFitTraits >
void esys::lsm::SphereFitter< TmplFitTraits >::incrGetFit ( )
inline

References esys::lsm::SphereFitter< TmplFitTraits >::m_getFitCount.

Referenced by esys::lsm::ThreeDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::ThreeDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDPlaneSphereFitter< TmplFitTraits >::getFitParticle(), and esys::lsm::ThreeDPlaneSphereFitter< TmplFitTraits >::getFitParticle().

Here is the caller graph for this function:

◆ incrSuccessfulFit()

template<typename TmplFitTraits >
void esys::lsm::SphereFitter< TmplFitTraits >::incrSuccessfulFit ( )
inline

References esys::lsm::SphereFitter< TmplFitTraits >::m_successfulFitCount.

Referenced by esys::lsm::ThreeDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::ThreeDSphereSphereFitter< TmplFitTraits >::getFitParticle(), esys::lsm::TwoDPlaneSphereFitter< TmplFitTraits >::getFitParticle(), and esys::lsm::ThreeDPlaneSphereFitter< TmplFitTraits >::getFitParticle().

Here is the caller graph for this function:

◆ particleIsValid()

template<typename TmplFitTraits >
bool esys::lsm::SphereFitter< TmplFitTraits >::particleIsValid ( const Particle &  particle) const
inline

References esys::lsm::SphereFitter< TmplFitTraits >::getValidator().

Here is the call graph for this function:

◆ toString()

template<typename TmplFitTraits >
std::string esys::lsm::SphereFitter< TmplFitTraits >::toString ( ) const
inline

References esys::lsm::SphereFitter< TmplFitTraits >::write().

Here is the call graph for this function:

◆ write()

template<typename TmplFitTraits >
void esys::lsm::SphereFitter< TmplFitTraits >::write ( std::ostream &  oStream) const
inline

References esys::lsm::SphereFitter< TmplFitTraits >::getName(), esys::lsm::SphereFitter< TmplFitTraits >::m_failedFitCount, esys::lsm::SphereFitter< TmplFitTraits >::m_getFitCount, and esys::lsm::SphereFitter< TmplFitTraits >::m_successfulFitCount.

Referenced by esys::lsm::operator<<(), and esys::lsm::SphereFitter< TmplFitTraits >::toString().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_failedFitCount

template<typename TmplFitTraits >
int esys::lsm::SphereFitter< TmplFitTraits >::m_failedFitCount
private

Referenced by esys::lsm::SphereFitter< TmplFitTraits >::incrFailedFit(), and esys::lsm::SphereFitter< TmplFitTraits >::write().

◆ m_getFitCount

template<typename TmplFitTraits >
int esys::lsm::SphereFitter< TmplFitTraits >::m_getFitCount
private

Referenced by esys::lsm::SphereFitter< TmplFitTraits >::incrGetFit(), and esys::lsm::SphereFitter< TmplFitTraits >::write().

◆ m_name

template<typename TmplFitTraits >
std::string esys::lsm::SphereFitter< TmplFitTraits >::m_name
private

Referenced by esys::lsm::SphereFitter< TmplFitTraits >::getName().

◆ m_pValidator

template<typename TmplFitTraits >
Validator* esys::lsm::SphereFitter< TmplFitTraits >::m_pValidator
private

Referenced by esys::lsm::SphereFitter< TmplFitTraits >::getValidator().

◆ m_successfulFitCount

template<typename TmplFitTraits >
int esys::lsm::SphereFitter< TmplFitTraits >::m_successfulFitCount
private

Referenced by esys::lsm::SphereFitter< TmplFitTraits >::incrSuccessfulFit(), and esys::lsm::SphereFitter< TmplFitTraits >::write().

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