btkSetMetaDataValue Class Reference

Description

Set one metadata's value.

Syntax:

md = btkSetMetaDataValue(h, idx, index, newvalue)
md = btkSetMetaDataValue(h, idx, subidx, index, newvalue)
md = btkSetMetaDataValue(h, idx, subidx, ..., index, newvalue)
md = btkSetMetaDataValue(h, label, index, newvalue)
md = btkSetMetaDataValue(h, label, sublabel, index, newvalue)
md = btkSetMetaDataValue(h, label, sublabel, ..., index, newvalue)

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.
index	Integer with the index of the value to modify.
newvalue	New value (depending the metadata, it can be a real or a string).

Return values

md	Structure with the same format than the function btkGetMetaData.

Detailed description:

btkSetMetaDataValue(h, idx, index, newvalue) sets the value at the index index for the metadata with the index idx contained in the root.
btkSetMetaDataValue(h, idx, subidx, index, newvalue) sets the value at the index index for the metadata with the index subidx contained in the metadata with the index idx.
btkSetMetaDataValue(h, idx, subidx, ..., index, newvalue) sets the value at the index index for any metadata specified by the gives indices.
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.
btkSetMetaDataValue(h, label, sublabel, ..., index, newvalue) sets the value at the index index for any metadata specified by the given labels.

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.

See Also

btkSetMetaDataDescription, btkSetMetaDataDimensions, btkSetMetaDataFormat, btkSetMetaDataLabel, btkSetMetaDataUnlock