Description

Set a metadata's description.

Syntax:: md = btkSetMetaDataDescription(h, idx, newdesc) md = btkSetMetaDataDescription(h, idx, subidx, newdesc) md = btkSetMetaDataDescription(h, idx, subidx, ..., newdesc) md = btkSetMetaDataDescription(h, label, newdesc) md = btkSetMetaDataDescription(h, label, sublabel, newdesc) md = btkSetMetaDataDescription(h, label, sublabel, ..., newdesc)

Parameters

h	Handle pointing to a C++ btk::Acquisition object.
idx	Integer specifying the index of a metadata.
subidx	Integer specifying the index of a metadata.
label	String specifying the label of a metadata.
sublabel	String specifying the label of a metadata.
...	Others integers and/or strings to select the metadata to remove.
newdesc	String with the new decription.

Return values

md	Structure with the same format than the function btkGetMetaData.

Detailed description:: btkSetMetaDataDescription(h, idx, newdesc) sets the description of the metadata with the index idx contained in the root.
btkSetMetaDataDescription(h, idx, subidx, newdesc) sets the description of the metadata with the index subidx contained in the metadata with the index idx.
btkSetMetaDataDescription(h, idx, subidx, ..., newdesc) sets the description of any metadata specified by the gives indices.
btkSetMetaDataDescription(h, label, newdesc) sets the description of the metadata with the label label contained in the root
. btkSetMetaDataDescription(h, label, sublabel, newdesc) sets the description of the metadata with the label sublabel contained in the metadata with the label label.
btkSetMetaDataDescription(h, label, sublabel, ..., newdesc) sets the description of any metadata specified by the given labels.

You can mix label and index to set the description of a metadata entry.

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.

See Also: btkSetMetaDataDimensions, btkSetMetaDataFormat, btkSetMetaDataLabel, btkSetMetaDataUnlock, btkSetMetaDataValue