add appendix

XinArkh · Jul 21, 2019 · 34a56db · 34a56db
1 parent 0797f31
commit 34a56db
Show file tree

Hide file tree

Showing 12 changed files with 152 additions and 11 deletions.
diff --git a/docs/SDKInstallation.rst b/docs/SDKInstallation.rst
@@ -0,0 +1,47 @@
+Kinect 环境配置
+===================
+
+
+.. _install:
+
+Kinect v1.8 SDK
+-------------------
+
+- 微软官方 SDK 下载页面：\ `Kinect for Windows SDK v1.8 <https://www.microsoft.com/en-us/download/details.aspx?id=40278>`_ (222MB)
+- 微软官方 ToolKit 下载页面：\ `Kinect for Windows Developer Toolkit v1.8 <https://www.microsoft.com/en-us/download/details.aspx?id=40276>`_ (384MB)
+
+在上面两个页面下载并安装 Kinect SDK 和 ToolKit 的安装包，完成后连接 Kinect 设备，检查设备管理器，能够看到 Kinect 设备即为安装成功。
+
+.. image:: images/env_ins/kinect1device.jpg
+
+.. note::
+
+    安装过程中 Kinect 设备\ **不要连接电脑**\ 。
+
+另外，查看系统环境变量，会发现 Kinect SDK 所在路径也被添加到了系统变量，在配置 Visual Studio 项目时可以直接引用。
+
+.. image:: images/env_ins/path.jpg
+
+开发包附带了一些软件，其中 Developer Toolkit Browser v1.8 中提供了一些资料和例程，可以运行玩一玩。
+
+.. image:: images/env_ins/browser-1.jpg
+
+.. image:: images/env_ins/browser-2.jpg
+
+
+.. _install-2:
+
+Kinect v2.0 SDK
+-------------------
+
+微软官方 SDK 下载页面：\ `Kinect for Windows SDK 2.0 <https://www.microsoft.com/en-us/download/details.aspx?id=44561>`_ (276MB)
+
+在上面的页面下载并安装 Kinect SDK 的安装包，完成后连接 Kinect 设备，检查设备管理器，能够看到 Kinect 设备即为安装成功。
+
+.. note::
+
+    安装过程中 Kinect 设备\ **不要连接电脑**\ 。
+
+查看系统环境变量，会发现 Kinect SDK 所在路径也被添加到了系统变量，在配置 Visual Studio 项目时可以直接引用。
+
+开发包附带了一些软件，其中 SDK Browser v2.0 中提供了一个自检程序 Kinect Configuration Verifier，可以检查 Kinect 是否连接成功。除此之外还提供了一些资料和例程，可以运行玩一玩。
diff --git a/docs/about.rst b/docs/about.rst
@@ -0,0 +1,14 @@
+关于
+=======
+
+
+原（英文）文档作者
+---------------------
+
+Edward Zhang <edzhang@cs.washington.edu> `@Edilogues <http://ed.ilogues.com/>`_
+
+
+本文档作者
+------------
+
+Wu Hsin `@XinArkh <https://github.com/XinArkh>`_
diff --git a/docs/comparison.rst b/docs/comparison.rst
@@ -0,0 +1,22 @@
+Kinect 型号比较
+======================
+
+
+参考博客
+-----------
+
+- \ `Kinect for Xbox 360与Kinect for Windows的区别 <https://blog.csdn.net/zhaiyujia15195383763/article/details/80948714>`_\ 
+
+- \ `Kinect v1和Kinect v2的彻底比较 <https://www.cnblogs.com/TracePlus/p/4136297.html>`_\ 
+
+- \ `KinectV2的精度和与V1的对比 <http://brightguo.com/kinectv2-accuracy/>`_\ 
+
+- \ `关于kinect v2性能分析的一些论文 <https://blog.csdn.net/jiaojialulu/article/details/52858268>`_\ 
+
+
+参考论文
+------------
+
+- Zennaro S, Munaro M, Milani S, et al. Performance evaluation of the 1st and 2nd generation Kinect for multimedia applications[C]//2015 IEEE International Conference on Multimedia and Expo (ICME). IEEE, 2015: 1-6.
+
+- Yang L, Zhang L, Dong H, et al. Evaluating and improving the depth accuracy of Kinect for Windows v2[J]. IEEE Sensors Journal, 2015, 15(8): 4275-4285.
diff --git a/docs/docs.rst b/docs/docs.rst
@@ -0,0 +1,22 @@
+Kinect 开发文档
+===================
+
+
+Kinect v1 开发文档
+-----------------------
+
+目前微软官网已彻底删除了 Kinect for Windows SDK v1 的文档资料。替代办法是通过网页快照存档网站 Wayback Machine 来查阅\ `官方文档的历史快照 <https://web.archive.org/web/20130906183129/http://msdn.microsoft.com/en-us/library/hh855347.aspx>`_\ 。
+
+几个时间节点：
+
+- 微软官网最后发布的一代 Kinect SDK 版本号为 1.8.0.595，发布日期为 2013 年 9 月 13 日，在此之后文档更新应基本停止。
+- 2014 年 10 月微软发布第二代 Kinect for Windows。
+- 微软官网大约在 17 年至 18 年前后彻底撤掉了 Kinect SDK v1 文档的存档，网页快照不再记录。
+
+另外，网页快照的抓取时间是有一定随机性的，有时一些页面可以查看，但另一些页面可能会报错，对于报错的情况，可以换一个时间节点查看。
+
+
+Kinect v2 开发文档
+----------------------
+
+\ `微软官方文档存档 <https://docs.microsoft.com/en-us/previous-versions/windows/kinect/dn799271(v=ieb.10)>`_\ 
diff --git a/docs/images/env_ins/browser-1.jpg b/docs/images/env_ins/browser-1.jpg
diff --git a/docs/images/env_ins/browser-2.jpg b/docs/images/env_ins/browser-2.jpg
diff --git a/docs/images/env_ins/kinect1device.jpg b/docs/images/env_ins/kinect1device.jpg
diff --git a/docs/images/env_ins/path.jpg b/docs/images/env_ins/path.jpg
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,13 +15,13 @@ Kinect 中文教程
 
 .. image:: ./images/kinectv1.png
 
