Description

Remove a metada and return an updated list of the metada in the acquisition.

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

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.

Return values

md	Structure with the same format than the function btkGetMetaData.

Detailed description:: Warning: Removing some metadata might alter an acquisition. For example, removing the metadata FORCE_PLATFORM has for effect to not be able to extract force platform data as it contains their geometrical informations.

btkRemoveMetaData(h\, idx) removes the metadata at the given index idx contained in the metadata's root. btkRemoveMetaData(h\, idx, subidx) removes the metadata contained at the index subidx which is contained in the metadata with the index idx. btkRemoveMetaData(h\, idx, subidx, ...) removes any metadata specified by the given indices. btkRemoveMetaData(h\, label) removes the metadata with the label label contained in the metadata's root. btkRemoveMetaData(h\, label, sublabel) removes the metadata with the label sublabel contained in the metadata with the label label. btkRemoveMetaData(h\, label, sublabel, ...) removes any metadata specified by the given labels.

You can mix label and index to remove 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: btkRemoveAnalog, btkRemoveAnalysisParameterm, btkRemoveEvent, btkRemovePoint