NiTE 2.0: nite::UserTrackerFrameRef Class Reference

Default Constructor. Creates an empty UserTrackerFrameRef.

Destructor. Frees the resources used by a UserTrackerFrameRef.

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

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.

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.

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.

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.

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

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.

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.

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

Returns:

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

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.

Impliments the assignment operator for the UserTrackerFrameRef.

Parameters:

[in]

other

A UserTrackerFrameRef to be assigned to this one.

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.