-- 基于 **Kinect v2 SDK** 的基础操作，适用于采用 Time of Flight (TOF) 深度感知方式的 Kinect 传感器，即 **XBox One Kinect**\ 。
+- 基于 **Kinect v2.0 SDK** 的基础操作，适用于采用 Time of Flight (TOF) 深度感知方式的 Kinect 传感器，即 **XBox One Kinect**\ 。
 
 .. image:: ./images/kinectv2.jpg
 
 基本原则
 ===========
-在把玩了一阵子 Kinect 之后，作者发现很多资料都残缺不全。作为一份（给后来者）的参考，本教程应运而生。以下是本教程的指导原则：
+在把玩过一阵子 Kinect 之后，作者发现很多资料都残缺不全。作为一份（给后来者）的参考，本教程应运而生。以下是本教程的指导原则：
 
 - **如无必要，勿费口舌** - 本教程主要侧重于如何使用各种 API。对于其余的窗口创建和显示部分，将会在简单概括后略过。如果你想要深入学习 OpenGL、C++ 等知识，可以去寻找这些方面更加专业的教程。这里不会同时精讲三种 API 和一种语言，这只会让人更加糊涂。
 - **精炼代码，主次分明** - 教程中的代码刚好能够让它工作，其余部分基本会忽略。为了避免头文件过多带来的混乱，一部分代码结构会被牺牲，这样你可以专注于相关的功能。
@@ -45,7 +45,7 @@ Kinect 中文教程
 
 .. toctree::
    :maxdepth: 2
-   :caption: Kinect v2 C++ SDK 基础教程
+   :caption: Kinect v2.0 C++ SDK 基础教程
    :numbered:
 
    kinect2/0_Setup
@@ -55,6 +55,21 @@ Kinect 中文教程
    kinect2/4_SkeletalTracking
 
 
+.. toctree::
+   :maxdepth: 2
+   :caption: 附录
+
+   SDKInstallation
+   docs
+   comparison
+   about
+
+.. note::
+
+    附录部分是译者整理的相关资料，作为补充和参考。
+
+
+
 索引
 =====
 

diff --git a/docs/kinect1/0_Setup.rst b/docs/kinect1/0_Setup.rst
@@ -1,11 +1,21 @@
+.. _setup:
+
 准备工作
 ============
 
 
+.. note::
+
+    **这一部分教程是针对第一代 Kinect 的。**\ 你的 Kinect 是第二代的吗？来看 :ref:`Kinect v2.0 教程 <setup-2>`\ 吧！
+
 本系列教程适用于希望使用微软 Kinect SDK 的 C++ 程序员。教程将尽量精简 Windows 代码。我们将使用 OpenGL 提供图形化操作。
 
 :目标: 本章将使用正确的配置初始化一个 Visual Studio 项目。确保你拥有 Kinect 编程所需要的所有组件。
 
+.. note::
+
+    **译者注**\ ：在本章开始之前，确保 Kinect SDK 已顺利安装，可参考\ :ref:`附录 <install>`\ 。
+
 
 环境需求
 -----------

diff --git a/docs/kinect1/1_Basics.rst b/docs/kinect1/1_Basics.rst
@@ -113,21 +113,22 @@ Kinect 初始化
 
 .. note::
 
