nite::UserTrackerFrameRef Class Reference

#include <NiTE.h>

List of all members.

Public Member Functions
	UserTrackerFrameRef ()
	UserTrackerFrameRef (const UserTrackerFrameRef &other)
	~UserTrackerFrameRef ()
openni::VideoFrameRef	getDepthFrame ()
const Plane &	getFloor () const
float	getFloorConfidence () const
int	getFrameIndex () const
uint64_t	getTimestamp () const
const UserData *	getUserById (UserId id) const
const UserMap &	getUserMap () const
const Array< UserData > &	getUsers () const
bool	isValid () const
UserTrackerFrameRef &	operator= (const UserTrackerFrameRef &other)
void	release ()
Friends
class	User
class	UserTracker

---

Detailed Description

This class stores a snapshot of a single frame of output from the UserTracker algorithm. This frame will correspond to a single input depth frame. It holds all info on users, as well as information on the floor plane.

See also:

UserData For detailed info on specific users

Skeleton For user skeleton data

UserMap For user positions in the frame

UserTracker For information on starting the user tracker algorithms to detect all of this data.

HandTrackerFrameRef for the equivalent information when hand tracking.

---

Constructor & Destructor Documentation

nite::UserTrackerFrameRef::UserTrackerFrameRef

(

)

[inline]

Default Constructor. Creates an empty UserTrackerFrameRef.

nite::UserTrackerFrameRef::~UserTrackerFrameRef

(

)

[inline]

Destructor. Frees the resources used by a UserTrackerFrameRef.

nite::UserTrackerFrameRef::UserTrackerFrameRef

(

const UserTrackerFrameRef &

other

)

[inline]

Copy Constructor. Creates a new UserTrackerFrameRef identical to an existing one.

---

Member Function Documentation

openni::VideoFrameRef nite::UserTrackerFrameRef::getDepthFrame

(

)

[inline]

Get the raw depth frame that originated this output. Each UserTracker frame is generated to correspond with a single depth frame. This function gives you access to the raw frame data.

See the OpenNI 2.0 documentation for information on manipulating VideoFrameRef data.

Returns:

VideoFrameRef with the raw depth that generated this frame.

const Plane& nite::UserTrackerFrameRef::getFloor

(

)

const [inline]

Obtains an estimate of the floor plane of the scene currently in view.

Returns:

Plane that indicates a best guess of where the floor of the scene is.

See also:

getFloorConfidence() for a confidence value in this calculation.

float nite::UserTrackerFrameRef::getFloorConfidence

(

)

const [inline]

NiTE generates a confidence value between 0 and 1 for the floor plane calculation. Lower values indicate less confidence.

Returns:

Value between 0 and 1 indicating confidence in the accuracy of the floor plane

See also:

getFloor() to obtain the actual plane.

int nite::UserTrackerFrameRef::getFrameIndex

(

)

const [inline]

Gets the frame index of the raw depth frame that generated this UserTracker frame. Frame indexes are consequitive integer numbers assigned to frames by OpenNI. See the OpenNI documentation for more information.

Returns:

FrameIndex of the depth frame used to generate this User Tracker frame.

uint64_t nite::UserTrackerFrameRef::getTimestamp

(

)

const [inline]

Get the timestamp in which this frame was processed. See the OpenNI 2.0 documentation for more information on how OpenNI assigns time stamps to depth frames.

Returns:

Timestamp in microseconds

const UserData* nite::UserTrackerFrameRef::getUserById

(

UserId

id

)

const [inline]

Provides access to the UserData object for a specific user, indexed by UserId.

Parameters:

[in]

@ref

UserId The ID of the user you would like data from.

Returns:

Pointer to the corresponding UserData object.

See also:

UserData for the information contained in this object.

UserMap if what you really want is to know where in the image the user is.

const UserMap& nite::UserTrackerFrameRef::getUserMap

(

)

const [inline]

Get the segmentation of the scene. The UserTracker algorithm locates each user in the field of view, and figures out which pixels correrspond to which user, as well as which pixels correspond to the background (ie, not to any user).

Returns:

UserMap showing which pixels are occupied by what users.

const Array<UserData>& nite::UserTrackerFrameRef::getUsers

(

)

const [inline]

Get an Array of all the users available in this frame.

Returns:

Array of UserData with one entry for each user in this frame.

bool nite::UserTrackerFrameRef::isValid

(

)

const [inline]

Indicates whether this UserTrackerFrameRef points to valid frame data. When first constructed, the UserTrackerFrameRef will be invalid until assigned a frame handle.

Returns:

True if this object contains valid data, False otherwise.

UserTrackerFrameRef& nite::UserTrackerFrameRef::operator=

(

const UserTrackerFrameRef &

other

)

[inline]

Impliments the assignment operator for the UserTrackerFrameRef.

Parameters:

[in]

other

A UserTrackerFrameRef to be assigned to this one.

void nite::UserTrackerFrameRef::release

(

)

[inline]

Properly releases all resources used by this object. This will be automatically called by the destructor, but it is good practice to call this as soon as the object is no longer required. Calling this function multiple times on the same object is safe.

---

Friends And Related Function Documentation

friend class User [friend]

friend class UserTracker [friend]

---

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

• NiTE.h