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

PLK/RLOF parameter base class The parameter base class provides basic interfaces to set up the algorithm parameter such as number of levels. The parameter class is associated to all methods. More...

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

Inheritance diagram for CLocalFlowParameter:
FeatureTrackerContext CPLKParameter CRobustFlowParameter CCrossPLKParameter CCrossRobustFlowParameter

Public Types

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 }
 

Public Member Functions

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
 

Protected Attributes

WindowType m_WindowType
 
SolverType m_SolverType
 
int m_MaxLevel
 
int m_MaxIter
 
int m_WinSize
 
int m_Verbosity
 
int m_Flags
 

Detailed Description

PLK/RLOF parameter base class The parameter base class provides basic interfaces to set up the algorithm parameter such as number of levels. The parameter class is associated to all methods.

Definition at line 134 of file RLOFParameter.h.

Member Enumeration Documentation

Enumeration will be not used.

Enumerator
ILL_NO_MODEL 

Use standard brightness constancy assumption.

ILL_GAIN_MODEL 

not used.

ILL_CONST_MODEL 

not used.

Definition at line 149 of file RLOFParameter.h.

Enumeration specifying the iterative refinement strategy.

Enumerator
ITER_STANDART 

Standard iterative solver.

ITER_BE 

Bilinear equation solver, described in Senst et al. 2013 .

Definition at line 144 of file RLOFParameter.h.

Enumeration specifying the support region construction.

Enumerator
WIN_STANDART 

Rectangle support region.

WIN_CROSSADAPTIVE 

Cross based adaptive support region, described in Senst et al. 2014 .

Definition at line 139 of file RLOFParameter.h.

Member Function Documentation

void CLocalFlowParameter::iteration ( int  val)
inline

Set the number of maximal iterations.

Parameters
valpositive number.

Definition at line 182 of file RLOFParameter.h.

const int CLocalFlowParameter::iteration ( ) const
inline

Interface to retrieve the number maximal iterations used for the iterative refinement.

Returns
Number of maximal iterations.

Definition at line 214 of file RLOFParameter.h.

void CLocalFlowParameter::level ( int  val)
inline

Set the number of used pyramid levels.

Parameters
valpositive number.

Definition at line 173 of file RLOFParameter.h.

const int CLocalFlowParameter::level ( ) const
inline

Interface to retrieve the number of Gaussian pyramid levels used.

Returns
Number of pyramid levels.

Definition at line 210 of file RLOFParameter.h.

void CLocalFlowParameter::solverType ( SolverType  val)
inline

Set/Unset the usage of different iterative solver strategies

Parameters
valTODO description

Definition at line 166 of file RLOFParameter.h.

Referenced by demo(), test0(), and test1().

CLocalFlowParameter::SolverType CLocalFlowParameter::solverType ( ) const
inline

Interface to retrieve the used solver.

  • ITER_STANDART denotes the standard iterative solver.
  • ITER_BE denotes the bilinear equation solver, see Senst et al. 2013.
    Returns
    enumeration SolverType

Definition at line 206 of file RLOFParameter.h.

void CLocalFlowParameter::verbosity ( int  val)
inline

set the verbosity level (debug output level) default 0

Parameters
valVerbosity level
  • 0 no output
  • >0 method specific output !

Definition at line 191 of file RLOFParameter.h.

const int CLocalFlowParameter::verbosity ( ) const
inline

Interface to retrieve the verbosity level. The verbosity or debug level of 0 denotes no output to the std::cout

Returns
the verbosity level (debug level)

Definition at line 219 of file RLOFParameter.h.

WindowType CLocalFlowParameter::windowType ( ) const
inline

Interface to retrieve the used support region shape.

  • WIN_STANDART denotes a rectangle support region or
  • WIN_CROSSADAPTIVE denotes the usage of a cross based adaptive support region, see Senst et al. 2014.
    Returns
    enumeration WindowType

Definition at line 200 of file RLOFParameter.h.

Member Data Documentation

int CLocalFlowParameter::m_Flags
protected

A positive number specifying additional program parameter.

Definition at line 228 of file RLOFParameter.h.

int CLocalFlowParameter::m_MaxIter
protected

A positive number specifying the maximal number of iteration used for the iterative refinement.

Definition at line 225 of file RLOFParameter.h.

int CLocalFlowParameter::m_MaxLevel
protected

A positive number specifying the number of levels used for the Gaussian pyramid.

Definition at line 224 of file RLOFParameter.h.

SolverType CLocalFlowParameter::m_SolverType
protected

Enumeration specifying iterative refinement strategy.

Definition at line 223 of file RLOFParameter.h.

int CLocalFlowParameter::m_Verbosity
protected

A positive number specifying the debug level.

Definition at line 227 of file RLOFParameter.h.

WindowType CLocalFlowParameter::m_WindowType
protected

Enumeration specifying support region construction.

Definition at line 219 of file RLOFParameter.h.

int CLocalFlowParameter::m_WinSize
protected

A positive number specifying the support region size.

Definition at line 226 of file RLOFParameter.h.

Referenced by CPLKParameter::winSize().


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