-    **译者注**：在这里忍不住要对微软说句脏话，旧版 Kinect 下架之后连文档也没有留下，目前的官网的过期版本存档中保存的是 `Kinect for Windows SDK 2.0 版本 <https://docs.microsoft.com/en-us/previous-versions/windows/kinect/dn799271(v=ieb.10)>`_\ ，SDK v1 部分已经被完全移除，所以\ **上面提供的两个官网链接其实都是打不开的**\ 。
+    **译者注**：在这里忍不住要对微软说句脏话，旧版 Kinect 下架之后连文档也清理得一干二净。目前的官网的过期版本存档中保存的是 `Kinect for Windows SDK 2.0 版本 <https://docs.microsoft.com/en-us/previous-versions/windows/kinect/dn799271(v=ieb.10)>`_\ ，SDK v1 部分已经被完全移除，所以\ **上面提供的两个官网链接其实都是打不开的**\ 。
 
-    译者经过多方搜索，在这里提供一个聊胜于无的 SDK v1 文档查阅途径，即通过网页快照存档网站 `Wayback Machine <http://web.archive.org/>`_ 来查阅\ `官网的历史快照 <https://web.archive.org/web/20121005145349/http://msdn.microsoft.com/en-us/library/hh855347.aspx>`_\ 。
+    译者经过多方搜索，在这里提供一个聊胜于无的 SDK v1 文档查阅途径，即通过网页快照存档网站 Wayback Machine 来查阅\ `官方文档的历史快照 <https://web.archive.org/web/20130906183129/http://msdn.microsoft.com/en-us/library/hh855347.aspx>`_\ 。
 
     举个例子，上面提到的打不开的两个页面，在网页快照中分别如下：
 
-    - `官方 API 的网页快照 <https://web.archive.org/web/20120915103909/http://msdn.microsoft.com/en-us/library/hh855368#NUI_INITIALIZE>`_\ 
-    - `官方文档的网页快照 <https://web.archive.org/web/20120528191325/http://msdn.microsoft.com/en-us/library/nuiimagecamera.nuiimagestreamopen>`_\ 
+    - \ ``NuiInitialize()``\ 方法\ `官方 API 的网页快照 <https://web.archive.org/web/20120915103909/http://msdn.microsoft.com/en-us/library/hh855368#NUI_INITIALIZE>`_\ 
+    - \ ``NuiImageStreamOpen()``\ 方法\ `官方文档的网页快照 <https://web.archive.org/web/20120528191325/http://msdn.microsoft.com/en-us/library/nuiimagecamera.nuiimagestreamopen>`_\ 
 
-    两个时间节点：
+    几个时间节点：
 
-    - 2014 年 10 月微软发布第二代 Kinect for Windows，此时 Kinect SDK v1.8 应已处于稳定阶段。
-    - 微软官网大约在 17 年至 18 年前后撤掉了 Kinect SDK v1 部分的文档，在此之前的网页快照中是存在 SDK v1 文档的。
+    - 微软官网最后发布的一代 Kinect SDK 版本号为 1.8.0.595，发布日期为 2013 年 9 月 13 日，在此之后文档更新应基本停止。
+    - 2014 年 10 月微软发布第二代 Kinect for Windows。
+    - 微软官网大约在 17 年至 18 年前后彻底撤掉了 Kinect SDK v1 文档的存档，网页快照不再记录。
 
-    另外还需注意，网页快照的抓取时间是有一定随机性的，有时一些页面可以查看，但另一些页面可能会报错，对于报错的情况，可以换一个时间节点再试。
+    另外还需注意，网页快照的抓取时间是有一定随机性的，有时一些页面可以查看，但另一些页面可能会报错，对于报错的情况，可以换一个时间节点查看。
 
 
 从 Kinect 中获取 RGB 帧

diff --git a/docs/kinect2/0_Setup.rst b/docs/kinect2/0_Setup.rst
@@ -1,11 +1,21 @@
+.. _setup-2:
+
 准备工作
 ============
 
 
+.. note::
+
+    **这一部分教程是针对第二代 Kinect 的。**\ 你的 Kinect 是第一代的吗？来看 :ref:`Kinect v1.8 教程 <setup>`\ 吧！
+
 本系列教程适用于希望使用微软 Kinect SDK 的 C++ 程序员。教程将尽量精简 Windows 代码。我们将使用 OpenGL 提供图形化操作。
 
 :目标: 本章将使用正确的配置初始化一个 Visual Studio 项目。确保你拥有 Kinect 编程所需要的所有组件。
 
+.. note::
+
+    **译者注**\ ：在本章开始之前，确保 Kinect SDK 已顺利安装，可参考\ :ref:`附录 <install-2>`\ 。
+
 
 环境需求
 -----------