LeafSegmentationAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <leaf_segmentation_alg.h>

List of all members.

Public Types
typedef iri_leaf_segmentation::LeafSegmentationConfig	Config
	define config type
Public Member Functions
void	config_update (Config &new_cfg, uint32_t level=0)
	config update
float	get_k ()
int	get_min_size ()
float	get_sigma ()
	LeafSegmentationAlgorithm (void)
	constructor
void	lock (void)
	Lock Algorithm.
void	set_k (float new_k)
void	set_min_size (int new_min_size)
void	set_sigma (float new_sigma)
bool	try_enter (void)
	Tries Access to Algorithm.
void	unlock (void)
	Unlock Algorithm.
	~LeafSegmentationAlgorithm (void)
	Destructor.
Public Attributes
Config	config_
	config variable
Protected Attributes
CMutex	alg_mutex_
	define config type
float	k_
size_t	min_size_
float	sigma_

---

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 38 of file leaf_segmentation_alg.h.

---

Member Typedef Documentation

typedef iri_leaf_segmentation::LeafSegmentationConfig LeafSegmentationAlgorithm::Config

define config type

Define a Config type with the LeafSegmentationConfig. All driver implementations will then use the same variable type Config.

Definition at line 61 of file leaf_segmentation_alg.h.

---

Constructor & Destructor Documentation

LeafSegmentationAlgorithm::LeafSegmentationAlgorithm

(

void

)

constructor

In this constructor parameters related to the specific driver can be initalized. Those parameters can be also set in the openDriver() function. Attributes from the main node driver class IriBaseDriver such as loop_rate, may be also overload here.

Definition at line 3 of file leaf_segmentation_alg.cpp.

LeafSegmentationAlgorithm::~LeafSegmentationAlgorithm

(

void

)

Destructor.

This destructor is called when the object is about to be destroyed.

Definition at line 8 of file leaf_segmentation_alg.cpp.

---

Member Function Documentation

void LeafSegmentationAlgorithm::config_update	(	Config &	new_cfg,
		uint32_t	level = 0
	)

config update

In this function the driver parameters must be updated with the input config variable. Then the new configuration state will be stored in the Config attribute.

Parameters:

new_cfg	the new driver configuration state
level	level in which the update is taken place

Definition at line 12 of file leaf_segmentation_alg.cpp.

float LeafSegmentationAlgorithm::get_k

(

)

Definition at line 48 of file leaf_segmentation_alg.cpp.

int LeafSegmentationAlgorithm::get_min_size

(

)

Definition at line 52 of file leaf_segmentation_alg.cpp.

float LeafSegmentationAlgorithm::get_sigma

(

)

Definition at line 44 of file leaf_segmentation_alg.cpp.

void LeafSegmentationAlgorithm::lock

(

void

)

[inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 86 of file leaf_segmentation_alg.h.

void LeafSegmentationAlgorithm::set_k

(

float

new_k

)

Definition at line 36 of file leaf_segmentation_alg.cpp.

void LeafSegmentationAlgorithm::set_min_size

(

int

new_min_size

)

Definition at line 40 of file leaf_segmentation_alg.cpp.

void LeafSegmentationAlgorithm::set_sigma

(

float

new_sigma

)

Definition at line 32 of file leaf_segmentation_alg.cpp.

bool LeafSegmentationAlgorithm::try_enter

(

void

)

[inline]

Tries Access to Algorithm.

Tries access to Algorithm

Returns:

true if the lock was adquired, false otherwise

Definition at line 102 of file leaf_segmentation_alg.h.

void LeafSegmentationAlgorithm::unlock

(

void

)

[inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 93 of file leaf_segmentation_alg.h.

---

Member Data Documentation

CMutex LeafSegmentationAlgorithm::alg_mutex_ [protected]

define config type

Define a Config type with the LeafSegmentationConfig. All driver implementations will then use the same variable type Config.

Definition at line 47 of file leaf_segmentation_alg.h.

Config LeafSegmentationAlgorithm::config_

config variable

This variable has all the driver parameters defined in the cfg config file. Is updated everytime function config_update() is called.

Definition at line 69 of file leaf_segmentation_alg.h.

float LeafSegmentationAlgorithm::k_ [protected]

Definition at line 51 of file leaf_segmentation_alg.h.

size_t LeafSegmentationAlgorithm::min_size_ [protected]

Definition at line 52 of file leaf_segmentation_alg.h.

float LeafSegmentationAlgorithm::sigma_ [protected]

Definition at line 50 of file leaf_segmentation_alg.h.

---

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

• leaf_segmentation_alg.h
• leaf_segmentation_alg.cpp