Base class for all feature vectors encapsulating statistics extracted from an image region. More...

#include <mdsFeatureVector.h>

Inheritance diagram for mds::img::CFeatureVector< T, Size >:

[legend]

Public Types
enum
	Templates that require members of the CStaticVector class can use this enum to check the existence. More...
enum
	The vector size. More...
enum	{ CLASS_FEATURE_VECTOR }
	Templates that require members of the CFeatureVector class may use this enum to check the existence. More...
typedef mds::math::CStaticVector< T, Size >	tBase
	Base class.
typedef T	tElement
	Vector element type.
typedef tVector::tElement	tFeature
	Type representing feature value.
typedef Eigen::Matrix < tElement, SIZE, 1, Eigen::ColMajor >	tStorage
	Underlying data (see the Eigen math library).
typedef mds::math::CStaticVector< T, Size >	tVector
	Feature vector.
Public Member Functions
CStaticVector &	abs ()
	Absolute value of all elements.
tStorage &	asEigen ()
	Returns reference to the underlying data (see the Eigen math library).
const tStorage &	asEigen () const
T &	at (tSize i)
	Returns reference to the element [i].
const T &	at (tSize i) const
	CFeatureVector (int State=FeatureVector::UNKNOWN)
	Default constructor.
	CFeatureVector (const CFeatureVector &Vector)
	Copy constructor.
bool	checkState (int State) const
	Checks the concrete state.
CStaticVector &	fill (const T &Value)
	Sets all elements of the vector to a given value.
Function	forEach (Function Func)
	Calls a function object for every vector element.
Function	forEach (Function Func) const
	Calls a function object for every vector element.
tFeature &	getFeature (tSize i)
	Returns value of a subscripted feature.
const tFeature &	getFeature (tSize i) const
tVector &	getImpl ()
	Returns reference to the vector implementation.
const tVector &	getImpl () const
tSize	getNumOfFeatures () const
	Returns size of the feature vector.
int	getNumOfSamples () const
	Returns the number of samples taken into account.
T *	getPtr ()
	Returns pointer to the vector data.
const T *	getPtr () const
T *	getPtr (tSize i)
	Returns pointer to a given element.
const T *	getPtr (tSize i) const
tSize	getSize () const
	Returns the vector size.
int	getState () const
	Returns the current internal state.
tSize	getStride () const
	Returns stride between two neigbouring vector elements.
CFeatureVector &	incNumOfSamples (int Value)
	Inceases the number of sampels.
bool	isValid () const
	Returns true if the feature vector is evaluated correctly.
CStaticVector &	mult (const CStaticMatrix< T, M, K > &Matrix, const CStaticVector< T, K > &Vector)
	Matrix vs.
CStaticVector &	mult (const CStaticVector< T, K > &Vector, const CStaticMatrix< T, K, M > &Matrix)
	Row vector vs.
CStaticVector &	multAdd (const CStaticVector &Vector, const T &Scalar)
	Provides operation this += Vector * Scalar.
CStaticVector &	ones ()
	The vector initialization method.
T &	operator() (tSize i)
	Returns reference to the subscripted element [i].
const T &	operator() (tSize i) const
CStaticVector &	operator*= (const CStaticVector &v)
	Element wise product.
CStaticVector &	operator*= (const CScalar< U > &c)
	Multiplies all elements by scalar.
CStaticVector &	operator+= (const CStaticVector &v)
	Element wise addition.
CStaticVector &	operator+= (const CScalar< U > &c)
	Adds scalar to all elements.
CStaticVector &	operator-= (const CStaticVector &v)
	Element wise subtraction.
CStaticVector &	operator-= (const CScalar< U > &c)
	Subtracts scalar from all elements.
CStaticVector &	operator/= (const CStaticVector &v)
	Element wise addition.
CStaticVector &	operator/= (const CScalar< U > &c)
	Divides all elements by scalar.
CFeatureVector &	operator= (const CFeatureVector &Vector)
	Assignement operator.
tVector &	set (tSize i, const tElement &Value)
	Sets the vector element at the position [i].
CStaticVector &	set (tSize i, const T &Value)
	Sets the vector element at the position [i].
CFeatureVector &	setFeature (tSize i, const tFeature &Value)
	Sets value of the i-th feature.
CFeatureVector &	setNumOfSamples (int Value)
	Sets the number of samples.
CFeatureVector &	setState (int State)
	Sets the internal state.
tSize	size () const
	Returns the vector size.
CStaticVector &	zeros ()
	The vector initialization method.
	~CFeatureVector ()
	Destructor.
Protected Attributes
int	m_NumOfSamples
	Total number of samples counted.
int	m_State
	Current internal state.
tStorage	m_Vector
	Underlying vector data (see the Eigen library).

Detailed Description

template<typename T, int Size>
class mds::img::CFeatureVector< T, Size >

