OpenPose 1.0.0rc2 OpenPose: A Real-Time Multi-Person Key-Point Detection And Multi-Threading C++ Library

- Main Page
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Public Attributes | List of all members
op::WrapperStructOutput Struct Reference

`#include <wrapperStructOutput.hpp>`

## Public Member Functions
| WrapperStructOutput (const double verbose=-1, const std::string &writeKeypoint="", const DataFormat writeKeypointFormat=DataFormat::Xml, const std::string &writeJson="", const std::string &writeCocoJson="", const std::string &writeCocoFootJson="", const int writeCocoJsonVariant=1, const std::string &writeImages="", const std::string &writeImagesFormat="", const std::string &writeVideo="", const double writeVideoFps=-1., const std::string &writeHeatMaps="", const std::string &writeHeatMapsFormat="", const std::string &writeVideo3D="", const std::string &writeVideoAdam="", const std::string &writeBvh="", const std::string &udpHost="", const std::string &udpPort="")

## Public Attributes
double | verbose
std::string | writeKeypoint
DataFormat | writeKeypointFormat
std::string | writeJson
std::string | writeCocoJson
std::string | writeCocoFootJson
int | writeCocoJsonVariant
std::string | writeImages
std::string | writeImagesFormat
std::string | writeVideo
std::string | writeHeatMaps
std::string | writeHeatMapsFormat
double | writeVideoFps
std::string | writeVideo3D
std::string | writeVideoAdam
std::string | writeBvh
std::string | udpHost
std::string | udpPort

## Detailed Description

WrapperStructOutput: Output ( writing rendered results and/or pose data, etc.) configuration struct.

## Constructor & Destructor Documentation

op::WrapperStructOutput::WrapperStructOutput | ( | const double | verbose = `-1`,
|  | const std::string & | writeKeypoint = `""`,
|  | const DataFormat | writeKeypointFormat = `DataFormat::Xml`,
|  | const std::string & | writeJson = `""`,
|  | const std::string & | writeCocoJson = `""`,
|  | const std::string & | writeCocoFootJson = `""`,
|  | const int | writeCocoJsonVariant = `1`,
|  | const std::string & | writeImages = `""`,
|  | const std::string & | writeImagesFormat = `""`,
|  | const std::string & | writeVideo = `""`,
|  | const double | writeVideoFps = `-1.`,
|  | const std::string & | writeHeatMaps = `""`,
|  | const std::string & | writeHeatMapsFormat = `""`,
|  | const std::string & | writeVideo3D = `""`,
|  | const std::string & | writeVideoAdam = `""`,
|  | const std::string & | writeBvh = `""`,
|  | const std::string & | udpHost = `""`,
|  | const std::string & | udpPort = `""`
| ) |  |

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

std::string op::WrapperStructOutput::udpHost

Target server IP address for UDP client-server communication.

std::string op::WrapperStructOutput::udpPort

Target server IP port for UDP client-server communication.

double op::WrapperStructOutput::verbose

Output verbose in the command line. If -1, it will be disabled (default). If it is a positive integer number, it will print on" the command line every `verbose` frames. If number in the range (0,1), it will print the" progress every `verbose` times the total of frames.

std::string op::WrapperStructOutput::writeBvh

Path to save a 3-D joint angle BVH file. Please, use *.bvh format. If it is empty (default), it is disabled.

std::string op::WrapperStructOutput::writeCocoFootJson

Analogous to writeCocoJson but for foot keypoints.

std::string op::WrapperStructOutput::writeCocoJson

Pose (x, y, score) locations saving folder location in JSON COCO validation format. If it is empty (default), it is disabled.

int op::WrapperStructOutput::writeCocoJsonVariant

Experimental option (only makes effect on car JSON generation). It selects the COCO variant for cocoJsonSaver.

std::string op::WrapperStructOutput::writeHeatMaps

Rendered heat maps saving folder. In order to save the heatmaps, WrapperStructPose.heatMapTypes must also be filled. If it is empty (default), it is disabled.

std::string op::WrapperStructOutput::writeHeatMapsFormat

Heat maps image saving format. Analogous to writeImagesFormat.

std::string op::WrapperStructOutput::writeImages

Rendered image saving folder. If it is empty (default), it is disabled.

std::string op::WrapperStructOutput::writeImagesFormat

Rendered image saving folder format. Check your OpenCV version documentation for a list of compatible formats. E.g., png, jpg, etc. If writeImages is empty (default), it makes no effect.

std::string op::WrapperStructOutput::writeJson

Directory to write OpenPose output in JSON format. If it is empty (default), it is disabled. It includes:

- `people` field with body, hand, and face pose keypoints in (x, y, score) format.
- `part_candidates` field with body part candidates in (x, y, score) format (if enabled with `--part_candidates`).

std::string op::WrapperStructOutput::writeKeypoint

Pose (x, y, score) locations saving folder location. If it is empty (default), it is disabled. Select format with writeKeypointFormat.

DataFormat op::WrapperStructOutput::writeKeypointFormat

Data format to save Pose (x, y, score) locations. Options: DataFormat::Json (default), DataFormat::Xml and DataFormat::Yml (equivalent to DataFormat::Yaml) JSON option only available for OpenCV >= 3.0.

std::string op::WrapperStructOutput::writeVideo

Rendered images saving video path. Please, use *.avi format. If it is empty (default), it is disabled.

std::string op::WrapperStructOutput::writeVideo3D

Rendered 3D images saving video path. Please, use *.avi format. If it is empty (default), it is disabled.

std::string op::WrapperStructOutput::writeVideoAdam

Rendered Adam images saving video path. Please, use *.avi format. If it is empty (default), it is disabled.

double op::WrapperStructOutput::writeVideoFps

Frame rate of the recorded video. By default (-1.), it will try to get the input frames producer frame rate (e.g., input video or webcam frame rate). If the input frames producer does not have a set FPS (e.g., image_dir or webcam if OpenCV not compiled with its support), set this value accordingly (e.g., to the frame rate displayed by the OpenPose GUI).

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

- /home/travis/build/CMU-Perceptual-Computing-Lab/openpose/include/openpose/wrapper/wrapperStructOutput.hpp