docs(*): add code tree comments

This commit is contained in:
Messier 2019-09-06 17:20:45 +08:00
parent 950ee00920
commit 2a8a2e7713

View File

@ -1,8 +1,8 @@
mynt-eye-s-sdk mynt-eye-s-sdk
├── 3rdparty ├── 3rdparty
│   └── eigen3 │   └── eigen3 matrix 3rd lib
├── cmake ├── cmake
│   ├── Common.cmake │   ├── Common.cmake cmake common macro
│   ├── DetectCXX11.cmake │   ├── DetectCXX11.cmake
│   ├── DetectOpenCV.cmake │   ├── DetectOpenCV.cmake
│   ├── FindCUDA │   ├── FindCUDA
@ -11,14 +11,14 @@ mynt-eye-s-sdk
│   │   └── run_nvcc.cmake │   │   └── run_nvcc.cmake
│   ├── FindCUDA.cmake │   ├── FindCUDA.cmake
│   ├── IncludeGuard.cmake │   ├── IncludeGuard.cmake
│   ├── Option.cmake │   ├── Option.cmake include(DetectOpenCV.cmake)
│   ├── TargetArch.cmake │   ├── TargetArch.cmake
│   ├── templates │   ├── templates
│   └── Utils.cmake │   └── Utils.cmake include(Common.cmake)
├── CMakeLists.txt ├── CMakeLists.txt
├── docs ├── docs
│   ├── api │   ├── api
│   ├── conf.py │   ├── conf.py sdkHtml config
│   ├── files │   ├── files
│   ├── images │   ├── images
│   │   ├── firmware │   │   ├── firmware
@ -28,7 +28,7 @@ mynt-eye-s-sdk
│   │   ├── sdk │   │   ├── sdk
│   │   │   └── tools │   │   │   └── tools
│   │   └── tools │   │   └── tools
│   ├── Makefile │   ├── Makefile sdkHtml Makefile
│   └── src │   └── src
│   ├── firmware │   ├── firmware
│   ├── log │   ├── log
@ -43,51 +43,52 @@ mynt-eye-s-sdk
├── include ├── include
│   ├── deprecated │   ├── deprecated
│   │   └── mynteye │   │   └── mynteye
│   │   ├── api.h │   │   ├── api.h x
│   │   ├── callbacks.h │   │   ├── callbacks.h x
│   │   ├── context.h │   │   ├── context.h x
│   │   ├── device.h │   │   ├── device.h x
│   │   ├── files.h │   │   ├── files.h x
│   │   ├── glog_init.h │   │   ├── glog_init.h x
│   │   ├── object.h │   │   ├── object.h x
│   │   ├── plugin.h │   │   ├── plugin.h x
│   │   ├── strings.h │   │   ├── strings.h x
│   │   ├── times.h │   │   ├── times.h x
│   │   └── utils.h │   │   └── utils.h x
│   └── mynteye │   └── mynteye
│   ├── api │   ├── api
│   │   ├── api.h │   │   ├── api.h user api(mynteye.h types.h opencv2*)
│   │   ├── object.h │   │   ├── object.h img formats transform(mynteye.h opencv2*)
│   │   └── plugin.h │   │   └── plugin.h plugin process in&out(mynteye.h opencv2*)
│   ├── device │   ├── device
│   │   ├── callbacks.h │   │   ├── callbacks.h processor data callback(mynteye.h mynteye/types.h)
│   │   ├── context.h │   │   ├── context.h detect uvc device(mynteye.h)
│   │   ├── device.h │   │   ├── device.h imu-->motions & camera-->streams(mynteye.h callbacks.h device/types.h)
│   │   ├── types.h │   │   ├── types.h img & imu_data types(mynteye.h mynteye/types.h)
│   │   └── utils.h │   │   └── utils.h user help(mynteye.h mynteye/types.h)
│   ├── global.h │   ├── global.h os adapter
│   ├── logger.h │   ├── logger.h message output
│   ├── miniglog.h │   ├── miniglog.h google miniglog
│   ├── types.h │ ├── mynteye.h.in api version(global.h)
│   ├── types.h all types(mynteye.h)
│   └── util │   └── util
│   ├── files.h │   ├── files.h (mynteye.h)
│   ├── strings.h │   ├── strings.h (mynteye.h)
│   └── times.h │   └── times.h (mynteye.h)
├── Makefile ├── Makefile
├── samples ├── samples
│   ├── camera_with_junior_device_api.cc │   ├── camera_with_junior_device_api.cc (device.h utils.h times.h)
│   ├── camera_with_senior_api.cc │   ├── camera_with_senior_api.cc (api.h times.h)
│   ├── CMakeLists.txt │   ├── CMakeLists.txt samples build
│   ├── config │   ├── config
│   │   ├── S1030 │   │   ├── S1030
│   │   │   └── deprecated │   │   │   └── deprecated
│   │   └── S210A │   │   └── S210A
│   │   └── deprecated │   │   └── deprecated
│   ├── ctrl_auto_exposure.cc │   ├── ctrl_auto_exposure.cc (api.h)
│   ├── ctrl_framerate.cc │   ├── ctrl_framerate.cc (api.h times.h)
│   ├── ctrl_iic_address.cc │   ├── ctrl_iic_address.cc (api.h)
│   ├── ctrl_imu_low_pass_filter.cc │   ├── ctrl_imu_low_pass_filter.cc (api.h times.h)
│   ├── ctrl_imu_range.cc │   ├── ctrl_imu_range.cc (api.h times.h)
│   ├── ctrl_infrared.cc │   ├── ctrl_infrared.cc
│   ├── ctrl_manual_exposure.cc │   ├── ctrl_manual_exposure.cc
│   ├── ctrl_sync_timestamp.cc │   ├── ctrl_sync_timestamp.cc
@ -111,20 +112,20 @@ mynt-eye-s-sdk
│   ├── record.cc │   ├── record.cc
│   ├── save_all_infos.cc │   ├── save_all_infos.cc
│   ├── save_single_image.cc │   ├── save_single_image.cc
│   ├── simple_demo │   ├── simple_demo independent demo
│   │   ├── project_cmake │   │   ├── project_cmake
│   │   │   ├── CMakeLists.txt │   │   │   ├── CMakeLists.txt linux build
│   │   │   └── mynteye_demo.cc │   │   │   └── mynteye_demo.cc
│   │   └── project_vs2017 │   │   └── project_vs2017 windows vs
│   │   ├── images │   │   ├── images
│   │   └── mynteyes_demo │   │   └── mynteyes_demo
│   │   └── mynteyes_demo │   │   └── mynteyes_demo
│   │   ├── stdafx.h │   │   ├── stdafx.h
│   │   └── targetver.h │   │   └── targetver.h
│   ├── util_cv.cc │   ├── util_cv.cc (util_cv.h device/utils.h)
│   ├── util_cv.h │   ├── util_cv.h cv painter(mynteye/types.h)
│   ├── util_pcl.cc │   ├── util_pcl.cc (util_pcl.h)
│   ├── util_pcl.h │   ├── util_pcl.h pcl cloud points viewer
│   ├── uvc_camera.cc │   ├── uvc_camera.cc
│   ├── write_device_info.cc │   ├── write_device_info.cc
│   ├── write_img_params.cc │   ├── write_img_params.cc
@ -141,43 +142,43 @@ mynt-eye-s-sdk
│   ├── main.cc │   ├── main.cc
│   └── mynteye │   └── mynteye
│   ├── api │   ├── api
│   │   ├── api.cc │   │   ├── api.cc (correspondence.h dl.h plugin.h ...)
│   │   ├── camera_models │   │   ├── camera_models
│   │   │   ├── camera.cc │   │   │   ├── camera.cc (camera.h)
│   │   │   ├── camera.h │   │   │   ├── camera.h camera base(eigen3* opencv2* mynteye.h)
│   │   │   ├── equidistant_camera.cc │   │   │   ├── equidistant_camera.cc (equidistant_camera.h)
│   │   │   ├── equidistant_camera.h │   │   │   ├── equidistant_camera.h KB projection model(opencv2* camera.h)
│   │   │   ├── gpl.cc │   │   │   ├── gpl.cc
│   │   │   └── gpl.h │   │   │   └── gpl.h
│   │   ├── correspondence.cc │   │   ├── correspondence.cc (correspondence.h device.h)
│   │   ├── correspondence.h │   │   ├── correspondence.h stream control(api.h callbacks.h)
│   │   ├── data_tools.cc │   │   ├── data_tools.cc (data_tools.h)
│   │   ├── data_tools.h │   │   ├── data_tools.h api<--data<-->obj(object.h api.h device.h)
│   │   ├── dl.cc │   │   ├── dl.cc (dl.h)
│   │   ├── dl.h │   │   ├── dl.h dynamic loading(mynteye.h)
│   │   ├── processor │   │   ├── processor root-->rectify-->disparity(norm)-->depth-->points
│   │   │   ├── depth_processor.cc │   │   │   ├── depth_processor.cc (depth_Processor.h)
│   │   │   ├── depth_processor.h │   │   │   ├── depth_processor.h (processor.h types.h rectify_processor.h)
│   │   │   ├── depth_processor_ocv.cc │   │   │   ├── depth_processor_ocv.cc (depth_processor_ocv.h)
│   │   │   ├── depth_processor_ocv.h │   │   │   ├── depth_processor_ocv.h output cv::Mat(processor.h)
│   │   │   ├── disparity_normalized_processor.cc │   │   │   ├── disparity_normalized_processor.cc (opencv2* disparity_normalized_processor.h)
│   │   │   ├── disparity_normalized_processor.h │   │   │   ├── disparity_normalized_processor.h (processor.h)
│   │   │   ├── disparity_processor.cc │   │   │   ├── disparity_processor.cc (opencv2* disparity_processor.h)
│   │   │   ├── disparity_processor.h │   │   │   ├── disparity_processor.h (mynteye/types.h processor.h)
│   │   │   ├── points_processor.cc │   │   │   ├── points_processor.cc (opencv2* points_processor.h)
│   │   │   ├── points_processor.h │   │   │   ├── points_processor.h (mynteye/types.h processor.h)
│   │   │   ├── points_processor_ocv.cc │   │   │   ├── points_processor_ocv.cc
│   │   │   ├── points_processor_ocv.h │   │   │   ├── points_processor_ocv.h
│   │   │   ├── rectify_processor.cc │   │   │   ├── rectify_processor.cc (opencv2* rectify_processor.h)
│   │   │   ├── rectify_processor.h │   │   │   ├── rectify_processor.h (equidistant_camera.h ...)
│   │   │   ├── rectify_processor_ocv.cc │   │   │   ├── rectify_processor_ocv.cc
│   │   │   ├── rectify_processor_ocv.h │   │   │   ├── rectify_processor_ocv.h
│   │   │   ├── root_camera_processor.cc │   │   │   ├── root_camera_processor.cc (opencv2* synthetic.h device.h data_tools.h)
│   │   │   └── root_camera_processor.h │   │   │   └── root_camera_processor.h (opencv2* processor.h)
│   │   ├── processor.cc │   │   ├── processor.cc (strings.h times.h data_tools.h)
│   │   ├── processor.h │   │   ├── processor.h processor base(synthetic.h mynteye.h object.h)
│   │   ├── synthetic.cc │   │   ├── synthetic.cc (*processor.h object.h plugin.h device.h data_tools.h)
│   │   ├── synthetic.h │   │   ├── synthetic.h synthetic pipeline(api.h)
│   │   ├── version_checker.cc │   │   ├── version_checker.cc
│   │   └── version_checker.h │   │   └── version_checker.h
│   ├── device │   ├── device