Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
WrinkledMapAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <wrinkled_map_alg.h>

List of all members.

Public Types

typedef
iri_wrinkled_map::WrinkledMapConfig 
Config
 define config type

Public Member Functions

void compute_entropy_wrinkled_map (const normal_descriptor_node::ndesc_pc &ndesc_pc_msg, pcl::PointCloud< pcl::PointXYZRGB > &hmap)
void config_update (Config &new_cfg, uint32_t level=0)
 config update
void lock (void)
 Lock Algorithm.
bool try_enter (void)
 Tries Access to Algorithm.
void unlock (void)
 Unlock Algorithm.
 WrinkledMapAlgorithm (void)
 constructor
 ~WrinkledMapAlgorithm (void)
 Destructor.

Public Attributes

Config config_
 config variable
bool publish_wrinkled_map_

Protected Member Functions

float compute_entropy (const normal_descriptor_node::ndesc &nd)
 compute histogram entropy

Protected Attributes

CMutex alg_mutex_
 define config type
float min_entropy_

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 61 of file wrinkled_map_alg.h.


Member Typedef Documentation

typedef iri_wrinkled_map::WrinkledMapConfig WrinkledMapAlgorithm::Config

define config type

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

Definition at line 120 of file wrinkled_map_alg.h.


Constructor & Destructor Documentation

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 74 of file wrinkled_map_alg.cpp.

Destructor.

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

Definition at line 79 of file wrinkled_map_alg.cpp.


Member Function Documentation

float WrinkledMapAlgorithm::compute_entropy ( const normal_descriptor_node::ndesc nd) [inline, protected]

compute histogram entropy

Computes the entropy of a histogram (descripor)

Definition at line 84 of file wrinkled_map_alg.h.

void WrinkledMapAlgorithm::compute_entropy_wrinkled_map ( const normal_descriptor_node::ndesc_pc ndesc_pc_msg,
pcl::PointCloud< pcl::PointXYZRGB > &  hmap 
)

Definition at line 95 of file wrinkled_map_alg.cpp.

void WrinkledMapAlgorithm::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_cfgthe new driver configuration state
levellevel in which the update is taken place

Definition at line 83 of file wrinkled_map_alg.cpp.

void WrinkledMapAlgorithm::lock ( void  ) [inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 145 of file wrinkled_map_alg.h.

Tries Access to Algorithm.

Tries access to Algorithm

Returns:
true if the lock was adquired, false otherwise

Definition at line 161 of file wrinkled_map_alg.h.

void WrinkledMapAlgorithm::unlock ( void  ) [inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 152 of file wrinkled_map_alg.h.


Member Data Documentation

define config type

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

Definition at line 70 of file wrinkled_map_alg.h.

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 128 of file wrinkled_map_alg.h.

Definition at line 74 of file wrinkled_map_alg.h.

Definition at line 112 of file wrinkled_map_alg.h.


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


iri_wrinkled_map
Author(s): Arnau Ramisa
autogenerated on Fri Dec 6 2013 20:20:47