nav2_costmap_2d::imgproc_impl::out_of_bounds_policy::ReplaceToZero< T > Class Template Reference

Boundary case object. Used as parameter of class Window. Dereferences a pointer to a existing pixel. If the pixel is out of bounds, it returns a ref to 0. More...

#include <nav2_costmap_2d/include/nav2_costmap_2d/denoise/image_processing.hpp>

Public Member Functions
	ReplaceToZero (const T *up_row_start, const T *down_row_start, size_t columns)
	Create an object that will replace pointers outside the specified range. More...
T &	up (T *v)
	Return ref to pixel or to zero value if up_row_start_ is nullptr or the pointer is out of bounds. More...
T &	down (T *v)
	Return ref to pixel or to zero value if the pointer is out of bounds. More...

Detailed Description

template<class T>
class nav2_costmap_2d::imgproc_impl::out_of_bounds_policy::ReplaceToZero< T >

Boundary case object. Used as parameter of class Window. Dereferences a pointer to a existing pixel. If the pixel is out of bounds, it returns a ref to 0.

Template Parameters

T	image pixel type

See also

DoNothing

Definition at line 230 of file image_processing.hpp.

Constructor & Destructor Documentation

ReplaceToZero()

template<class T >

nav2_costmap_2d::imgproc_impl::out_of_bounds_policy::ReplaceToZero< T >::ReplaceToZero ( const T *  up_row_start, const T *  down_row_start, size_t  columns  )

inline

Create an object that will replace pointers outside the specified range.

Parameters

up_row_start	pointer to the first pixel of up row. Can be nullptr.
down_row_start	pointer to the first pixel of down row
columns	number of pixels in both rows

Definition at line 239 of file image_processing.hpp.

Member Function Documentation

down()

template<class T >

T& nav2_costmap_2d::imgproc_impl::out_of_bounds_policy::ReplaceToZero< T >::down ( T *  v )

inline

Return ref to pixel or to zero value if the pointer is out of bounds.

Parameters

v	pointer to pixel

Definition at line 259 of file image_processing.hpp.

up()

template<class T >

T& nav2_costmap_2d::imgproc_impl::out_of_bounds_policy::ReplaceToZero< T >::up ( T *  v )

inline

Return ref to pixel or to zero value if up_row_start_ is nullptr or the pointer is out of bounds.

Parameters

v	pointer to pixel

Definition at line 247 of file image_processing.hpp.

---

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

• nav2_costmap_2d/include/nav2_costmap_2d/denoise/image_processing.hpp