Home       Trees       Indices       Help   
timeside
Package timeside :: Package analyzer :: Module core :: Class AnalyzerResult
[hide private]
[frames] | no frames]

Class AnalyzerResult

source code

    object --+    
             |    
MetadataObject --+
                 |
                AnalyzerResult
Known Subclasses:

Object that contains the metadata and parameters of an analyzer process

Parameters
----------
data_mode : str
    data_mode describes the type of data :
        - 'value' for values
        - 'label' for label data see LabelMetadata
time_mode : str
    time_mode describes the correspondance between data values and time
        - 'framewise'
        - 'global'
        - 'segment'
        - 'event'

Returns
-------
A new MetadataObject with the following attributes :
    - data_object : :class:`DataObject`
    - id_metadata : :class:`IdMetadata`
    - audio_metadata : :class:`AudioMetadata`
    - frame_metadata : :class:`FrameMetadata`
    - label_metadata : :class:`LabelMetadata`
    - parameters : :class:`AnalyzerParameters` Object
Instance Methods [hide private]
 
__init__(self, data_mode=None, time_mode=None)
Construct an Metadata object Abstract Class _default_value must be specified by		 source code
 
__setattr__(self, name, value)
x.__setattr__('name', value) <==> x.name = value		 source code
 
__len__(self) source code
 
as_dict(self) source code
 
to_xml(self) source code
 
to_hdf5(self, h5_file) source code

Inherited from MetadataObject: __delattr__, __eq__, __getitem__, __ne__, __repr__, __setitem__, __str__, items, keys, values

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

Static Methods [hide private]
 
factory(data_mode='value', time_mode='framewise')
Factory function for Analyzer result		 source code
 
from_xml(xml_string) source code
 
from_hdf5(h5group) source code
Class Variables [hide private]
  _default_value = OrderedDict([('id_metadata', None), ('data_ob...
Properties [hide private]
  data_mode
  time_mode
  data
  time
  duration
  id
  name
  unit

Inherited from object: __class__

Method Details [hide private]

__init__(self, data_mode=None, time_mode=None)
(Constructor)

source code  

Construct an Metadata object
Abstract Class _default_value must be specified by

Metadata()

Parameters
----------

Returns
-------
Metadata
Overrides: object.__init__
(inherited documentation)

__setattr__(self, name, value)

source code 

x.__setattr__('name', value) <==> x.name = value

Overrides: object.__setattr__
(inherited documentation)

as_dict(self)

source code 
Overrides: MetadataObject.as_dict

to_xml(self)

source code 
Overrides: MetadataObject.to_xml

from_xml(xml_string)
Static Method

source code 
Overrides: MetadataObject.from_xml

to_hdf5(self, h5_file)

source code 
Overrides: MetadataObject.to_hdf5

from_hdf5(h5group)
Static Method

source code 
Overrides: MetadataObject.from_hdf5

Class Variable Details [hide private]

_default_value

Value:
OrderedDict([('id_metadata', None), ('data_object', None), ('audio_met\
adata', None), ('frame_metadata', None), ('label_metadata', None), ('p\
arameters', None)])

Property Details [hide private]

data_mode

Get Method:
unreachable.data_mode(self)

time_mode

Get Method:
unreachable.time_mode(self)

data

Get Method:
unreachable.data(self)

time

Get Method:
unreachable.time(self)

duration

Get Method:
unreachable.duration(self)

id

Get Method:
unreachable.id(self)

name

Get Method:
unreachable.name(self)

unit

Get Method:
unreachable.unit(self)

   Home       Trees       Indices       Help   
timeside
Generated by Epydoc 3.0.1 on Sun Dec 15 00:09:36 2013 http://epydoc.sourceforge.net