diff --git a/docs/build/building_orbbec_sdk.md b/docs/build/building_orbbec_sdk.md index c8816c7a..49f4160f 100644 --- a/docs/build/building_orbbec_sdk.md +++ b/docs/build/building_orbbec_sdk.md @@ -39,10 +39,10 @@ You can build Orbbec SDK by using the following commands: - Linux: Use a terminal emulator to execute the build commands ```shell -cd OrbbecSDK-dev -mkdir build +cd OrbbecSDK-dev +mkdir build cd build -cmake .. +cmake .. cmake --build . --config Release ``` @@ -54,7 +54,7 @@ cd OrbbecSDK-dev/scripts/build # `./build_linux_docker.sh aarch64` for arm64 ``` -> More information about how to use Docker, please refer to [README.md](/scripts/docker/README.md). +> More information about how to use Docker, please refer to [README.md](../../scripts/docker/README.md). ## Run the Sample @@ -68,11 +68,11 @@ After you build the Orbbec SDK, you can find the executable file in the director For windows,you need to register the metadata associated with frames (this includes things like timestamps and other information about the video frame). -- Metadata registration follow this:[/scripts/env_setup/obsensor_metadata_win10.md](/scripts/env_setup/obsensor_metadata_win10.md) +- Metadata registration follow this:[/scripts/env_setup/obsensor_metadata_win10.md](../..//scripts/env_setup/obsensor_metadata_win10.md) #### Linux - Please install it using the following commands:[/scripts/env_setup/install_udev_rules.sh](/scripts/env_setup/install_udev_rules.sh) + Please install it using the following commands:[/scripts/env_setup/install_udev_rules.sh](../../scripts/env_setup/install_udev_rules.sh) ```shell cd OrbbecSDK-dev/scripts/env_setup @@ -94,4 +94,4 @@ cd bin .\ob_XXX # .\ob_XXX.exe for windows ``` -> More information about the samples of Orbbec SDK, please refer to [samples](/examples/README.md). +> More information about the examples of Orbbec SDK, please refer to [examples](../../examples/README.md). diff --git a/docs/developer/contributing_to_orbbec_sdk.md b/docs/developer/contributing_to_orbbec_sdk.md index 7df6f937..f529a4a9 100644 --- a/docs/developer/contributing_to_orbbec_sdk.md +++ b/docs/developer/contributing_to_orbbec_sdk.md @@ -7,17 +7,17 @@ If you would like to contribute to this source project, please follow these step - This step is to ensure that make a copy of this project and place it in your own GitHub account. - Repository is Github's way of raising usage items, and fork is its copy - Make sure you are on the Orbbec SDK repository's [main page](https://github.com/orbbec/OrbbecSDK-dev). -![Click](/docs/resource/developer_fork.jpg) -![Fork](/docs/resource/developer_fork2.jpg) +![Click](../resource/developer_fork.jpg) +![Fork](../resource/developer_fork2.jpg) - Now, you have a copy of the repository in your own GitHub account. Please switch to the fork in your own account. -![switch](/docs/resource/developer_fork3.jpg) +![switch](../resource/developer_fork3.jpg) **Step2:Clone the repository** - You can use HTTPS or SSH to clone the repository.Copy the URL of the repository you want to clone. -![clone](/docs/resource/developer_clone.jpg) +![clone](../resource/developer_clone.jpg) - Go back to your local folder and open git bash. @@ -52,10 +52,10 @@ git checkout -b your_branch_name **Step6:Submit a PR(Pull Request)** - After successfully pushing the change file into your fork repository, back to you fork in Github, then you can submit the PR to the main repository. -![PR](/docs/resource/developer_PR.jpg) +![PR](../resource/developer_PR.jpg) - After filling in the title and description, you can click `Create pull request` -![PR2](/docs/resource/developer_PR2.jpg) +![PR2](../resource/developer_PR2.jpg) - Finally, you've done all the steps, and we will approve your PR after the reviewers have checked it. diff --git a/docs/tutorial/installation_and_development_guide.md b/docs/tutorial/installation_and_development_guide.md index cc1f39c7..922ba6b4 100644 --- a/docs/tutorial/installation_and_development_guide.md +++ b/docs/tutorial/installation_and_development_guide.md @@ -15,7 +15,7 @@ This is a comprehensive guide on installing the SDK, setting up the development For windows, you need to register the metadata associated with frames (this includes things like timestamps and other information about the video frame). -- Metadata registration follow this:[/scripts/env_setup/obsensor_metadata_win10.md](/scripts/env_setup/obsensor_metadata_win10.md) +- Metadata registration follow this:[/scripts/env_setup/obsensor_metadata_win10.md](../../scripts/env_setup/obsensor_metadata_win10.md) #### 1.2.2 Linux @@ -52,7 +52,7 @@ cd bin ./ob_color # ./ob_color for linux ``` -> More information about the samples of Orbbec SDK, please refer to [samples](/examples/README.md). +> More information about the examples of Orbbec SDK, please refer to [examples](../../examples/README.md). ## 2. Develop a New Application with the SDK diff --git a/examples/0.basic.enumerate/README.md b/examples/0.basic.enumerate/README.md index bd40fb99..c767df7e 100644 --- a/examples/0.basic.enumerate/README.md +++ b/examples/0.basic.enumerate/README.md @@ -16,7 +16,7 @@ Device is the device object, which can be used to obtain the device information, ```cpp // Create a context. - ob::Context context; + ob::Context context; ``` 2. Check if there is a camera connected @@ -124,4 +124,4 @@ Press the Esc key in the window to exit the program. ### Result -![image](/docs/resource/enumerate.jpg) +![image](../../docs/resource/enumerate.jpg) diff --git a/examples/0.basic.quick_start/README.md b/examples/0.basic.quick_start/README.md index 89b1ff48..ad782065 100644 --- a/examples/0.basic.quick_start/README.md +++ b/examples/0.basic.quick_start/README.md @@ -57,4 +57,4 @@ Press the Esc key in the window to exit the program. ### Result -![image](/docs/resource/quick_start.jpg) +![image](../../docs/resource/quick_start.jpg) diff --git a/examples/1.stream.callback/README.md b/examples/1.stream.callback/README.md index 7c4bbeb2..d05c1594 100644 --- a/examples/1.stream.callback/README.md +++ b/examples/1.stream.callback/README.md @@ -93,4 +93,4 @@ Press the Esc key in the window to exit the program. ### Result -![result](/docs/resource/callback.jpg) +![result](../../docs/resource/callback.jpg) diff --git a/examples/1.stream.color/README.md b/examples/1.stream.color/README.md index 75d4f70c..573a64d1 100644 --- a/examples/1.stream.color/README.md +++ b/examples/1.stream.color/README.md @@ -44,4 +44,4 @@ Press the Esc key in the window to exit the program. ### Result -![result](/docs/resource/color.jpg) +![result](../../docs/resource/color.jpg) diff --git a/examples/1.stream.depth/README.md b/examples/1.stream.depth/README.md index 73d45a62..14e08e03 100644 --- a/examples/1.stream.depth/README.md +++ b/examples/1.stream.depth/README.md @@ -48,4 +48,4 @@ Press the Esc key in the window to exit the program. ### Result -![image](/docs/resource/depth.jpg) +![image](../../docs/resource/depth.jpg) diff --git a/examples/1.stream.imu/README.md b/examples/1.stream.imu/README.md index 3f35adf3..0d27e238 100644 --- a/examples/1.stream.imu/README.md +++ b/examples/1.stream.imu/README.md @@ -63,4 +63,4 @@ Press the Esc key in the window to exit the program. ### Result -![image](/docs/resource/imu.jpg) +![image](../../docs/resource/imu.jpg) diff --git a/examples/1.stream.infrared/README.md b/examples/1.stream.infrared/README.md index acaf1276..6ab51d50 100644 --- a/examples/1.stream.infrared/README.md +++ b/examples/1.stream.infrared/README.md @@ -56,4 +56,4 @@ Press the Esc key in the window to exit the program. ### Result -![image](/docs/resource/infrared.jpg) +![image](../../docs/resource/infrared.jpg) diff --git a/examples/1.stream.multi_streams/README.md b/examples/1.stream.multi_streams/README.md index b4b72425..0024ece4 100644 --- a/examples/1.stream.multi_streams/README.md +++ b/examples/1.stream.multi_streams/README.md @@ -71,4 +71,4 @@ Press the Esc key in the window to exit the program. ### Result -![image](/docs/resource/multistream.jpg) +![image](../../docs/resource/multistream.jpg) diff --git a/examples/2.device.control/README.md b/examples/2.device.control/README.md index 8f07c3c3..d457ba66 100644 --- a/examples/2.device.control/README.md +++ b/examples/2.device.control/README.md @@ -171,6 +171,6 @@ Press the Esc key in the window to exit the program. ### Result -![image](/docs/resource/control1.jpg) +![image](../../docs/resource/control1.jpg) -![image](/docs/resource/control2.jpg) +![image](../../docs/resource/control2.jpg) diff --git a/examples/2.device.hot_plugin/README.md b/examples/2.device.hot_plugin/README.md index ecf9ccd0..c5546a43 100644 --- a/examples/2.device.hot_plugin/README.md +++ b/examples/2.device.hot_plugin/README.md @@ -71,4 +71,4 @@ Press the Esc key in the window to exit the program ### Result -![image](/docs/resource/hotplugin.jpg) +![image](../../docs/resource/hotplugin.jpg) diff --git a/examples/3.advanced.common_usages/README.md b/examples/3.advanced.common_usages/README.md index 811aae01..69374abd 100644 --- a/examples/3.advanced.common_usages/README.md +++ b/examples/3.advanced.common_usages/README.md @@ -51,9 +51,9 @@ Device is the device object, which can be used to obtain the device information, //Laser switch function void switchLaser() //Laser safety protection and ranging function switch - void switchLDP() + void switchLDP() //Get the laser safety protection and ranging function status - void getLDPStatus() + void getLDPStatus() //Color auto-exposure switch void switchColorAE() //Color exposure value adjustment @@ -61,7 +61,7 @@ Device is the device object, which can be used to obtain the device information, //Color gain value adjustment void setColorGainValue(bool increase) //Depth auto-exposure switch - void setDepthExposureValue(bool increase) + void setDepthExposureValue(bool increase) //Depth exposure value adjustment void setDepthGainValue(bool increase) ‵‵‵ @@ -72,6 +72,6 @@ Press the button according to the interface prompts ### Result -![image](/docs/resource/common1.jpg) +![image](../../docs/resource/common1.jpg) -![image](/docs/resource/common2.jpg) +![image](../../docs/resource/common2.jpg) diff --git a/examples/3.advanced.coordinate_transform/README.md b/examples/3.advanced.coordinate_transform/README.md index 1d99a2ab..46b3b5ca 100644 --- a/examples/3.advanced.coordinate_transform/README.md +++ b/examples/3.advanced.coordinate_transform/README.md @@ -82,17 +82,17 @@ Frameset is a combination of different types of Frames transformation3dto2d(colorFrame, depthFrame); } else { std::cout << "Invalid command" << std::endl; - } + } ``` ## Run Sample -Press the Esc key to exit the program. -Press the 1 key - transformation 2d to 2d -Press the 2 key - transformation 2d to 3d -Press the 3 key - transformation 3d to 3d +Press the Esc key to exit the program. +Press the 1 key - transformation 2d to 2d +Press the 2 key - transformation 2d to 3d +Press the 3 key - transformation 3d to 3d Press the 4 key - transformation 3d to 2d ### Result -![image](/docs/resource/coordinate_transform.jpg) +![image](../../docs/resource/coordinate_transform.jpg) diff --git a/examples/3.advanced.hdr/README.md b/examples/3.advanced.hdr/README.md index 2f2d1864..e6a62a7c 100644 --- a/examples/3.advanced.hdr/README.md +++ b/examples/3.advanced.hdr/README.md @@ -80,4 +80,4 @@ Press the 'N' key in the window to Toggle alternate show origin frame. ### Result -![hdr](/docs/resource/hdr.jpg) +![hdr](../../docs/resource/hdr.jpg) diff --git a/examples/3.advanced.multi_devices/README.md b/examples/3.advanced.multi_devices/README.md index a8cc2aa9..29b1cbf1 100644 --- a/examples/3.advanced.multi_devices/README.md +++ b/examples/3.advanced.multi_devices/README.md @@ -89,4 +89,4 @@ Press the '?' key in the window to show key map. ### Result -![multi_devices](/docs/resource/multi_devices.jpg) +![multi_devices](../../docs/resource/multi_devices.jpg) diff --git a/examples/3.advanced.point_cloud/README.md b/examples/3.advanced.point_cloud/README.md index de6a0a8d..ad2df1b2 100644 --- a/examples/3.advanced.point_cloud/README.md +++ b/examples/3.advanced.point_cloud/README.md @@ -46,11 +46,11 @@ Pipeline is a pipeline for processing data streams, providing multi-channel stre ## Run Sample -Press R or r to create RGBD PointCloud and save to ply file! +Press R or r to create RGBD PointCloud and save to ply file! Press D or d to create Depth PointCloud and save to ply file! Press ESC to exit! ### Result -![image](/docs/resource/point_cloud.jpg) +![image](../../docs/resource/point_cloud.jpg) diff --git a/examples/3.advanced.post_processing/README.md b/examples/3.advanced.post_processing/README.md index bb9b05fb..b7e6960e 100644 --- a/examples/3.advanced.post_processing/README.md +++ b/examples/3.advanced.post_processing/README.md @@ -78,4 +78,4 @@ Press the button according to the interface prompts ### Result -![image](/docs/resource/post_processing.jpg) +![image](../../docs/resource/post_processing.jpg) diff --git a/examples/3.advanced.preset/README.md b/examples/3.advanced.preset/README.md index 64ae9483..b16fca83 100644 --- a/examples/3.advanced.preset/README.md +++ b/examples/3.advanced.preset/README.md @@ -36,4 +36,4 @@ Press the button according to the interface prompts ### Result -![image](/docs/resource/preset.jpg) +![image](../../docs/resource/preset.jpg) diff --git a/examples/3.advanced.sync_align/README.md b/examples/3.advanced.sync_align/README.md index bfa776df..95212794 100644 --- a/examples/3.advanced.sync_align/README.md +++ b/examples/3.advanced.sync_align/README.md @@ -59,8 +59,8 @@ Press the Esc key in the window to exit the program. ### Result Sync -![image](/docs/resource/sync.jpg) -D2C -![image](/docs/resource/d2c.jpg) -C2D -![image](/docs/resource/c2d.jpg) +![image](../../docs/resource/sync.jpg) +D2C +![image](../../docs/resource/d2c.jpg) +C2D +![image](../../docs/resource/c2d.jpg) diff --git a/examples/c_examples/0.c_quick_start/readme.md b/examples/c_examples/0.c_quick_start/readme.md index d29212b0..d1f3e1ec 100644 --- a/examples/c_examples/0.c_quick_start/readme.md +++ b/examples/c_examples/0.c_quick_start/readme.md @@ -61,4 +61,4 @@ Press 'ESC' key to stop the pipeline and exit the program. ### Result -![Quick_Start_C](/docs/resource/quick_start_c.jpg) +![Quick_Start_C](../../../docs/resource/quick_start_c.jpg) diff --git a/examples/c_examples/1.c_enumerate/README.md b/examples/c_examples/1.c_enumerate/README.md index 012512cb..c159fcdc 100644 --- a/examples/c_examples/1.c_enumerate/README.md +++ b/examples/c_examples/1.c_enumerate/README.md @@ -80,4 +80,4 @@ If you are on linux, you can switch to the directory `OrbbecSDK-dev/build/linux_ ### Result -![Enumerate_C](/docs/resource/enumerate.jpg) +![Enumerate_C](../../../docs/resource/enumerate.jpg) diff --git a/examples/c_examples/2.c_depth/README.md b/examples/c_examples/2.c_depth/README.md index 45a800e7..bad10f68 100644 --- a/examples/c_examples/2.c_depth/README.md +++ b/examples/c_examples/2.c_depth/README.md @@ -112,4 +112,4 @@ Press 'ESC' key to stop the pipeline and exit the program. ### Result -![Quick_Start_C](/docs/resource/quick_start_c.jpg) +![Quick_Start_C](../../../docs/resource/quick_start_c.jpg)