btkSetMetaDataDimensions

Module

BTKMetaDataModifier

Description#

Sets metadata's dimensions.

Parameters#

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

Returned Values#

md	structure with the same format than the function btkGetMetaData

Detailed Description#

• btkSetMetaDataDimensions(h, label, newdims) sets the dimensions of the metadata with the label label contained in the root.
• btkSetMetaDataDimensions(h, label, sublabel_path, newdims) sets the dimensions of the metadata with the label sublabel contained in the metadata with the label label.

You can mix label to set the dimensions 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. 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#

btkSetMetaDataValue