nite::UserMap Class Reference

#include <NiTE.h>

Inheritance diagram for nite::UserMap:

[legend]

List of all members.

Public Member Functions
int	getHeight () const
const UserId *	getPixels () const
int	getStride () const
int	getWidth () const
Friends
class	UserTrackerFrameRef

---

Detailed Description

This class stores the output from the nite::UserTracker algorithm.

The basic purpose of the User Tracker algorithm is to analyze a depth frame and to locate all users in the scene, to indicate which pixels belong to which user, and which pixels belong to the background.

The output is in the form of a two dimensional array with the same dimensions as the depth frame that was used as the input to UserTracker. Each element of the array corresponds to a single pixel from the depth map, and indicates the UserID of the user which occupies that pixel.

The UserId value 0 is used to indicate pixels that contain no users (ie background).

See also:

UserTracker for more information about this algorithm.

---

Member Function Documentation

int nite::UserMap::getHeight

(

)

const [inline]

Gets the height of the UserMap array. This value will match the Y resolution of the depth map that was used to create the UserMap. This value can be used, along with the value returned by getStride() to determine the size of the array in bytes.

Returns:

Height of the UserMap, measured in pixels.

const UserId* nite::UserMap::getPixels

(

)

const [inline]

Returns a direct pointer to the array containing the UserMap data. This array has type UserID, and a size equal to y*stride. If your application needs to calculate the size value directly, then see UserMap::getHeight() and UserMap::getStride().

Returns:

Pointer directly to the array data

int nite::UserMap::getStride

(

)

const [inline]

This function returns the stride of the array returned by getPixels. The stride of the array is defined as the width of a single row of that array, measured in bytes. This value can be multiplied by the value returned by getHeight() to calculate the size of the array.

Returns:

Stride of the array, measured in bytes.

int nite::UserMap::getWidth

(

)

const [inline]

Gets the width of the UserMap array. This value will match the X resolution of the depth map that was used to create the UserMap.

Returns:

Width of the UserMap, measured in pixels.

---

Friends And Related Function Documentation

friend class UserTrackerFrameRef [friend]

---

The documentation for this class was generated from the following file:

• NiTE.h