Package timeside :: Package analyzer :: Module core :: Class LabelMetadata

Class LabelMetadata

    object --+    
             |    
MetadataObject --+
                 |
                LabelMetadata


Metadata object to handle Label Metadata

    Attributes
    ----------
    label : dict
        A dictionnary that contains :
            - label id has keys and
            - label names has values

    description : dict
        A dictionnary that contains :
            - label id has keys and
            - label descriptions has values

    label_type : str
        = 'mono' or 'multi'
        'mono' or 'multi' enable to specify the label mode :
        - 'mono'  : mono-label (only 1 label at a time)
        - 'multi' : multi-label (several labels can be observe
                    at the same time)

Instance Methods

[hide private]

to_hdf5(self, h5group)
Save a dictionnary-like object inside a h5 file group

source code

Inherited from MetadataObject: __delattr__, __eq__, __getitem__, __init__, __ne__, __repr__, __setattr__, __setitem__, __str__, as_dict, from_hdf5, from_xml, items, keys, to_xml, values

Inherited from object: __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

Class Variables

[hide private]

_default_value = OrderedDict([('label', {}), ('description', {...

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

to_hdf5(self, h5group)

source code

Save a dictionnary-like object inside a h5 file group

Overrides: MetadataObject.to_hdf5

Class Variable Details

[hide private]

_default_value

Value:

OrderedDict([('label', {}), ('description', {}), ('label_type', 'mono'
)])