Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jrterven committed Oct 25, 2020
1 parent 214602e commit c769a39
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 6 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# KinZ for Matlab, A library for Azure Kinect
At the time of this writing, there are no official Matlab bindings for Azure Kinect.
This library allows using Azure Kinect directly in Matlab.


## Installation:
First install the Azure Kinect SDK as described [here](https://github.com/microsoft/Azure-Kinect-Sensor-SDK/blob/develop/docs/usage.md).

Then set the compiler for Matlab as shown [here](https://www.mathworks.com/help/matlab/matlab_external/choose-c-or-c-compilers.html)

Run the compile_cpp_files.m

## Demos
Inside demos directory, you'll find demos showing all the features of the library.
Currently, there are only 5 demos:
- **videoDemo**: shows how to get color, depth IR, and IMU sensors.
- **calibrationDemo**: shows how to extract camera calibration values.
- **pointcloudDemos**: shows how to get the colored pointcloud and visualize it.
- **bodyTrackingDemo**: shows how to get body tracking information and visualize it.

3 changes: 0 additions & 3 deletions README.txt

This file was deleted.

7 changes: 4 additions & 3 deletions compile_cpp_files.m
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
function compile_cpp_files
% compile_cpp_files compiles the Kin2 toolbox.
% The C++ code is located in 6 files:
% The C++ code is located in 3 files:
% KinZ.h: KinZ class definition.
% KinZ_base.cpp: KinZ class implementation of the base functionality including body data.
% KinZ_mapping.cpp: KinZ class implementation of the mapping functionality
% KinZ_mex.cpp: MexFunction implementation.
%
% Requirements:
% - Kinect for Azure SDK
% - A C++ compiler
% - Matlab 2013a or newer
%
% Author: Juan R. Terven, [email protected]
% Authors:
% Juan R. Terven, [email protected]
% Diana M. Cordova, [email protected]
IncludePath = '/usr/bin/';
LibPath = '/usr/bin/';

Expand Down
19 changes: 19 additions & 0 deletions compile_cpp_files.m~
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
function compile_cpp_files
% compile_cpp_files compiles the Kin2 toolbox.
% The C++ code is located in 6 files:
% KinZ.h: KinZ class definition.
% KinZ_base.cpp: KinZ class implementation of the base functionality including body data.
% KinZ_mex.cpp: MexFunction implementation.
%
% Requirements:
% - Kinect for Azure SDK
% - A C++ compiler
% - Matlab 2013a or newer
%
% Author: Juan R. Terven, [email protected]
IncludePath = '/usr/bin/';
LibPath = '/usr/bin/';

cd Mex
mex ('-compatibleArrayDims', '-v', 'KinZ_mex.cpp', 'KinZ_base.cpp', ...
['-L' LibPath],'-l:libk4a.so.1.3', '-l:libk4abt.so.1.0' ,['-I' IncludePath]);

0 comments on commit c769a39

Please sign in to comment.