Public Member Functions | Private Types | Private Attributes | List of all members
grid_map::ColorBlendingFilter< T > Class Template Reference

#include <ColorBlendingFilter.hpp>

Inheritance diagram for grid_map::ColorBlendingFilter< T >:
Inheritance graph
[legend]

Public Member Functions

 ColorBlendingFilter ()
 
virtual bool configure ()
 
virtual bool update (const T &mapIn, T &mapOut)
 
virtual ~ColorBlendingFilter ()
 
- Public Member Functions inherited from filters::FilterBase< T >
bool configure (const std::string &param_name, ros::NodeHandle node_handle=ros::NodeHandle())
 
bool configure (XmlRpc::XmlRpcValue &config)
 
 FilterBase ()
 
const std::string & getName ()
 
std::string getType ()
 
virtual ~FilterBase ()
 

Private Types

enum  BlendModes { BlendModes::Normal, BlendModes::HardLight, BlendModes::SoftLight }
 

Private Attributes

std::string backgroundLayer_
 Input layers. More...
 
BlendModes blendMode_
 Blend mode. More...
 
std::string foregroundLayer_
 
double opacity_
 Opacity of foreground layer. More...
 
std::string outputLayer_
 Output layer name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from filters::FilterBase< T >
bool getParam (const std::string &name, std::string &value)
 
bool getParam (const std::string &name, XmlRpc::XmlRpcValue &value)
 
bool getParam (const std::string &name, double &value)
 
bool getParam (const std::string &name, std::vector< double > &value)
 
bool getParam (const std::string &name, unsigned int &value)
 
bool getParam (const std::string &name, int &value)
 
bool getParam (const std::string &name, std::vector< std::string > &value)
 
bool getParam (const std::string &name, bool &value)
 
bool loadConfiguration (XmlRpc::XmlRpcValue &config)
 
- Protected Attributes inherited from filters::FilterBase< T >
bool configured_
 
std::string filter_name_
 
std::string filter_type_
 
string_map_t params_
 

Detailed Description

template<typename T>
class grid_map::ColorBlendingFilter< T >

Blend two color layers.

Definition at line 22 of file ColorBlendingFilter.hpp.

Member Enumeration Documentation

template<typename T >
enum grid_map::ColorBlendingFilter::BlendModes
strongprivate
Enumerator
Normal 
HardLight 
SoftLight 

Definition at line 49 of file ColorBlendingFilter.hpp.

Constructor & Destructor Documentation

template<typename T >
grid_map::ColorBlendingFilter< T >::ColorBlendingFilter ( )

Constructor

Definition at line 22 of file ColorBlendingFilter.cpp.

template<typename T >
grid_map::ColorBlendingFilter< T >::~ColorBlendingFilter ( )
virtual

Destructor.

Definition at line 29 of file ColorBlendingFilter.cpp.

Member Function Documentation

template<typename T >
bool grid_map::ColorBlendingFilter< T >::configure ( )
virtual

Configures the filter.

Implements filters::FilterBase< T >.

Definition at line 34 of file ColorBlendingFilter.cpp.

template<typename T >
bool grid_map::ColorBlendingFilter< T >::update ( const T &  mapIn,
T &  mapOut 
)
virtual

Compute a new color layer based on blending two color layers.

Parameters
mapIngrid map containing the two color layers.
mapOutgrid map containing mapIn and the blended color layer.

Implements filters::FilterBase< T >.

Definition at line 76 of file ColorBlendingFilter.cpp.

Member Data Documentation

template<typename T >
std::string grid_map::ColorBlendingFilter< T >::backgroundLayer_
private

Input layers.

Definition at line 56 of file ColorBlendingFilter.hpp.

template<typename T >
BlendModes grid_map::ColorBlendingFilter< T >::blendMode_
private

Blend mode.

Definition at line 59 of file ColorBlendingFilter.hpp.

template<typename T >
std::string grid_map::ColorBlendingFilter< T >::foregroundLayer_
private

Definition at line 56 of file ColorBlendingFilter.hpp.

template<typename T >
double grid_map::ColorBlendingFilter< T >::opacity_
private

Opacity of foreground layer.

Definition at line 62 of file ColorBlendingFilter.hpp.

template<typename T >
std::string grid_map::ColorBlendingFilter< T >::outputLayer_
private

Output layer name.

Definition at line 65 of file ColorBlendingFilter.hpp.


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


grid_map_filters
Author(s): P├ęter Fankhauser , Martin Wermelinger
autogenerated on Fri Feb 19 2021 03:15:19