Depth camera which handles mapping to integer depth values, base class. More...

Inheritance diagram for mf::depth_image_camera< Depth >:

Public Types
using	pixel_depth_type = Depth
	Pixel depth value integer type. More...

Public Types inherited from mf::image_camera
using	pixel_coordinates_type = ndptrdiff< 2 >

using	image_coordinates_type = typename camera::image_coordinates_type

Public Member Functions
	depth_image_camera ()=default

	depth_image_camera (const ndsize< 2 > &image_size, real origin, real range)

bool	in_depth_bounds (real d) const
	Verifies whether d is in bounds of valid depth values. More...

pixel_depth_type	to_pixel_depth (real d) const
	Map depth value to pixel depth value. More...

pixel_depth_type	to_pixel_depth_clamp (real d) const
	Map depth value to pixel depth value, and clamp to bounds. More...

real	to_depth (pixel_depth_type pixd) const
	Map pixel depth value to depth value in range defined by depth projection parameter. More...

Public Member Functions inherited from mf::image_camera
	image_camera (const image_camera &)=default

real	image_aspect_ratio () const

const ndsize< 2 > &	image_size () const

std::size_t	image_number_of_pixels () const

bool	pixel_coordinates_flipped () const

void	flip_pixel_coordinates ()

void	set_image_width (std::size_t)
	Set image width, and adjust height to keep same aspect ratio. More...

void	set_image_height (std::size_t)
	Set image height, and adjust width to keep same aspect ratio. More...

ndspan< 2 >	image_span () const

image_coordinates_type	to_image (pixel_coordinates_type pix) const

pixel_coordinates_type	to_pixel (image_coordinates_type im) const

Additional Inherited Members
Protected Member Functions inherited from mf::image_camera
	image_camera (const ndsize< 2 > &)

Detailed Description

Depth camera which handles mapping to integer depth values, base class.

Member Typedef Documentation

template<typename Depth >

Pixel depth value integer type.

template<typename Depth >

mf::depth_image_camera< Depth >::depth_image_camera ( )

default

template<typename Depth >

mf::depth_image_camera< Depth >::depth_image_camera	(	const ndsize< 2 > &	image_size,
		real	origin,
		real	range
	)

inline

template<typename Depth >

bool mf::depth_image_camera< Depth >::in_depth_bounds ( real d ) const

Verifies whether d is in bounds of valid depth values.

template<typename Depth >

real mf::depth_image_camera< Depth >::to_depth ( pixel_depth_type pixd ) const

Map pixel depth value to depth value in range defined by depth projection parameter.

Values outside pixel depth range are mapped to values outside real depth range.

template<typename Depth >

auto mf::depth_image_camera< Depth >::to_pixel_depth ( real d ) const

Map depth value to pixel depth value.

d must be in bounds, i.e. in_depth_bounds(d) must be true.

template<typename Depth >

auto mf::depth_image_camera< Depth >::to_pixel_depth_clamp ( real d ) const

Map depth value to pixel depth value, and clamp to bounds.

If d is not in bounds, result is clamped between minimum and maximum pixel depth.

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