Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a TsGroup from an iterable of Ts/Tsd objects #305

Merged
merged 3 commits into from
Aug 12, 2024
Merged

Create a TsGroup from an iterable of Ts/Tsd objects #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4592241
accept iterable of Ts-compatible objects for TsGroup
eschombu Jun 25, 2024
ce6f373
ensure expected data dict ordering in TsGroup
eschombu Jun 25, 2024
64ffdc0
black formatting
eschombu Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions pynapple/core/ts_group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ def __init__(

Parameters
----------
data : dict
Dictionary containing Ts/Tsd objects, keys should contain integer values or should be convertible
to integer.
data : dict or iterable
Dictionary or iterable of Ts/Tsd objects. The keys should be integer-convertible; if a non-dict iterator is
passed, its values will be used to create a dict with integer keys.
time_support : IntervalSet, optional
The time support of the TsGroup. Ts/Tsd objects will be restricted to the time support if passed.
If no time support is specified, TsGroup will merge time supports from all the Ts/Tsd objects in data.
Expand Down Expand Up @@ -117,13 +117,16 @@ def __init__(

self._initialized = False

if not isinstance(data, dict):
data = dict(enumerate(data))

# convert all keys to integer
try:
keys = [int(k) for k in data.keys()]
except Exception:
raise ValueError("All keys must be convertible to integer.")

# check that there were no floats with decimal points in keys.i
# check that there were no floats with decimal points in keys.
# i.e. 0.5 is not a valid key
if not all(np.allclose(keys[j], float(k)) for j, k in enumerate(data.keys())):
raise ValueError("All keys must have integer value!}")
Expand All @@ -135,6 +138,8 @@ def __init__(

data = {keys[j]: data[k] for j, k in enumerate(data.keys())}
self.index = np.sort(keys)
# Make sure data dict and index are ordered the same
data = {k: data[k] for k in self.index}

self._metadata = pd.DataFrame(index=self.index, columns=["rate"], dtype="float")

Expand Down
12 changes: 10 additions & 2 deletions tests/test_ts_group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,19 @@ def test_create_ts_group(self, group):
assert isinstance(tsgroup, UserDict)
assert len(tsgroup) == 3

def test_create_ts_group_from_iter(self, group):
tsgroup = nap.TsGroup(group.values())
assert isinstance(tsgroup, UserDict)
assert len(tsgroup) == 3

def test_create_ts_group_from_invalid(self):
with pytest.raises(AttributeError):
tsgroup = nap.TsGroup(np.arange(0, 200))

@pytest.mark.parametrize(
"test_dict, expectation",
[
({"1": nap.Ts(np.arange(10)), "2":nap.Ts(np.arange(10))}, does_not_raise()),
({"1": nap.Ts(np.arange(10)), "2": nap.Ts(np.arange(10))}, does_not_raise()),
({"1": nap.Ts(np.arange(10)), 2: nap.Ts(np.arange(10))}, does_not_raise()),
({"1": nap.Ts(np.arange(10)), 1: nap.Ts(np.arange(10))},
pytest.raises(ValueError, match="Two dictionary keys contain the same integer")),
Expand Down Expand Up @@ -82,7 +91,6 @@ def test_initialize_from_dict(self, test_dict, expectation):
def test_metadata_len_match(self, tsgroup):
assert len(tsgroup._metadata) == len(tsgroup)


def test_create_ts_group_from_array(self):
with warnings.catch_warnings(record=True) as w:
nap.TsGroup({
Expand Down
Loading