Bial::KernelIterator Class Reference

#include <KernelIterator.hpp>

Collaboration diagram for Bial::KernelIterator:

Public Member Functions
	KernelIterator (const Kernel &krn, const Vector< size_t > &dim, size_t index)
	Basic Constructor. More...
template<class D >
	KernelIterator (const Kernel &krn, const Matrix< D > &mat, size_t index)
	Basic Constructor. More...
template<class D >
	KernelIterator (const Kernel &krn, const Image< D > &img, size_t index)
	Basic Constructor. More...
KernelIterator &	operator++ ()
	Sets position to the next valid element or to space size if finished. More...
KernelIterator	operator++ (int)
	Sets position to the next valid element or to space size if finished. More...
bool	operator== (const KernelIterator &cmp) const
	Checks if this position is the same as cmp position. More...
bool	operator!= (const KernelIterator &cmp) const
	Checks if this position is different of cmp position. More...
size_t	operator* () const
	Returns a ponter to current element. More...
float	Value () const
	Returns the coefficient of current element. More...

Friends
class	Kernel

Detailed Description

Definition at line 23 of file KernelIterator.hpp.

Constructor & Destructor Documentation

Bial::KernelIterator::KernelIterator	(	const Kernel &	krn,
		const Vector< size_t > &	dim,
		size_t	index
	)

Basic Constructor.

Date

2013/Nov/19

Parameters

krn	A kernel.
dim	Matrix or image dimensions.
index	Index of reference pixel in the kernel.

Returns

none.

Warning

none.

template<class D >

Bial::KernelIterator::KernelIterator	(	const Kernel &	krn,
		const Matrix< D > &	mat,
		size_t	index
	)

Basic Constructor.

Date

2013/Nov/19

Parameters

krn	A kernel.
mat	A matrix.
index	Index of reference pixel in the kernel.

Returns

none.

Warning

none.

template<class D >

Bial::KernelIterator::KernelIterator	(	const Kernel &	krn,
		const Image< D > &	img,
		size_t	index
	)

Basic Constructor.

Date

2014/Apr/18

Parameters

krn	A kernel.
img	An image.
index	Index of reference pixel in the kernel.

Returns

none.

Warning

none.

Member Function Documentation

bool Bial::KernelIterator::operator!=

(

const KernelIterator &

cmp

)

const

Checks if this position is different of cmp position.

Date

2013/Nov/19

Parameters

cmp	iterator to which this iterator is compared.

Returns

True, if this position is different of cmp position.

Warning

none.

size_t Bial::KernelIterator::operator*

(

)

const

Returns a ponter to current element.

Date

2013/Nov/19

Parameters

none.

Returns

Ponter to current element.

Warning

Does not verify if corrent element is valid.

KernelIterator& Bial::KernelIterator::operator++

(

)

Sets position to the next valid element or to space size if finished.

Date

2013/Nov/19

Parameters

none.

Returns

Reference to this.

Warning

none.

KernelIterator Bial::KernelIterator::operator++

(

int

)

Sets position to the next valid element or to space size if finished.

Date

2013/Nov/19

Parameters

none.

Returns

Copy to this, moved to next valid element.

Warning

none.

bool Bial::KernelIterator::operator==

(

const KernelIterator &

cmp

)

const

Checks if this position is the same as cmp position.

Date

2013/Nov/19

Parameters

cmp	iterator to which this iterator is compared.

Returns

True, if this position is the same as cmp position.

Warning

none.

float Bial::KernelIterator::Value

(

)

const

Returns the coefficient of current element.

Date

2013/Nov/19

Parameters

none.

Returns

Coefficient of current element.

Warning

Does not verify if corrent element is valid.

Friends And Related Function Documentation

friend class Kernel

friend

Definition at line 147 of file KernelIterator.hpp.

---

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

• bial/inc/KernelIterator.hpp