From 122ec7b25a73e42b666620c014b440d0dfe7c727 Mon Sep 17 00:00:00 2001 From: Thomas Fillon Date: Fri, 25 Oct 2013 17:18:31 +0200 Subject: [PATCH] Change function AnalyzerResultFactory to lowercase analyzer_result_factory --- doc/source/tutorial/AnalyzerResult.rst | 20 ++++++++++---------- tests/test_AnalyzerResult.py | 2 +- timeside/analyzer/core.py | 12 ++++++------ 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/source/tutorial/AnalyzerResult.rst b/doc/source/tutorial/AnalyzerResult.rst index 980c726..26b3646 100644 --- a/doc/source/tutorial/AnalyzerResult.rst +++ b/doc/source/tutorial/AnalyzerResult.rst @@ -7,7 +7,7 @@ Example of use of the Aanalyzer Result structure -Usage : AnalyzerResultFactory(data_mode=None, time_mode=None) +Usage : analyzer_result_factory(data_mode=None, time_mode=None) Four different *time_mode* can be specified : @@ -22,15 +22,15 @@ Two different *data_mode* can be specified : - 'label' : Data are returned as label indexes (specified by the label_metadata key) -See : :func:`timeside.analyzer.core.AnalyzerResultFactory`, :class:`timeside.analyzer.core.AnalyzerResult` +See : :func:`timeside.analyzer.core.analyzer_result_factory`, :class:`timeside.analyzer.core.AnalyzerResult` Default ======= Create a new analyzer result without arguments - >>> from timeside.analyzer.core import AnalyzerResultFactory - >>> res = AnalyzerResultFactory() + >>> from timeside.analyzer.core import analyzer_result_factory + >>> res = analyzer_result_factory() This default result has all the metadata and dataObject attribute @@ -60,7 +60,7 @@ Four different time_mode can be specified : Framewise --------- ->>> res = AnalyzerResultFactory(time_mode='framewise') +>>> res = analyzer_result_factory(time_mode='framewise') >>> res.keys() ['id_metadata', 'data_object', 'audio_metadata', 'frame_metadata', 'parameters'] @@ -70,7 +70,7 @@ Global No frame metadata information is needed for these modes. The 'frame_metadata' key/attribute is deleted. ->>> res = AnalyzerResultFactory(time_mode='global') +>>> res = analyzer_result_factory(time_mode='global') >>> res.keys() ['id_metadata', 'data_object', 'audio_metadata', 'parameters'] >>> res.data_object @@ -79,7 +79,7 @@ DataObject(value=array([], dtype=float64)) Segment ------- ->>> res = AnalyzerResultFactory(time_mode='segment') +>>> res = analyzer_result_factory(time_mode='segment') >>> res.keys() ['id_metadata', 'data_object', 'audio_metadata', 'parameters'] >>> res.data_object @@ -88,7 +88,7 @@ DataObject(value=array([], dtype=float64), time=array([], dtype=float64), durati Event ----- ->>> res = AnalyzerResultFactory(time_mode='event') +>>> res = analyzer_result_factory(time_mode='event') >>> res.keys() ['id_metadata', 'data_object', 'audio_metadata', 'parameters'] >>> res.data_object @@ -105,7 +105,7 @@ Value ----- The label_metadata key is deleted. ->>> res = AnalyzerResultFactory(data_mode='value') +>>> res = analyzer_result_factory(data_mode='value') >>> res.keys() ['id_metadata', 'data_object', 'audio_metadata', 'frame_metadata', 'parameters'] @@ -116,7 +116,7 @@ DataObject(value=array([], dtype=float64)) Label ----- ->>> res = AnalyzerResultFactory(data_mode='label') +>>> res = analyzer_result_factory(data_mode='label') >>> res.keys() ['id_metadata', 'data_object', 'audio_metadata', 'frame_metadata', 'label_metadata', 'parameters'] diff --git a/tests/test_AnalyzerResult.py b/tests/test_AnalyzerResult.py index 576d3b3..200a7d2 100755 --- a/tests/test_AnalyzerResult.py +++ b/tests/test_AnalyzerResult.py @@ -14,7 +14,7 @@ class TestAnalyzerResult(TestCase): """ test AnalyzerResult """ def setUp(self): - self.result = AnalyzerResultFactory(data_mode='value', time_mode='framewise') + self.result = analyzer_result_factory(data_mode='value', time_mode='framewise') from datetime import datetime self.result.id_metadata = dict(date=datetime.now().replace(microsecond=0).isoformat(' '), version=__version__, diff --git a/timeside/analyzer/core.py b/timeside/analyzer/core.py index 98c5001..3ad93d4 100644 --- a/timeside/analyzer/core.py +++ b/timeside/analyzer/core.py @@ -517,7 +517,7 @@ class AnalyzerResult(MetadataObject): data_mode_child = root.find('data_mode') time_mode_child = root.find('time_mode') - result = AnalyzerResultFactory(data_mode=data_mode_child.text, + result = analyzer_result_factory(data_mode=data_mode_child.text, time_mode=time_mode_child.text) for child in root: key = child.tag @@ -690,7 +690,7 @@ class SegmentLabelResult(LabelObject, SegmentObject): pass -def AnalyzerResultFactory(data_mode='value', time_mode='framewise'): +def analyzer_result_factory(data_mode='value', time_mode='framewise'): ''' Analyzer result Factory function ''' @@ -818,7 +818,7 @@ class AnalyzerResultContainer(dict): results = AnalyzerResultContainer() for res_json in results_json: - res = AnalyzerResultFactory(data_mode=res_json['data_mode'], + res = analyzer_result_factory(data_mode=res_json['data_mode'], time_mode=res_json['time_mode']) for key in res_json.keys(): if key not in ['data_mode', 'time_mode']: @@ -854,7 +854,7 @@ class AnalyzerResultContainer(dict): results_yaml = yaml.load(yaml_str) results = AnalyzerResultContainer() for res_yaml in results_yaml: - res = AnalyzerResultFactory(data_mode=res_yaml['data_mode'], + res = analyzer_result_factory(data_mode=res_yaml['data_mode'], time_mode=res_yaml['time_mode']) for key in res_yaml.keys(): if key not in ['data_mode', 'time_mode']: @@ -915,7 +915,7 @@ class AnalyzerResultContainer(dict): try: for (group_name, group) in h5_file.items(): - result = AnalyzerResultFactory(data_mode=group.attrs['data_mode'], + result = analyzer_result_factory(data_mode=group.attrs['data_mode'], time_mode=group.attrs['time_mode']) # Read Sub-Group for subgroup_name, subgroup in group.items(): @@ -1004,7 +1004,7 @@ class Analyzer(Processor): from datetime import datetime - result = AnalyzerResultFactory(data_mode=data_mode, time_mode=time_mode) + result = analyzer_result_factory(data_mode=data_mode, time_mode=time_mode) # Automatically write known metadata result.id_metadata.date = datetime.now().replace( -- 2.39.5