Scripting API

btkMetaDataInfo

Module BTKGeneral

Description#

Creates a dictionnary containing the required fields for the informations of a metadata.

Parameters#

formatString with the type of data.
valuesdata to store in the metadata.
numdimsinteger for the number of dimensions.

Returned Values#

infodictionnary with the following fields:
  • info["format"]: String with the format of the information (Char, Byte, Integer or Real).
  • info["values"]: Numpy matrix of numerical values or a cell of strings.
  • info["numdims"]: Desired number of dimension. All the dimension missing in the value are set to 1. Note: The maximum number of dimensions is set to 7.

Detailed Description#

This function simplify the construction of the information used in btkAppendMetaData.

Notes#

See also#

btkAppendMetaData

Syntax#

info = btkMetaDataInfo(format, values)
info = btkMetaDataInfo(format, values, numdims)

Examples#