From faa03bc9d9505bec2cfaccab3fbced6d4ab358aa Mon Sep 17 00:00:00 2001 From: Myzhar Date: Fri, 5 Jun 2020 16:47:50 +0200 Subject: [PATCH] * Doc minor fixes * Change default resolutions for examples --- README.md | 8 ++++++-- doc/api_doc/add-on.txt | 2 +- examples/zed_oc_control_example.cpp | 4 ++-- examples/zed_oc_rectify_example.cpp | 4 ++-- examples/zed_oc_sync_example.cpp | 4 ++-- 5 files changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 119fe11..3c3b1ce 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ ![](./images/Picto+STEREOLABS_Black.jpg) -# ZED Open Capture +# ZED Open Capture API The ZED Open Capture library allows the low level control of ZED, ZED Mini and ZED 2 camera. The library provides methods to access raw video frames, to control the video parameters and to acquire raw data from the internal sensors (only ZED Mini and ZED2). A synchronization mechanism is provided to get the correct sensor data associated to each video frame. **Note:** The provided data are not calibrated, images are not rectified in a stereoscopic way, IMU data may drift or be misaligned. Calibration data can be accessed using the [ZED SDK](https://www.stereolabs.com/developers/release/). +[Online documentation](https://stereolabs.github.io/zed-open-capture) + ## Installation ### Prerequisites @@ -116,7 +118,9 @@ From inside the `build` folder: ## Documentation -HTML Documentation can be locally generated using Doxygen +Full online documentation: https://stereolabs.github.io/zed-open-capture + +Documentation can be locally generated in HTML format using Doxygen: $ sudo apt-get install -y doxygen # if not previously installed $ cd doc diff --git a/doc/api_doc/add-on.txt b/doc/api_doc/add-on.txt index 569b1d7..b8fa3f1 100644 --- a/doc/api_doc/add-on.txt +++ b/doc/api_doc/add-on.txt @@ -1,5 +1,5 @@  -/*! \mainpage ZED Open Capture +/*! \mainpage ZED Open Capture API ![](img/ZED-2-front.jpg) diff --git a/examples/zed_oc_control_example.cpp b/examples/zed_oc_control_example.cpp index 33b3dd2..bb3307f 100644 --- a/examples/zed_oc_control_example.cpp +++ b/examples/zed_oc_control_example.cpp @@ -73,8 +73,8 @@ int main(int argc, char *argv[]) // ----> 1) Set Video parameters sl_oc::VideoParams params; - params.res = sl_oc::RESOLUTION::HD720; - params.fps = sl_oc::FPS::FPS_60; + params.res = sl_oc::RESOLUTION::HD2K; + params.fps = sl_oc::FPS::FPS_15; params.verbose = verbose; // <---- Set Video parameters diff --git a/examples/zed_oc_rectify_example.cpp b/examples/zed_oc_rectify_example.cpp index a59c828..8d912b1 100644 --- a/examples/zed_oc_rectify_example.cpp +++ b/examples/zed_oc_rectify_example.cpp @@ -42,8 +42,8 @@ int main(int argc, char** argv) { // ----> 1) Set Video parameters sl_oc::VideoParams params; - params.res = sl_oc::RESOLUTION::HD720; - params.fps = sl_oc::FPS::FPS_60; + params.res = sl_oc::RESOLUTION::HD2K; + params.fps = sl_oc::FPS::FPS_15; params.verbose = verbose; // <---- Set Video parameters diff --git a/examples/zed_oc_sync_example.cpp b/examples/zed_oc_sync_example.cpp index a7a3739..37ff89e 100644 --- a/examples/zed_oc_sync_example.cpp +++ b/examples/zed_oc_sync_example.cpp @@ -56,8 +56,8 @@ int main(int argc, char *argv[]) // ----> 1) Set the video parameters sl_oc::VideoParams params; - params.res = sl_oc::RESOLUTION::HD720; - params.fps = sl_oc::FPS::FPS_60; + params.res = sl_oc::RESOLUTION::HD2K; + params.fps = sl_oc::FPS::FPS_15; params.verbose = verbose; // <---- Video parameters