Robust Local Optical Flow Libary Documentation  V 1.2
 All Classes Files Functions Variables Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes | Protected Attributes | List of all members
CRobustFlowParameter Class Reference

RLOF parameter class The Robust Local Optical Flow parameter class contains additional parameters used for the RLOF method and its derivatives, see Senst et al. 2012. The parameter class is associated to RLOF, BERLOF, CROSS_RLOF, CROSS_BERLOF. More...

#include <D:/workspace/FIONA/Arbeit_Senst/publicProjects/RLOF_Windows/include/OpticalFlow/RLOFParameter.h>

Inheritance diagram for CRobustFlowParameter:
CLocalFlowParameter FeatureTrackerContext CCrossRobustFlowParameter

Public Member Functions

 CRobustFlowParameter ()
 
void largeWinSize (const int &val)
 
void smallWinSize (const int &val)
 
void norm (const std::vector< float > val)
 
void L2iteration (int val)
 
const int largeWinSize () const
 
const int smallWinSize () const
 
const std::vector< float > norm () const
 
const int L2iteration () const
 
const bool hasChangedWinSize () const
 
bool needRGBData () const
 
- Public Member Functions inherited from CLocalFlowParameter
void solverType (SolverType val)
 
void level (int val)
 
void iteration (int val)
 
void verbosity (int val)
 
WindowType windowType () const
 
CLocalFlowParameter::SolverType solverType () const
 
const int level () const
 
const int iteration () const
 
const int verbosity () const
 

Public Attributes

float m_BetaGradient
 

Protected Attributes

int m_SmallWinSize
 
std::vector< float > m_ParamNorm
 
std::vector< float > m_Param
 
float m_SSDThreshold
 
int m_NoL2Iteration
 
bool m_WinSizeHasChanged
 
- Protected Attributes inherited from CLocalFlowParameter
WindowType m_WindowType
 
SolverType m_SolverType
 
int m_MaxLevel
 
int m_MaxIter
 
int m_WinSize
 
int m_Verbosity
 
int m_Flags
 

Additional Inherited Members

- Public Types inherited from CLocalFlowParameter
enum  WindowType { WIN_STANDART = 0, WIN_CROSSADAPTIVE = 2, WIN_SLIC = 4 }
 
enum  SolverType { ITER_STANDART = 0, ITER_BE = 2 }
 
enum  IlluminationModelType { ILL_NO_MODEL = 0, ILL_GAIN_MODEL = 2, ILL_CONST_MODEL = 4, ILL_TEST_MODEL = 8 }
 

Detailed Description

RLOF parameter class The Robust Local Optical Flow parameter class contains additional parameters used for the RLOF method and its derivatives, see Senst et al. 2012. The parameter class is associated to RLOF, BERLOF, CROSS_RLOF, CROSS_BERLOF.

Definition at line 264 of file RLOFParameter.h.

Constructor & Destructor Documentation

CRobustFlowParameter::CRobustFlowParameter ( )

Default constructor with the default parameters

Member Function Documentation

const bool CRobustFlowParameter::hasChangedWinSize ( ) const

Function is used intern to reallocate memory and has no algorithmic meaning,

Returns
True if region size was changed.
void CRobustFlowParameter::L2iteration ( int  val)

Set the number of iterations with L2 norm. Maximal iterations = MAX(maximal iterations, L2 iterations.

Parameters
valnumber of iterations with the L2 estimator before using the mod. L2 estimator.
const int CRobustFlowParameter::L2iteration ( ) const

Interface to retrieve the number of L2 iterations.

Returns
Number of L2 iterations.
void CRobustFlowParameter::largeWinSize ( const int &  val)

Set the upper bound of the support region size.

Parameters
valpositive number.
const int CRobustFlowParameter::largeWinSize ( ) const

Interface to retrieve the upper bound of the support region.

Returns
Maximal support regions size.
bool CRobustFlowParameter::needRGBData ( ) const

Function returns if due to the window setting rgb data is needed and uses. Mostly for internal use.

Returns
True if rgb input data is needed.
void CRobustFlowParameter::norm ( const std::vector< float >  val)

Set the shrinked Hample norm parameter.

Parameters
valvector [σ1 σ2] of positive floating point values.
const std::vector<float> CRobustFlowParameter::norm ( ) const

Interface to retrieve the shrinked Hampel norm parameter vector.

Returns
Hamples norm parameter.
void CRobustFlowParameter::smallWinSize ( const int &  val)

Set the lower bound of the support region size.

Parameters
valpositive number <= largeWinSize
const int CRobustFlowParameter::smallWinSize ( ) const

Interface to retrieve the upper lower of the support region.

Returns
Minimal support regions size.

Member Data Documentation

float CRobustFlowParameter::m_BetaGradient

Internal usage.

Definition at line 323 of file RLOFParameter.h.

int CRobustFlowParameter::m_NoL2Iteration
protected

A positive number specifying the number of iterations done with a L2 norm for the iterative refinement.

Definition at line 319 of file RLOFParameter.h.

std::vector<float> CRobustFlowParameter::m_Param
protected

A vector specifying additional program parameter.

Definition at line 317 of file RLOFParameter.h.

std::vector<float> CRobustFlowParameter::m_ParamNorm
protected

A vector specifying the shrinked Hampel norm parameter σ1 and σ2

Definition at line 316 of file RLOFParameter.h.

int CRobustFlowParameter::m_SmallWinSize
protected

A positive number specifying the lower bound of the support region.

Definition at line 315 of file RLOFParameter.h.

float CRobustFlowParameter::m_SSDThreshold
protected

Obsolete.

Definition at line 318 of file RLOFParameter.h.

bool CRobustFlowParameter::m_WinSizeHasChanged
protected

Internal usage.

Definition at line 320 of file RLOFParameter.h.


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