btkAppendMetaData

Module

BTKAcquisitionModifier

Description#

Appends a new metada into the given acquisition and (optionally) returns an updated list of the metadata.

Parameters#

h	Handle pointing to a C++ btk::Acquisition object.
label	String representing a metadata's label in the metadata's root.
sublabel	String representing a metadata's label contained in the metadata with the label
info	dictionnary with the field format and values (see note #1).

Returned Values#

md	dictionnary with the same format than the function btkGetMetaData

Detailed Description#

• btkAppendMetaData(h, label, sublabel, info) appends 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.

Notes#

Note #1: The dictionnary info should be build by using the function btkMetaDataInfo.

• 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.

See also#

btkClearMetaData, btkFindMetaData, btkGetMetaData, btkRemoveMetaData, btkSetMetaData