btkRemoveMetaData

Module

BTKAcquisitionModifier

Description#

Removes a metada and returns an updated list of the metada in the acquisition.

Parameters#

h	Handle pointing to a C++ btk::Acquisition object.
label	String specifying the label of a metadata.
sublabel_path	path to extract only the metadata and its children with the label sublabel from the metadata 'label'.

Returned 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, label) removes the metadata with the label label contained in the metadata's root.
• btkRemoveMetaData(h, label, sublabel_path) removes the metadata with the label sublabel contained in the metadata with the label label.

You can mix label 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. This function originally also used indexes in addition to labels. Due to the addition of MetaData in the backend, the use of indexes became irrelevent.

Notes#

See also#

btkRemoveAnalog, btkRemovePoint