OpenPose  1.7.0
The first real-time multi-person system to jointly detect human body, hand, facial, and foot keypoints
op::FrameDisplayer Class Reference

#include <frameDisplayer.hpp>

Public Member Functions

 FrameDisplayer (const std::string &windowedName=OPEN_POSE_NAME_AND_VERSION, const Point< int > &initialWindowedSize=Point< int >{}, const bool fullScreen=false)
 
virtual ~FrameDisplayer ()
 
void initializationOnThread ()
 
void setFullScreenMode (const FullScreenMode fullScreenMode)
 
void switchFullScreenMode ()
 
void displayFrame (const Matrix &frame, const int waitKeyValue=-1)
 
void displayFrame (const std::vector< Matrix > &frames, const int waitKeyValue=-1)
 

Detailed Description

The FrameDisplayer class is the one presenting visually the processed frame to the user.

Definition at line 12 of file frameDisplayer.hpp.

Constructor & Destructor Documentation

◆ FrameDisplayer()

op::FrameDisplayer::FrameDisplayer ( const std::string &  windowedName = OPEN_POSE_NAME_AND_VERSION,
const Point< int > &  initialWindowedSize = Point< int >{},
const bool  fullScreen = false 
)

Constructor of the FrameDisplayer class.

Parameters
windowedNameconst std::string value with the opencv resulting display name. Showed at the top-left part of the window.
initialWindowedSizeconst Point<int> with the initial window output resolution (width and height).
fullScreenbool from which the FrameDisplayer::FullScreenMode property mFullScreenMode will be set, i.e., specifying the type of initial display (it can be changed later).

◆ ~FrameDisplayer()

virtual op::FrameDisplayer::~FrameDisplayer ( )
virtual

Member Function Documentation

◆ displayFrame() [1/2]

void op::FrameDisplayer::displayFrame ( const Matrix frame,
const int  waitKeyValue = -1 
)

This function displays an image on the display.

Parameters
frameMat image to display.
waitKeyValueint value that specifies the argument parameter for cv::waitKey (see OpenCV documentation for more information). Special cases: select -1 not to use cv::waitKey or 0 for cv::waitKey(0). OpenCV doc: http://docs.opencv.org/2.4/modules/highgui/doc/user_interface.html?highlight=waitkey

◆ displayFrame() [2/2]

void op::FrameDisplayer::displayFrame ( const std::vector< Matrix > &  frames,
const int  waitKeyValue = -1 
)

Analogous to the previous displayFrame, but first it horizontally concatenates all the frames

◆ initializationOnThread()

void op::FrameDisplayer::initializationOnThread ( )

◆ setFullScreenMode()

void op::FrameDisplayer::setFullScreenMode ( const FullScreenMode  fullScreenMode)

This function set the new FrameDisplayer::FullScreenMode (e.g., full screen).

Parameters
fullScreenModeNew FrameDisplayer::FullScreenMode state.

◆ switchFullScreenMode()

void op::FrameDisplayer::switchFullScreenMode ( )

This function switch between full screen and windowed modes (e.g., when double-click on video players or Ctrt+Enter are presed).


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