Base class for all feature vectors encapsulating statistics extracted from an image region.

Member Typedef Documentation

template<typename T, int Size>

typedef mds::math::CStaticVector<T, Size> mds::img::CFeatureVector< T, Size >::tBase

Base class.

Reimplemented from mds::math::CStaticVector< T, Size >.

Reimplemented in mds::lbp::CNormLBPHistogram< N >, mds::lbp::CLBPHistogram< N >, mds::lbp::CLBPHistogram< Mapping< Type >::Size >, and mds::img::CPixelStats.

typedef T mds::math::CStaticVector< T, M >::tElement [inherited]

Vector element type.

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

template<typename T, int Size>

typedef tVector::tElement mds::img::CFeatureVector< T, Size >::tFeature

Type representing feature value.

Reimplemented in mds::lbp::CNormLBPHistogram< N >, mds::lbp::CLBPHistogram< N >, mds::lbp::CLBPHistogram< Mapping< Type >::Size >, and mds::img::CPixelStats.

typedef Eigen::Matrix<tElement, SIZE, 1, Eigen::ColMajor> mds::math::CStaticVector< T, M >::tStorage [inherited]

Underlying data (see the Eigen math library).

template<typename T, int Size>

typedef mds::math::CStaticVector<T, Size> mds::img::CFeatureVector< T, Size >::tVector

Feature vector.

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

Member Enumeration Documentation

anonymous enum [inherited]

Templates that require members of the CStaticVector class can use this enum to check the existence.

anonymous enum [inherited]

The vector size.

template<typename T, int Size>

anonymous enum

Templates that require members of the CFeatureVector class may use this enum to check the existence.

Enumerator:

CLASS_FEATURE_VECTOR

Constructor & Destructor Documentation

template<typename T, int Size>

mds::img::CFeatureVector< T, Size >::CFeatureVector ( int State = FeatureVector::UNKNOWN )

Default constructor.

template<typename T, int Size>

mds::img::CFeatureVector< T, Size >::CFeatureVector ( const CFeatureVector< T, Size > & Vector )

Copy constructor.

template<typename T, int Size>

mds::img::CFeatureVector< T, Size >::~CFeatureVector ( )

Destructor.

Member Function Documentation

CStaticVector& mds::math::CStaticVector< T, M >::abs ( ) [inherited]

Absolute value of all elements.

Returns reference to this.

tStorage& mds::math::CStaticVector< T, M >::asEigen ( ) [inherited]

Returns reference to the underlying data (see the Eigen math library).

const tStorage& mds::math::CStaticVector< T, M >::asEigen ( ) const [inherited]

T& mds::math::CStaticVector< T, M >::at ( tSize i ) [inherited]

Returns reference to the element [i].

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

const T& mds::math::CStaticVector< T, M >::at ( tSize i ) const [inherited]

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

template<typename T, int Size>

bool mds::img::CFeatureVector< T, Size >::checkState ( int State ) const

Checks the concrete state.

CStaticVector& mds::math::CStaticVector< T, M >::fill ( const T & Value ) [inherited]

Sets all elements of the vector to a given value.

Returns reference to this.

Function mds::math::CStaticVector< T, M >::forEach ( Function Func ) [inherited]

Calls a function object for every vector element.

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

Function mds::math::CStaticVector< T, M >::forEach ( Function Func ) const [inherited]

Calls a function object for every vector element.

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

template<typename T, int Size>

tFeature& mds::img::CFeatureVector< T, Size >::getFeature ( tSize i )

Returns value of a subscripted feature.

template<typename T, int Size>

const tFeature& mds::img::CFeatureVector< T, Size >::getFeature ( tSize i ) const

tVector& mds::math::CVectorBase< CStaticVector< T, M > >::getImpl ( ) [inherited]

Returns reference to the vector implementation.

const tVector& mds::math::CVectorBase< CStaticVector< T, M > >::getImpl ( ) const [inherited]

template<typename T, int Size>

tSize mds::img::CFeatureVector< T, Size >::getNumOfFeatures ( ) const

Returns size of the feature vector.

template<typename T, int Size>

int mds::img::CFeatureVector< T, Size >::getNumOfSamples ( ) const

Returns the number of samples taken into account.

T* mds::math::CStaticVector< T, M >::getPtr ( ) [inherited]

Returns pointer to the vector data.

const T* mds::math::CStaticVector< T, M >::getPtr ( ) const [inherited]

T* mds::math::CStaticVector< T, M >::getPtr ( tSize i ) [inherited]

Returns pointer to a given element.

const T* mds::math::CStaticVector< T, M >::getPtr ( tSize i ) const [inherited]

tSize mds::math::CStaticVector< T, M >::getSize ( ) const [inherited]

Returns the vector size.

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

template<typename T, int Size>

int mds::img::CFeatureVector< T, Size >::getState ( ) const

