vpDepthMask Class Reference

#include <vpDepthMask.h>

Inheritance diagram for vpDepthMask:

Public Member Functions
	vpDepthMask ()
virtual	~vpDepthMask ()=default
void	updateMask (const vpRBFeatureTrackerInput &frame, const vpRBFeatureTrackerInput &previousFrame, vpImage< float > &mask) VP_OVERRIDE
virtual void	reset () VP_OVERRIDE
double	getMinRadiusFactor () const
void	setMinRadiusMeters (double minRadius)
double	getFalloffRadiusFactor () const
void	setFalloffRadiusFactor (double factor)
bool	isComputedOnlyOnBoundingBox () const
void	setComputeOnlyOnBoundingBox (bool bbOnly)
void	loadJsonConfiguration (const nlohmann::json &json) VP_OVERRIDE
virtual void	display (const vpImage< float > &mask, vpImage< unsigned char > &Imask) const

Detailed Description

A mask computation algorithm based on depth values.

Definition at line 56 of file vpDepthMask.h.

Constructor & Destructor Documentation

vpDepthMask()

vpDepthMask::vpDepthMask ( )

inline

Definition at line 59 of file vpDepthMask.h.

~vpDepthMask()

virtual vpDepthMask::~vpDepthMask ( )

virtualdefault

Member Function Documentation

display()

BEGIN_VISP_NAMESPACE void vpObjectMask::display ( const vpImage< float > & mask, vpImage< unsigned char > & Imask ) const

virtualinherited

Reimplemented in vpColorHistogramMask.

Definition at line 37 of file vpObjectMask.cpp.

References vpImage< Type >::bitmap, vpException::dimensionError, vpDisplay::display(), and vpImage< Type >::getSize().

Referenced by vpColorHistogramMask::display().

getFalloffRadiusFactor()

double vpDepthMask::getFalloffRadiusFactor ( ) const

inline

Get the Falloff smoothing factor (of the depth range) strength of the depth probability distribution. It corresponds to the standard deviation of a gaussian distribution, which is used to compute the probability of a depth values when it is not in the accepted depth range. The accepted depth range is computed using the object radius and clipping planes.

Returns

double

Definition at line 90 of file vpDepthMask.h.

getMinRadiusFactor()

double vpDepthMask::getMinRadiusFactor ( ) const

inline

Retrieve the value of the minimum depth tolerated error. It is expressed as a factor of the object's diameter.

By default, the accepted depth range error when computing the mask is computed using the rendered object's clipping planes. If these values are too close to the object's center

Returns

double

Definition at line 79 of file vpDepthMask.h.

isComputedOnlyOnBoundingBox()

bool vpDepthMask::isComputedOnlyOnBoundingBox ( ) const

inline

Definition at line 93 of file vpDepthMask.h.

loadJsonConfiguration()

void vpDepthMask::loadJsonConfiguration ( const nlohmann::json & json )

virtual

Implements vpObjectMask.

Definition at line 113 of file vpDepthMask.cpp.

reset()

virtual void vpDepthMask::reset ( )

inlinevirtual

Reimplemented from vpObjectMask.

Definition at line 66 of file vpDepthMask.h.

setComputeOnlyOnBoundingBox()

void vpDepthMask::setComputeOnlyOnBoundingBox ( bool bbOnly )

inline

Definition at line 94 of file vpDepthMask.h.

setFalloffRadiusFactor()

void vpDepthMask::setFalloffRadiusFactor ( double factor )

inline

Definition at line 91 of file vpDepthMask.h.

setMinRadiusMeters()

void vpDepthMask::setMinRadiusMeters ( double minRadius )

inline

Definition at line 80 of file vpDepthMask.h.

updateMask()

BEGIN_VISP_NAMESPACE void vpDepthMask::updateMask ( const vpRBFeatureTrackerInput & frame, const vpRBFeatureTrackerInput & previousFrame, vpImage< float > & mask )

virtual

Implements vpObjectMask.

Definition at line 41 of file vpDepthMask.cpp.

References vpException::badValue, vpImage< Type >::bitmap, vpRBRenderData::boundingBox, vpRBRenderData::cMo, vpRBFeatureTrackerInput::depth, vpRect::getBottom(), vpImage< Type >::getHeight(), vpRect::getLeft(), vpRect::getRight(), vpImage< Type >::getSize(), vpRect::getTop(), vpImage< Type >::getWidth(), vpRBFeatureTrackerInput::hasDepth(), vpRBRenderData::objectDiameter, vpRBFeatureTrackerInput::renders, vpImage< Type >::resize(), vpRBRenderData::zFar, and vpRBRenderData::zNear.