#include <wrapperStructHand.hpp>

Public Member Functions
	WrapperStructHand (const bool enable=false, const Detector detector=Detector::Body, const Point< int > &netInputSize=Point< int >{368, 368}, const int scalesNumber=1, const float scaleRange=0.4f, const RenderMode renderMode=RenderMode::Auto, const float alphaKeypoint=HAND_DEFAULT_ALPHA_KEYPOINT, const float alphaHeatMap=HAND_DEFAULT_ALPHA_HEAT_MAP, const float renderThreshold=0.2f)

Public Attributes
bool	enable

Detector	detector

Point< int >	netInputSize

int	scalesNumber

float	scaleRange

RenderMode	renderMode

float	alphaKeypoint

float	alphaHeatMap

float	renderThreshold

Detailed Description

WrapperStructHand: Hand estimation and rendering configuration struct. WrapperStructHand allows the user to set up the hand estimation and rendering parameters that will be used for the OpenPose WrapperT template and Wrapper class.

Definition at line 16 of file wrapperStructHand.hpp.

Constructor & Destructor Documentation

◆ WrapperStructHand()

op::WrapperStructHand::WrapperStructHand	(	const bool	enable = `false`,
		const Detector	detector = `Detector::Body`,
		const Point< int > &	netInputSize = `Point< int >{368, 368}`,
		const int	scalesNumber = `1`,
		const float	scaleRange = `0.4f`,
		const RenderMode	renderMode = `RenderMode::Auto`,
		const float	alphaKeypoint = `HAND_DEFAULT_ALPHA_KEYPOINT`,
		const float	alphaHeatMap = `HAND_DEFAULT_ALPHA_HEAT_MAP`,
		const float	renderThreshold = `0.2f`
	)

Constructor of the struct. It has the recommended and default values we recommend for each element of the struct. Since all the elements of the struct are public, they can also be manually filled.

Member Data Documentation

◆ alphaHeatMap

float op::WrapperStructHand::alphaHeatMap

Rendering blending alpha value of the heat maps (hand part, background or PAF) with respect to the background image. Value in the range [0, 1]. 0 will only render the background, 1 will only render the heat map.

Definition at line 72 of file wrapperStructHand.hpp.

◆ alphaKeypoint

float op::WrapperStructHand::alphaKeypoint

Rendering blending alpha value of the pose point locations with respect to the background image. Value in the range [0, 1]. 0 will only render the background, 1 will fully render the pose.

Definition at line 65 of file wrapperStructHand.hpp.

◆ detector

Detector op::WrapperStructHand::detector

Kind of hand rectangle detector. Recommended Detector::Body (fastest one if body is enabled and most accurate one), which is based on the OpenPose body keypoint detector. For hand, there is the alternative of Detector::BodyWithTracking. If selected, it will add tracking between frames. Adding hand tracking might improve hand keypoints detection for webcam (if the frame rate is high enough, i.e., >7 FPS per GPU) and video. This is not person ID tracking, it simply looks for hands in positions at which hands were located in previous frames, but it does not guarantee the same person id among frames.

Definition at line 32 of file wrapperStructHand.hpp.

◆ enable

bool op::WrapperStructHand::enable

Whether to extract hand.

Definition at line 21 of file wrapperStructHand.hpp.

◆ netInputSize

Point<int> op::WrapperStructHand::netInputSize

CCN (Conv Net) input size. The greater, the slower and more memory it will be needed, but it will potentially increase accuracy. Both width and height must be divisible by 16.

Definition at line 39 of file wrapperStructHand.hpp.

◆ renderMode

RenderMode op::WrapperStructHand::renderMode

Whether to render the output (pose locations, body, background or PAF heat maps) with CPU or GPU. Select None for no rendering, Cpu or Gpu por CPU and GPU rendering respectively.

Definition at line 59 of file wrapperStructHand.hpp.

◆ renderThreshold

float op::WrapperStructHand::renderThreshold

Rendering threshold. Only estimated keypoints whose score confidences are higher than this value will be rendered. Note: Rendered refers only to visual display in the OpenPose basic GUI, not in the saved results. Generally, a high threshold (> 0.5) will only render very clear body parts; while small thresholds (~0.1) will also output guessed and occluded keypoints, but also more false positives (i.e., wrong detections).

Definition at line 81 of file wrapperStructHand.hpp.

◆ scaleRange

float op::WrapperStructHand::scaleRange

Total range between smallest and biggest scale. The scales will be centered in ratio 1. E.g., if scaleRange = 0.4 and scalesNumber = 2, then there will be 2 scales, 0.8 and 1.2.

Definition at line 53 of file wrapperStructHand.hpp.

◆ scalesNumber

int op::WrapperStructHand::scalesNumber

Number of scales to process. The greater, the slower and more memory it will be needed, but it will potentially increase accuracy. This parameter is related with scaleRange, such as the final pose estimation will be an average of the predicted results for each scale.

Definition at line 47 of file wrapperStructHand.hpp.

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

include/openpose/wrapper/wrapperStructHand.hpp

Public Member Functions

Public Attributes