btkSetMetaData

Module

BTKAcquisitionModifier

Description#

Sets an existing 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
...	Others strings to point on the desired metadata with any level of depth
info	dictionnary with the field

Returned Values#

md	dictionnary 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.

Notes#

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

See also#

btkAppendMetaData, btkClearMetaData, btkFindMetaData, btkGetMetaData, btkRemoveMetaData