C3d labelling of subjects

Classes
struct	UuIcsC3d::ConstNameRange
	A range of strings with const access only. More...
struct	UuIcsC3d::MarkerNames
	Abstract class for describing labels of a subject. More...
struct	UuIcsC3d::SkeletonInfo
	Abstract class for describing skeletons. More...
struct	UuIcsC3d::LabeledSubject
	A LabeledSubject is a subject with a name for which the markers are linked to a label index (or point index). More...
struct	UuIcsC3d::LabeledSkeleton
	A LabeledSkeleton is a subject with a name for which the markers of a skeleton are linked to a label index (or point index). More...
Functions
std::vector< unsigned >	UuIcsC3d::fill_subjects (std::vector< LabeledSubject > &subjects, std::vector< SpacePaddedString > const &labels, MarkerNames const &marker_names)
std::vector< unsigned >	UuIcsC3d::fill_skeletons (std::vector< LabeledSkeleton > &subjects, std::vector< SpacePaddedString > const &labels, SkeletonInfo const &skel_info)

---

Detailed Description

The Vicon C3d files use a convention for assigning labels to subjects. A label consists of a subject name followed by a colon followed by a marker name. For instance, there may be labels Tom:lasi, Tom:rasi and Tim:lasi. That would indicate a subject Tom with labels lasi an rasi and a subject Tim with label lasi. The two main functions in this modules are fill_subjects and fill_skeletons. The second deals with skeletons. Skeletons provide more structure: the markers are grouped>

---

Function Documentation

std::vector<unsigned> UuIcsC3d::fill_skeletons	(	std::vector< LabeledSkeleton > &	subjects,
		std::vector< SpacePaddedString > const &	labels,
		SkeletonInfo const &	skel_info
	)

Expects a number of labels in Vicon style (subject name followed by colon followed by the marker name). Extracts a number of LabeledSkeleton objects from that info.

Parameters:

subjects	the resulting LabeledSkeleton objects.
labels	the labels (SpacePaddedString vector) as found in a c3d file.
skel_info	the expected names and structure of each skeleton.

Returns:

value contains the labels that could not be classified as a skel_info label. It contains indices in the labels vector.

std::vector<unsigned> UuIcsC3d::fill_subjects	(	std::vector< LabeledSubject > &	subjects,
		std::vector< SpacePaddedString > const &	labels,
		MarkerNames const &	marker_names
	)

Expects a number of labels in Vicon style (subject name followed by colon followed by the marker name). Extracts a number of LabeledSubject objects from that info.

Parameters:

subjects	the resulting subjects.
labels	the labels as found in a c3d file.
marker_names	the expected names of the markers.

Returns:

value contains the labels that could not be classified as a label_info label. It contains indices in the labels vector.