From 9827ab75d6ee813376da1cb2a3d960c7081e9fa2 Mon Sep 17 00:00:00 2001 From: Gines Hidalgo Date: Sun, 14 Jun 2020 00:05:25 -0400 Subject: [PATCH] Made (even) more clear tutorial thread is advanced --- .../1_thread_user_processing_function.cpp | 13 +++++-------- ...hread_user_input_processing_output_and_datum.cpp | 13 +++++-------- examples/tutorial_api_thread/README.md | 4 ++-- 3 files changed, 12 insertions(+), 18 deletions(-) diff --git a/examples/tutorial_api_thread/1_thread_user_processing_function.cpp b/examples/tutorial_api_thread/1_thread_user_processing_function.cpp index 3fdefde4..740c9fe0 100644 --- a/examples/tutorial_api_thread/1_thread_user_processing_function.cpp +++ b/examples/tutorial_api_thread/1_thread_user_processing_function.cpp @@ -1,12 +1,9 @@ // ------------------------- OpenPose Library Tutorial - Thread - Example 1 - User Processing Function ------------------------- -// This fourth example shows the user how to: - // 1. Read folder of images / video / webcam (`producer` module) - // 2. Use the processing implemented by the user - // 3. Display the rendered pose (`gui` module) - // Everything in a multi-thread scenario (`thread` module) -// In addition to the previous OpenPose modules, we also need to use: - // 1. `core` module: for the Datum struct that the `thread` module sends between the queues - // 2. `utilities` module: for the error & logging functions, i.e., op::error & op::log respectively +// This directory only provides examples for the basic OpenPose thread mechanism API, and it is only meant for people +// interested in the multi-thread architecture without been interested in the OpenPose pose estimation algorithm. +// You are most probably looking for the [examples/tutorial_api_cpp/](../tutorial_api_cpp/) or +// [examples/tutorial_api_python/](../tutorial_api_python/), which provide examples of the thread API already applied +// to body pose estimation. // Third-party dependencies #include diff --git a/examples/tutorial_api_thread/2_thread_user_input_processing_output_and_datum.cpp b/examples/tutorial_api_thread/2_thread_user_input_processing_output_and_datum.cpp index c7d970d1..9102ea9d 100644 --- a/examples/tutorial_api_thread/2_thread_user_input_processing_output_and_datum.cpp +++ b/examples/tutorial_api_thread/2_thread_user_input_processing_output_and_datum.cpp @@ -1,12 +1,9 @@ // ------------------------- OpenPose Library Tutorial - Thread - Example 2 - User Input Processing And Output ------------------------- -// This fourth example shows the user how to: - // 1. Read folder of images / video / webcam (`producer` module) - // 2. Use the processing implemented by the user - // 3. Display the rendered pose (`gui` module) - // Everything in a multi-thread scenario (`thread` module) -// In addition to the previous OpenPose modules, we also need to use: - // 1. `core` module: for the Datum struct that the `thread` module sends between the queues - // 2. `utilities` module: for the error & logging functions, i.e., op::error & op::log respectively +// This directory only provides examples for the basic OpenPose thread mechanism API, and it is only meant for people +// interested in the multi-thread architecture without been interested in the OpenPose pose estimation algorithm. +// You are most probably looking for the [examples/tutorial_api_cpp/](../tutorial_api_cpp/) or +// [examples/tutorial_api_python/](../tutorial_api_python/), which provide examples of the thread API already applied +// to body pose estimation. // Third-party dependencies #include diff --git a/examples/tutorial_api_thread/README.md b/examples/tutorial_api_thread/README.md index 0c00b062..0625591b 100644 --- a/examples/tutorial_api_thread/README.md +++ b/examples/tutorial_api_thread/README.md @@ -1,4 +1,4 @@ # Thread API Examples -**NOTE**: This is an advanced API, you are most probably looking for the [examples/tutorial_api_python/](../tutorial_api_python/) examples folder, which provides examples of the thread API but applied to body pose estimation. +**NOTE**: This directory only provides examples for the basic OpenPose thread mechanism API, and it is only meant for people interested in the multi-thread architecture without been interested in the OpenPose pose estimation algorithm. -This folder provides examples to the basic OpenPose thread mechanism API. It is only meant for people interesed in the multi-thread architecture without been interesed in the OpenPose pose estimation algorithm. +You are most probably looking for the [examples/tutorial_api_cpp/](../tutorial_api_cpp/) or [examples/tutorial_api_python/](../tutorial_api_python/), which provide examples of the thread API already applied to body pose estimation. -- GitLab