Scripting API

btkSetMetaDataValue

Module BTKMetaDataModifier

Description#

Sets one metadata's value.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
labelString specifying the label of a metadata.
sublabelString specifying the label of a metadata.
newvalueNew value (depending the metadata, it can be a real or a string).

Returned Values#

mdstructure with the same format than the function btkGetMetaData

Detailed Description#

  • btkSetMetaDataValue(h, label, index, newvalue) sets the value at the index index for the metadata with the label label contained in the root.
  • btkSetMetaDataValue(h, label, sublabel, index, newvalue) sets the value at the index index for the metadata with the label sublabel contained in the metadata with the label label.
Based on the format of the metadata, the value set is automaticaly converted to fit the format. This design gives you the possibiliy to pass a Matlab native number format (double) or a char or a cell containing a char and then its content is converted. You can mix label and index to set a specific value of a metadata entry. Based on the format of the metadata, the value set is automaticaly converted to fit the format. This design gives you the possibiliy to pass a Matlab native number format (double) or a char or a cell containing a char and then its content is converted. 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.

Notes#

See also#

btkSetMetaDataDimensions

Syntax#

md = btkSetMetaDataValue(h, label, index, newvalue)
md = btkSetMetaDataValue(h, label, sublabel, index, newvalue)

Examples#