YaDICs  V04.14.a
Yet another Digital Image Correlation software: platform dedicated to 2/3D Fluid and Solid kinematics field measurements.
 All Classes Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
Cpeak< T > Class Template Referenceabstract

This class localizes the most important peak within an image, removes it and provide peak statistics. The mother class is abstract. Through its derivated classes, peak detection could be done using different methods (max, fitting, interpolation). The accuracy of each peak is estimated from its deviation from a parabolic or gaussian signal. The peak is removed from the input image for further second, third ... peak detection. More...

#include <Cpeak.h>

Inheritance diagram for Cpeak< T >:
Cpeak_max< T > Cpeak_subPix< T > Cpeak_subPix< T, Timg > Cpeak_barycenter< T > Cpeak_interp< T > Cpeak_interpBiLin< T > Cpeak_fit< T, Timg > Cpeak_fit< T > Cpeak_interpP< T > Cpeak_fitP< T > Cpeak_interpG< T > Cpeak_fitG< T >

Public Member Functions

 Cpeak ()
 
virtual void exec (CImg< T > &img)
 
virtual void peak_detection (CImg< T > &img)=0
 
void set_peakDim (CImg< T > &img)
 
virtual void peak_accuracy (CImg< T > &img)
 
virtual void peak_delete (CImg< T > &img)
 
void set_origin (CImg< T > &img)
 
std::vector< T > content ()
 

Public Attributes

std::string class_name
 
T m_flag
 
T m_mag
 
std::vector< T > m_pos
 
int _3D
 
bool m_verbose
 

Detailed Description

template<typename T>
class Cpeak< T >

This class localizes the most important peak within an image, removes it and provide peak statistics. The mother class is abstract. Through its derivated classes, peak detection could be done using different methods (max, fitting, interpolation). The accuracy of each peak is estimated from its deviation from a parabolic or gaussian signal. The peak is removed from the input image for further second, third ... peak detection.

Parameters
[in]typenameT : refer to output peak stats type
typenameT : refer to input CImg<T> image type
attributem_ : <T> m_x0, m_y0, m_mu, m_flag

Constructor & Destructor Documentation

template<typename T>
Cpeak< T >::Cpeak ( )
inline

Class Cpeak constructor. It initializes peak statistics, c.a.d. (m_x0, m_y0, m_mu, m_flag)

Member Function Documentation

template<typename T>
std::vector<T> Cpeak< T >::content ( )
inline

Allow accessing to attribute read only

template<typename T>
virtual void Cpeak< T >::peak_accuracy ( CImg< T > &  img)
inlinevirtual

accuracy: need to be improved

template<typename T>
virtual void Cpeak< T >::peak_delete ( CImg< T > &  img)
inlinevirtual

del : need to be improved

Class Cpeak method : del. It removes the highest image peak considering either an elliptic patch : $ (x_0, y_0, \sigma_x, \sigma_y)$ : $ \\ Patch(x,y) \rightarrow \left(\frac{x-x_0}{3\sigma_x}\right)^2+\left(\frac{y-y_0}{3\sigma_y}\right)^2 \le 1$ or the peak fitting equation

Todo:
[medium] set patch size from class member (e.g. set by autocorrelation for PIV)
The documentation for this class was generated from the following file:
Generated on Mon Mar 2 2015 18:32:04 for YaDICs by   doxygen 1.8.6