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_path	path to extract only the metadata and its children with the label sublabel from the metadata 'label'.
info	structure with the field format and values (see note #1).

Returned Values#

md	structure 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_path, 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 structure info should be build by using the function btkMetaDataInfo.

See also#

btkAppendMetaData, btkClearMetaData, btkFindMetaData, btkGetMetaData, btkRemoveMetaData