Scripting API

btkGetMetaData

Module BTKMetaDataAccessor

Description#

Extracts metadata for the given acquisition.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
labelString to extract only the metadata and its children with the label label from the root level.
sublabel_pathpath to extract only the metadata and its children with the label sublabel from the metadata 'label'.

Returned Values#

mddictionnary with the following fields:
  • md["info"]: dictionnary containing metadata's informations if present or the value 0
  • md["children"]: Store the same dictionnary for the children of 0 if there is not.
  • md["description"]: String containing the metadata's description
  • md["unlocked"]: Flag to know if the metadata is set as unlocked or not.

Detailed Description#

If no metadata has the given label, then an error is thrown. By default, BTK, use two label of metadata representing group and parameters (as proposed in the C3D format).

Notes#

See also#

btkAppendMetaData, btkClearMetaData, btkFindMetaData, btkRemoveMetaData, btkSetMetaData

Syntax#

md = btkGetMetaData(h)
md = btkGetMetaData(h, label)
md = btkGetMetaData(h, label, sublabel_path)

Examples#