All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
op::WrapperStructOutput Struct Reference

`#include <wrapperStructOutput.hpp>`

## Public Member Functions

WrapperStructOutput (const DisplayMode displayMode=DisplayMode::NoDisplay, const bool guiVerbose=false, const bool fullScreen=false, 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=30., const std::string &writeHeatMaps="", const std::string &writeHeatMapsFormat="", const std::string &writeVideoAdam="", const std::string &writeBvh="", const std::string &udpHost="", const std::string &udpPort="")

## Public Attributes

DisplayMode | displayMode
bool | guiVerbose
bool | fullScreen
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 | writeVideoAdam
std::string | writeBvh
std::string | udpHost
std::string | udpPort

## Detailed Description

WrapperStructOutput: Output (small GUI, writing rendered results and/or pose data, etc.) configuration struct. WrapperStructOutput allows the user to set up the input frames generator.

## Constructor & Destructor Documentation

op::WrapperStructOutput::WrapperStructOutput | ( | const DisplayMode | displayMode = `DisplayMode::NoDisplay`,
|  | const bool | guiVerbose = `false`,
|  | const bool | fullScreen = `false`,
|  | 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 = `30.`,
|  | const std::string & | writeHeatMaps = `""`,
|  | const std::string & | writeHeatMapsFormat = `""`,
|  | 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

DisplayMode op::WrapperStructOutput::displayMode

Display mode a) -1 for automatic selection. b) 0 for no display. Useful if there is no X server and/or to slightly speed up the processing if visual output is not required. c) 2 for 2-D display in the OpenPose small integrated GUI. d) 3 for 3-D display, if `--3d` was enabled. e) 1 for both 2-D and 3-D display.

bool op::WrapperStructOutput::fullScreen

Whether to display the OpenPose small integrated GUI on fullscreen mode. It can be changed by interacting with the GUI itself.

bool op::WrapperStructOutput::guiVerbose

Whether to add some information to the frame (number of frame, number people detected, etc.) after it is saved on disk and before it is displayed and/or returned to the user.

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.

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::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.

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

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