1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
from datetime import datetime
from dateutil.tz import tzlocal
import numpy as np
from numpy.testing import assert_array_equal
import pandas as pd
from pynwb import NWBFile, TimeSeries
from pynwb.core import ScratchData, DynamicTable
from pynwb.testing import TestCase
class TestScratchData(TestCase):
def setUp(self):
self.nwbfile = NWBFile(
session_description='a file to test writing and reading scratch data',
identifier='TEST_scratch',
session_start_time=datetime(2017, 5, 1, 12, 0, 0, tzinfo=tzlocal())
)
def test_constructor_list(self):
sd = ScratchData(
name='foo',
data=[1, 2, 3, 4],
description='test scratch',
)
self.assertEqual(sd.name, 'foo')
self.assertListEqual(sd.data, [1, 2, 3, 4])
self.assertEqual(sd.description, 'test scratch')
def test_add_scratch_int(self):
ret = self.nwbfile.add_scratch(2, name='test', description='test data')
self.assertIsInstance(ret, ScratchData)
self.assertEqual(ret.name, 'test')
self.assertEqual(ret.data, 2)
self.assertEqual(ret.description, 'test data')
self.assertIs(ret.parent, self.nwbfile)
self.assertEqual(self.nwbfile.get_scratch('test'), 2)
def test_add_scratch_list(self):
self.nwbfile.add_scratch([1, 2, 3, 4], name='test', description='test data')
assert_array_equal(self.nwbfile.get_scratch('test'), np.array([1, 2, 3, 4]))
def test_add_scratch_ndarray(self):
self.nwbfile.add_scratch(np.array([1, 2, 3, 4]), name='test', description='test data')
assert_array_equal(self.nwbfile.get_scratch('test'), np.array([1, 2, 3, 4]))
def test_add_scratch_list_no_name(self):
msg = ('A name is required for NWBFile.add_scratch when adding a scalar, numpy.ndarray, '
'list, tuple, or pandas.DataFrame as scratch data.')
with self.assertRaisesWith(ValueError, msg):
self.nwbfile.add_scratch([1, 2, 3, 4])
def test_add_scratch_ndarray_no_description(self):
msg = ('A description is required for NWBFile.add_scratch when adding a scalar, numpy.ndarray, '
'list, tuple, or pandas.DataFrame as scratch data.')
with self.assertRaisesWith(ValueError, msg):
self.nwbfile.add_scratch(np.array([1, 2, 3, 4]), name='test')
def test_add_scratch_dataframe(self):
data = pd.DataFrame(data={'col1': [1, 2, 3, 4], 'col2': ['a', 'b', 'c', 'd']})
self.nwbfile.add_scratch(data, name='test', description='my_table')
assert_array_equal(data.values, self.nwbfile.get_scratch('test').values)
assert_array_equal(data.index.values, self.nwbfile.get_scratch('test').index.values)
def test_add_scratch_dataframe_no_description(self):
data = pd.DataFrame(data={'col1': [1, 2, 3, 4], 'col2': ['a', 'b', 'c', 'd']})
msg = ('A description is required for NWBFile.add_scratch when adding a scalar, numpy.ndarray, '
'list, tuple, or pandas.DataFrame as scratch data.')
with self.assertRaisesWith(ValueError, msg):
self.nwbfile.add_scratch(data, name='test')
def test_add_scratch_container(self):
data = TimeSeries(name='test_ts', data=[1, 2, 3, 4, 5], unit='unit', timestamps=[1.1, 1.2, 1.3, 1.4, 1.5])
self.nwbfile.add_scratch(data)
self.assertIs(self.nwbfile.get_scratch('test_ts'), data)
self.assertIs(self.nwbfile.scratch['test_ts'], data)
def test_add_scratch_container_name(self):
data = TimeSeries(name='test_ts', data=[1, 2, 3, 4, 5], unit='unit', timestamps=[1.1, 1.2, 1.3, 1.4, 1.5])
msg = ('The name argument is ignored when adding an NWBContainer, ScratchData, or '
'DynamicTable to scratch.')
with self.assertWarnsWith(UserWarning, msg):
self.nwbfile.add_scratch(data, name='Foo')
self.assertIs(self.nwbfile.get_scratch('test_ts'), data)
self.assertIs(self.nwbfile.scratch['test_ts'], data)
def test_add_scratch_container_description(self):
data = TimeSeries(name='test_ts', data=[1, 2, 3, 4, 5], unit='unit', timestamps=[1.1, 1.2, 1.3, 1.4, 1.5])
msg = ('The description argument is ignored when adding an NWBContainer, ScratchData, or '
'DynamicTable to scratch.')
with self.assertWarnsWith(UserWarning, msg):
self.nwbfile.add_scratch(data, description='test scratch')
self.assertIs(self.nwbfile.get_scratch('test_ts'), data)
self.assertIs(self.nwbfile.scratch['test_ts'], data)
def test_add_scratch_scratchdata(self):
data = ScratchData(name='test', data=[1, 2, 3, 4, 5], description='test description')
self.nwbfile.add_scratch(data)
self.assertIs(data.parent, self.nwbfile)
self.assertIs(self.nwbfile.get_scratch('test', convert=False), data)
self.assertIs(self.nwbfile.scratch['test'], data)
def test_add_scratch_dynamictable(self):
data = DynamicTable(name='test', description='description')
self.nwbfile.add_scratch(data)
self.assertIs(self.nwbfile.get_scratch('test', convert=False), data)
self.assertIs(self.nwbfile.scratch['test'], data)
def test_get_scratch_list_convert_false(self):
self.nwbfile.add_scratch([1, 2, 3, 4], name='test', description='test description')
self.assertTrue(isinstance(self.nwbfile.get_scratch('test', convert=False), ScratchData))
self.assertTrue(isinstance(self.nwbfile.scratch['test'], ScratchData))
self.assertEqual(self.nwbfile.scratch['test'].data, [1, 2, 3, 4])
def test_get_scratch_df_convert_false(self):
data = pd.DataFrame(data={'col1': [1, 2, 3, 4], 'col2': ['a', 'b', 'c', 'd']})
self.nwbfile.add_scratch(data, name='test', description='my_table')
self.assertTrue(isinstance(self.nwbfile.get_scratch('test', convert=False), DynamicTable))
self.assertTrue(isinstance(self.nwbfile.scratch['test'], DynamicTable))
self.assertEqual(self.nwbfile.scratch['test'].description, 'my_table')
|
