bio::Watershed< T, L > Class Template Reference

Interface to watershed implementations. More...

#include <bioprocessing/watershed/watershed.h>

Collaboration diagram for bio::Watershed< T, L >:

Public Member Functions
	Watershed ()
	Default constructor The default implementation used is Cousty.
	Watershed (const std::string &implem)
	Constructor from implementation Possible implementations are:
void	setImplementation (const std::string &implem)
	Sets the watershed method Possible implementations are:
void	setVerbose (int verbose=1)
	Sets the verbosity level.
void	setQuiet ()
	Equivalent to setVerbose(0)
carto::VolumeRef< L >	execute (carto::VolumeRef< T > in)
	Executes the chosen watershed segmentation to the input volume.
carto::VolumeRef< L >	getMinima ()

Protected Attributes
std::string	_implem
int	_verbose
carto::VolumeRef< L >	_watershed
carto::VolumeRef< L >	_minima

Detailed Description

template<typename T, typename L>
class bio::Watershed< T, L >

Interface to watershed implementations.

This class is an interface to the different watershed implementations. The default one (and only one as of 2014-12-16) is CoustyWatershed.

See also

CoustyWatershed

Definition at line 32 of file watershed.h.

Constructor & Destructor Documentation

Watershed() [1/2]

template<typename T, typename L>

bio::Watershed< T, L >::Watershed ( )

inline

Default constructor The default implementation used is Cousty.

Definition at line 37 of file watershed.h.

References _implem, and _verbose.

Watershed() [2/2]

template<typename T, typename L>

bio::Watershed< T, L >::Watershed ( const std::string & implem )

inline

Constructor from implementation Possible implementations are:

• "cousty"

Definition at line 45 of file watershed.h.

References _implem, and _verbose.

Member Function Documentation

execute()

template<typename T, typename L>

carto::VolumeRef< L > bio::Watershed< T, L >::execute ( carto::VolumeRef< T > in )

inline

Executes the chosen watershed segmentation to the input volume.

A volume is allocated and returned. 2D and 3D modes are managed.

Definition at line 63 of file watershed.h.

References _implem, _minima, _verbose, _watershed, bio::CoustyWatershed< T, L >::execute(), bio::CoustyWatershed< T, L >::getMinima(), bio::CoustyWatershed< T, L >::set2D(), and bio::CoustyWatershed< T, L >::setVerbose().

getMinima()

template<typename T, typename L>

carto::VolumeRef< L > bio::Watershed< T, L >::getMinima ( )

inline

Definition at line 82 of file watershed.h.

References _minima.

setImplementation()

template<typename T, typename L>

void bio::Watershed< T, L >::setImplementation ( const std::string & implem )

inline

Sets the watershed method Possible implementations are:

• "cousty"

Definition at line 53 of file watershed.h.

References _implem.

setQuiet()

template<typename T, typename L>

void bio::Watershed< T, L >::setQuiet ( )

inline

Equivalent to setVerbose(0)

Definition at line 58 of file watershed.h.

References setVerbose().

setVerbose()

template<typename T, typename L>

void bio::Watershed< T, L >::setVerbose ( int verbose = 1 )

inline

Sets the verbosity level.

At construction, it is defaulted at carto::verbose

Definition at line 56 of file watershed.h.

References _verbose.

Referenced by setQuiet().

Member Data Documentation

_implem

template<typename T, typename L>

std::string bio::Watershed< T, L >::_implem

protected

Definition at line 88 of file watershed.h.

Referenced by execute(), setImplementation(), Watershed(), and Watershed().

_minima

template<typename T, typename L>

carto::VolumeRef<L> bio::Watershed< T, L >::_minima

protected

Definition at line 91 of file watershed.h.

Referenced by execute(), and getMinima().

_verbose

template<typename T, typename L>

int bio::Watershed< T, L >::_verbose

protected

Definition at line 89 of file watershed.h.

Referenced by execute(), setVerbose(), Watershed(), and Watershed().

_watershed

template<typename T, typename L>

carto::VolumeRef<L> bio::Watershed< T, L >::_watershed

protected

Definition at line 90 of file watershed.h.

Referenced by execute().

---

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

• bioprocessing/watershed/watershed.h