#include <SumPathFunction.hpp>

Inheritance diagram for Bial::SumPathFunction< C, D >:

Collaboration diagram for Bial::SumPathFunction< C, D >:

Public Member Functions
	SumPathFunction (const C< D > &handicap)
	Basic constructor. More...

	SumPathFunction (const SumPathFunction< C, D > &pf)
	Copy constructor. More...

	~SumPathFunction ()
	Destructor. More...

SumPathFunction< C, D >	operator= (const SumPathFunction< C, D > &pf)
	Assignment operator. More...

void	Initialize (C< D > &init_value, C< int > init_label, C< int > init_predecessor, bool sequential_label)
	Initializes object attributes. More...

bool	RemoveSimple (size_t index, BucketState state)
	Sets initial value for root pixel of index 'index'. More...

bool	RemoveLabel (size_t index, BucketState state)
	Sets initial value for root pixel of index 'index'. Also sets its label value. More...

bool	Capable (int index, int adj_index, BucketState adj_state)
	Checks if index can offer better value to adj_index, prior to computing it by Propagate function. This function makes IFT faster. More...

bool	Propagate (int index, int adj_index)
	Updates adjacent pixel values and returns true if path_function is propagated. More...

bool	Increasing ()
	Returns whether this path function uses increasing or decreasing values. More...

Public Member Functions inherited from Bial::PathFunction< C, D >
	PathFunction ()
	Basic constructor. More...

	PathFunction (const PathFunction< C, D > &pf)
	Copy constructor. More...

virtual	~PathFunction ()
	Virtual destructor required for virtual classes. More...

void	UpdateCompleteData (size_t index, size_t adj_index)
	Updates value, label, and predecessor images of index adj_index according to 'index' and value. One of these functions will be used depending on the chosen resultant images. More...

void	UpdatePredecessorData (size_t index, size_t adj_index)

void	UpdateLabelData (size_t index, size_t adj_index)

void	UpdateSimpleData (size_t index, size_t adj_index)

PathFunction< C, D >::RemoveFn	RemoveFunction ()
	Returns a root initialization function that will be used depending on used maps. More...

PathFunction< C, D >::UpdateFn	UpdateFunction ()
	Returns an update function that will be used depending on used maps. More...

Protected Attributes
C< D >	handicap
	Handicap container (Vector, Matrix, Image, etc). More...

Protected Attributes inherited from Bial::PathFunction< C, D >
C< D > *	value
	Pointer to value container (Vector, Matrix, Image, etc). More...

C< int > *	label
	Pointer to label container (Vector, Matrix, Image, etc). More...

C< int > *	predecessor
	Pointer to predecessor container (Vector, Matrix, Image, etc). More...

int	next_label

Additional Inherited Members
Public Types inherited from Bial::PathFunction< C, D >
typedef bool(PathFunction< C, D >::*	RemoveFn) (size_t index, BucketState state)
	Initialization functions of IFT. It will operate on valid maps among value, label, predecessor, and. More...

typedef void(PathFunction< C, D >::*	UpdateFn) (size_t index, size_t adj_index)
	Update functions of IFT. It will operate on valid maps among value, label, and predecessor. More...

Detailed Description

template<template< class D > class C, class D>
class Bial::SumPathFunction< C, D >

Definition at line 22 of file SumPathFunction.hpp.

Constructor & Destructor Documentation

template<template< class D > class C, class D>

Bial::SumPathFunction< C, D >::SumPathFunction ( const C< D > & handicap )

Basic constructor.

Date: 2015/Apr/14

Parameters

new_bucket_size size of bucke in queue.

Returns: none.

Warning: none.

template<template< class D > class C, class D>

Bial::SumPathFunction< C, D >::SumPathFunction ( const SumPathFunction< C, D > & pf )

Copy constructor.

Date: 2015/Apr/14

Parameters

pf	path-function to be copied.

Returns: none.

Warning: none.

template<template< class D > class C, class D>

Bial::SumPathFunction< C, D >::~SumPathFunction ( )

Destructor.

Date: 2015/Apr/14

Parameters

none.

Returns: none.

Warning: none.

Member Function Documentation

template<template< class D > class C, class D>

bool Bial::SumPathFunction< C, D >::Capable	(	int	index,
		int	adj_index,
		BucketState	adj_state
	)

virtual

Checks if index can offer better value to adj_index, prior to computing it by Propagate function. This function makes IFT faster.

Date: 2015/Apr/14

Parameters

source	Source pixel index.
target	Adjacent pixel index.

Returns: True if it is possible to propagate.

Warning: none.

Implements Bial::PathFunction< C, D >.

template<template< class D > class C, class D>

bool Bial::SumPathFunction< C, D >::Increasing ( )

virtual

Returns whether this path function uses increasing or decreasing values.

Date: 2015/Apr/14

Parameters

none.

Returns: True for increasing and false for decreasing values.

Warning: none.

Implements Bial::PathFunction< C, D >.

template<template< class D > class C, class D>

void Bial::SumPathFunction< C, D >::Initialize	(	C< D > &	init_value,
		C< int > *	init_label,
		C< int > *	init_predecessor,
		bool	sequential_label
	)

virtual

Initializes object attributes.

Date: 2015/Apr/14

Parameters

init_value	Reference for initial value container.
init_label	Reference for initial label container.
init_predecessor	Reference for predecessor container.
sequential_label	Sets labeling sequentially.

Returns: none.

Warning: This function is called automatically by IFT constructor.

Reimplemented from Bial::PathFunction< C, D >.

template<template< class D > class C, class D>

SumPathFunction< C, D > Bial::SumPathFunction< C, D >::operator= ( const SumPathFunction< C, D > & pf )

Assignment operator.

Date: 2015/Apr/14

Parameters

pf	path-function to be assigned.

Returns: none.

Warning: none.

template<template< class D > class C, class D>

bool Bial::SumPathFunction< C, D >::Propagate	(	int	index,
		int	adj_index
	)

virtual

Updates adjacent pixel values and returns true if path_function is propagated.

Date: 2015/Apr/14

Parameters

source	Source pixel index.
target	Adjacent pixel index.

Returns: True if path-value is propagated.

Warning: none.

Implements Bial::PathFunction< C, D >.

template<template< class D > class C, class D>

bool Bial::SumPathFunction< C, D >::RemoveLabel	(	size_t	index,
		BucketState	state
	)

virtual

Sets initial value for root pixel of index 'index'. Also sets its label value.

Date: 2015/Apr/14

Parameters

index The index of the pixel to be initalized.

Returns: Whether this node can propagate or not.

Warning: none.

Implements Bial::PathFunction< C, D >.

template<template< class D > class C, class D>

bool Bial::SumPathFunction< C, D >::RemoveSimple	(	size_t	index,
		BucketState	state
	)

virtual

Sets initial value for root pixel of index 'index'.

Date: 2015/Apr/14

Parameters

index The index of the pixel to be initalized.

Returns: Whether this node can propagate or not.

Warning: none.

Implements Bial::PathFunction< C, D >.

Member Data Documentation

template<template< class D > class C, class D>

C< D > Bial::SumPathFunction< C, D >::handicap

protected

Handicap container (Vector, Matrix, Image, etc).

Definition at line 29 of file SumPathFunction.hpp.

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

bial/inc/SumPathFunction.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<template< class D > class C, class D> class Bial::SumPathFunction< C, D >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<template< class D > class C, class D>
class Bial::SumPathFunction< C, D >