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

Description

Set an existing metada into the given acquisition and (optionally) return an updated list of the metadata.

Syntax:
md = btkSetMetaData(h, label, sublabel, ..., info)
Parameters
hHandle pointing to a C++ btk::Acquisition object.
labelString representing a metadata's label in the metadata's root.
sublabelString representing a metadata's label contained in the metadata with the label label.
...Others strings to point on the desired metadata with any level of depth
infoStructure with the field format and values (see note #1).
  • info.format: contains a string (Char, Byte, Integer or Real) corresponding to format of the information.
  • info.values: contains an array of numerical values or a cell of strings.
    • The array is used for information with the format Byte, Integer or Real.
    • The cell of strings is only use for information with the format Char.
Return values
mdStructure with the same format than the function btkGetMetaData.
Detailed description:
In case you are not sure the metadata to set does exist you can use instead the method btkAppendMetaData. This last method is able to set new information if the metadata exists or will create a new one. btkSetMetaData(h, label, sublabel, ..., info) sets a metadata with additional informations INFO corresponding to the metadata's values.

Remark: The number of sub-level is infinite. However, the main common use of the metadata is to use label as a group and sublabel as a parameter. So the metadata has only 2 levels. This use was introduced in the C3D format.

Note #1: The structure info should be build by using the function btkMetaDataInfo.
See Also
btkAppendMetaData, btkClearMetaData, btkFindMetaData, btkGetMetaData, btkRemoveMetaData