Scripting API

btkFindMetaData

Module BTKAcquisitionAccessor

Description#

Returns the searched metadata or throws if not found.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
labellabel of one metadata
sublabel_pathpath for the desired metadata to search.

Returned Values#

mdSame format than the output of the function btkGetMetaData

Detailed Description#

Notes#

See also#

btkAppendMetaData, btkClearMetaData, btkGetMetaData, btkRemoveMetaData, btkSetMetaData

Syntax#

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

Examples#

filename= ('Static_Example.c3d');
acqstatic = btkReadAcquisition(filename);        %contains a metadata named 'Rate' in 'ANALOG' section

rate =  btkFindMetaData(acq, 'ANALOG', 'RATE');  %equivalent
rate2 = btkFindMetaData(acq, '', 'ANALOG/RATE'); %equivalent

rate2 = btkFindMetaData(acq, 'NON_EXISTANT_FOLDER', 'RATE'); %throws because it doesn't exist