BTK Matlab Wrapper  0.3dev.0
Matlab bindings for the Biomechanical ToolKit library (BTK)
btkSetMetaDataLabel Class Reference

Description

Set a metadata's label.

Syntax:
md = btkSetMetaDataLabel(h, idx, newlabel)
md = btkSetMetaDataLabel(h, idx, subidx, newlabel)
md = btkSetMetaDataLabel(h, idx, subidx, ..., newlabel)
md = btkSetMetaDataLabel(h, label, newlabel)
md = btkSetMetaDataLabel(h, label, sublabel, newlabel)
md = btkSetMetaDataLabel(h, label, sublabel, ..., newlabel)
Parameters
hHandle pointing to a C++ btk::Acquisition object.
idxInteger specifying the index of a metadata.
subidxInteger specifying the index of a metadata.
labelString specifying the label of a metadata.
sublabelString specifying the label of a metadata.
...Others integers and/or strings to select the metadata to remove.
newlabelString with the new label.
Return values
mdStructure with the same format than the function btkGetMetaData.
Detailed description:
Warning: Renaming some metadata might alter an acquisition. For example, renaming the metadata FORCE_PLATFORM has for effect to not be able to extract force platform data as it contains their geometrical informations.

btkSetMetaDataLabel(h, idx, newlabel) sets the label of the metadata with the index idx contained in the root. btkSetMetaDataLabel(h, idx, subidx, newlabel) sets the label of the metadata with the index subidx contained in the metadata with the index idx. btkSetMetaDataLabel(h, idx, subidx, ..., newlabel) sets the label of any metadata specified by the gives indices. btkSetMetaDataLabel(h, label, newlabel) sets the label of the metadata with the label label contained in the root. btkSetMetaDataLabel(h, label, sublabel, newlabel) sets the label of the metadata with the label sublabel contained in the metadata with the label label. btkSetMetaDataLabel(h, label, sublabel, ..., newlabel) sets the label of any metadata specified by the given labels.

You can mix label and index to set the label of a metadata entry.

The number of sub-level is infinite. However, the main common use of the metadata is to use 2 levels. This use was introduced in the C3D format.
See Also
btkSetMetaDataDescription, btkSetMetaDataDimensions, btkSetMetaDataFormat, btkSetMetaDataUnlock, btkSetMetaDataValue