Returns the current internal state.

tSize mds::math::CStaticVector< T, M >::getStride ( ) const [inherited]

Returns stride between two neigbouring vector elements.

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

template<typename T, int Size>

CFeatureVector& mds::img::CFeatureVector< T, Size >::incNumOfSamples ( int Value )

Inceases the number of sampels.

template<typename T, int Size>

bool mds::img::CFeatureVector< T, Size >::isValid ( ) const

Returns true if the feature vector is evaluated correctly.

CStaticVector& mds::math::CStaticVector< T, M >::mult	(	const CStaticMatrix< T, M, K > &	Matrix,
		const CStaticVector< T, K > &	Vector
	)		`[inherited]`

Matrix vs.

column vector multiplication.

Returns reference to this.

CStaticVector& mds::math::CStaticVector< T, M >::mult	(	const CStaticVector< T, K > &	Vector,
		const CStaticMatrix< T, K, M > &	Matrix
	)		`[inherited]`

Row vector vs.

matrix multiplication.

Returns reference to this.

CStaticVector& mds::math::CStaticVector< T, M >::multAdd	(	const CStaticVector< T, Size > &	Vector,
		const T &	Scalar
	)		`[inherited]`

Provides operation this += Vector * Scalar.

Returns reference to this.

CStaticVector& mds::math::CStaticVector< T, M >::ones ( ) [inherited]

The vector initialization method.

Returns reference to this.

T& mds::math::CStaticVector< T, M >::operator() ( tSize i ) [inherited]

Returns reference to the subscripted element [i].

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

const T& mds::math::CStaticVector< T, M >::operator() ( tSize i ) const [inherited]

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

CStaticVector& mds::math::CStaticVector< T, M >::operator*= ( const CStaticVector< T, Size > & v ) [inherited]

Element wise product.

CStaticVector& mds::math::CStaticVector< T, M >::operator*= ( const CScalar< U > & c ) [inherited]

Multiplies all elements by scalar.

CStaticVector& mds::math::CStaticVector< T, M >::operator+= ( const CStaticVector< T, Size > & v ) [inherited]

Element wise addition.

CStaticVector& mds::math::CStaticVector< T, M >::operator+= ( const CScalar< U > & c ) [inherited]

Adds scalar to all elements.

CStaticVector& mds::math::CStaticVector< T, M >::operator-= ( const CStaticVector< T, Size > & v ) [inherited]

Element wise subtraction.

CStaticVector& mds::math::CStaticVector< T, M >::operator-= ( const CScalar< U > & c ) [inherited]

Subtracts scalar from all elements.

CStaticVector& mds::math::CStaticVector< T, M >::operator/= ( const CStaticVector< T, Size > & v ) [inherited]

Element wise addition.

CStaticVector& mds::math::CStaticVector< T, M >::operator/= ( const CScalar< U > & c ) [inherited]

Divides all elements by scalar.

template<typename T, int Size>

CFeatureVector& mds::img::CFeatureVector< T, Size >::operator= ( const CFeatureVector< T, Size > & Vector )

Assignement operator.

tVector& mds::math::CVectorBase< CStaticVector< T, M > >::set	(	tSize	i,
		const tElement &	Value
	)		`[inherited]`

Sets the vector element at the position [i].

CStaticVector& mds::math::CStaticVector< T, M >::set	(	tSize	i,
		const T &	Value
	)		`[inherited]`

Sets the vector element at the position [i].

template<typename T, int Size>

CFeatureVector& mds::img::CFeatureVector< T, Size >::setFeature	(	tSize	i,
		const tFeature &	Value
	)

Sets value of the i-th feature.

template<typename T, int Size>

CFeatureVector& mds::img::CFeatureVector< T, Size >::setNumOfSamples ( int Value )

Sets the number of samples.

template<typename T, int Size>

CFeatureVector& mds::img::CFeatureVector< T, Size >::setState ( int State )

Sets the internal state.

tSize mds::math::CStaticVector< T, M >::size ( ) const [inherited]

Returns the vector size.

Reimplemented from mds::math::CVectorBase< CStaticVector< T, M > >.

CStaticVector& mds::math::CStaticVector< T, M >::zeros ( ) [inherited]

The vector initialization method.

Returns reference to this.

Member Data Documentation

template<typename T, int Size>

int mds::img::CFeatureVector< T, Size >::m_NumOfSamples [protected]

Total number of samples counted.

template<typename T, int Size>

int mds::img::CFeatureVector< T, Size >::m_State [protected]

Current internal state.

tStorage mds::math::CStaticVector< T, M >::m_Vector [protected, inherited]

Underlying vector data (see the Eigen library).

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

mdsFeatureVector.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<typename T, int Size> class mds::img::CFeatureVector< T, Size >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T, int Size>
class mds::img::CFeatureVector< T, Size >