NiTE 2.0: nite::Skeleton Class Reference

NiTE 2.0

nite::Skeleton Class Reference

#include <NiTE.h>

Inheritance diagram for nite::Skeleton:

List of all members.

Public Member Functions

const SkeletonJointgetJoint (JointType type) const
SkeletonState getState () const

Detailed Description

This is the main class for the skeleton algorithm.

The purpose of the skeleton algorithm is to analyze a user outline supplied by the User Tracker algorithm, and to locate the position of that user's joints in space (eg knees, elbows, head, etc). The orientation of the user's joints is also calculated. Where joints are not visible, the algorithm will make a best guess about the joint. For all data calculated, confidence values are also created to help an application understand if the algorithm is sure about the data, or if it is "guessing".

Nite offers two types of skeletons algorithms. One requires the user to assume a specific "calibration pose" before calibration can be attempted. The other does not require a specific pose from the user, but will require a few seconds to settle down as it learns a user's body shape. The algorithm used sometimes depends on the platform being used -- for example, the ARM version of Nite currently only offers the version that requires a calibration pose.

All skeleton joint positions are given in "real world" data coordinates, using the same conventions as OpenNI 2.0. See the online documentation for OpenNI 2.0 for more information on the coordinate systems used with the skeleton.

See also:
SkeletonJoint for the output data format of the skeleton.
JointType enumeration for a list of all joints detected by the skeleton.
UserTracker to understand where the input data to the skeleton comes from.
SkeletonState enumeration for a list of possible skeleton states.

Member Function Documentation

const SkeletonJoint& nite::Skeleton::getJoint ( JointType  type) const [inline]

Get a specific joint of the skeleton. The object returned by this function can be queried to determine position, orientation, and confidence values for the joint.

[in]typeThe type of the joint to retrieve from the skeleton.
Pointer to a SkeletonJoint containing the requested data.
See also:
JointType for a list of possible joints to request from the skeleton.
SkeletonState nite::Skeleton::getState ( ) const [inline]

Get the state of the skeleton. This is useful for determining whether an active skeleton exists, and whether it is calibrating. Some of the states are also error conditions that attempt to provide a hint about why the skeleton is not calibrating. This can be useful for providing feedback to a user about where they need to stand, assuming a calibration pose, etc.

Current state of the skeleton.
See also:
SkeletonState enumeration for a list of possible states

The documentation for this class was generated from the following file:
Generated on Thu Jun 6 2013 17:48:15 for NiTE 2.0 by   doxygen