#include <wrapperStructInput.hpp>

Public Member Functions
	WrapperStructInput (const ProducerType producerType=ProducerType::None, const String &producerString="", const unsigned long long frameFirst=0, const unsigned long long frameStep=1, const unsigned long long frameLast=std::numeric_limits< unsigned long long >::max(), const bool realTimeProcessing=false, const bool frameFlip=false, const int frameRotate=0, const bool framesRepeat=false, const Point< int > &cameraResolution=Point< int >{-1,-1}, const String &cameraParameterPath="models/cameraParameters/", const bool undistortImage=false, const int numberViews=-1)

Public Attributes
ProducerType	producerType

String	producerString

unsigned long long	frameFirst

unsigned long long	frameStep

unsigned long long	frameLast

bool	realTimeProcessing

bool	frameFlip

int	frameRotate

bool	framesRepeat

Point< int >	cameraResolution

String	cameraParameterPath

bool	undistortImage

int	numberViews

Detailed Description

WrapperStructInput: Input (images, video, webcam, etc.) configuration struct. WrapperStructInput allows the user to set up the input frames generator.

Definition at line 14 of file wrapperStructInput.hpp.

Constructor & Destructor Documentation

◆ WrapperStructInput()

op::WrapperStructInput::WrapperStructInput	(	const ProducerType	producerType = `ProducerType::None`,
		const String &	producerString = `""`,
		const unsigned long long	frameFirst = `0`,
		const unsigned long long	frameStep = `1`,
		const unsigned long long	frameLast = `std::numeric_limits< unsigned long long >::max()`,
		const bool	realTimeProcessing = `false`,
		const bool	frameFlip = `false`,
		const int	frameRotate = `0`,
		const bool	framesRepeat = `false`,
		const Point< int > &	cameraResolution = `Point< int >{-1,-1}`,
		const String &	cameraParameterPath = `"models/cameraParameters/"`,
		const bool	undistortImage = `false`,
		const int	numberViews = `-1`
	)

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

◆ cameraParameterPath

String op::WrapperStructInput::cameraParameterPath

Directory path for the camera parameters (intrinsic and extrinsic parameters) or optionally XML file full path (if only 1 view).

Definition at line 78 of file wrapperStructInput.hpp.

◆ cameraResolution

Point<int> op::WrapperStructInput::cameraResolution

Camera resolution (only for Webcam and FlirCamera).

Definition at line 72 of file wrapperStructInput.hpp.

◆ frameFirst

unsigned long long op::WrapperStructInput::frameFirst

First image to process. Default: 0.

Definition at line 33 of file wrapperStructInput.hpp.

◆ frameFlip

bool op::WrapperStructInput::frameFlip

Whether to flip (mirror) the image.

Definition at line 56 of file wrapperStructInput.hpp.

◆ frameLast

unsigned long long op::WrapperStructInput::frameLast

Last image to process. Default: -1 (i.e., process all frames).

Definition at line 46 of file wrapperStructInput.hpp.

◆ frameRotate

int op::WrapperStructInput::frameRotate

Image rotation. Only 4 possible values: 0 (default, no rotation), 90, 180 or 270 degrees

Definition at line 62 of file wrapperStructInput.hpp.

◆ framesRepeat

bool op::WrapperStructInput::framesRepeat

Whether to re-open the producer if it reaches the end (e.g., video or image directory after the last frame).

Definition at line 67 of file wrapperStructInput.hpp.

◆ frameStep

unsigned long long op::WrapperStructInput::frameStep

Step or gap across processed frames. Default: 1 (i.e., process all frames). Example: A value of 5 would mean to process frames 0, 5, 10, etc.

Definition at line 40 of file wrapperStructInput.hpp.

◆ numberViews

int op::WrapperStructInput::numberViews

Number of camera views. Complementary option for --image_dir or --video It is -1 for Flir cameras (# cameras detected at runtime), as well as for any other frames source (-1 and 1 are equivalent for those). It could be greater than 1 only for prerecorded produced sources, such as video and image directory.

Definition at line 92 of file wrapperStructInput.hpp.

◆ producerString

String op::WrapperStructInput::producerString

Path of the producer (image directory path for ImageDirectory, video path for Video, camera index for Webcam and FlirCamera, URL for IPCamera, etc.). Default: "".

Definition at line 27 of file wrapperStructInput.hpp.

◆ producerType

ProducerType op::WrapperStructInput::producerType

Desired type of producer (FlirCamera, ImageDirectory, IPCamera, Video, Webcam, None, etc.). Default: ProducerType::None.

Definition at line 20 of file wrapperStructInput.hpp.

◆ realTimeProcessing

bool op::WrapperStructInput::realTimeProcessing

Whether to skip or sleep in order to keep the same FPS as the frames producer.

Definition at line 51 of file wrapperStructInput.hpp.

◆ undistortImage

bool op::WrapperStructInput::undistortImage

Whether to undistort the image given the camera parameters.

Definition at line 83 of file wrapperStructInput.hpp.

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

include/openpose/wrapper/wrapperStructInput.hpp

Public Member Functions

Public Attributes