Numpy tutorial#
This tutorial shows how pynapple interact with numpy.
Show code cell content
import numpy as np
import pynapple as nap
import pandas as pd
Multiple time series object are avaible depending on the shape of the data.
TsdTensor: for data with of more than 2 dimensions, typically movies.TsdFrame: for column-based data. It can be easily converted to a pandas.DataFrame. Columns can be labelled and selected similar to pandas.Tsd: one-dimensional time series. It can be converted to a pandas.Series.Ts: For timestamps data only.
Initialization#
tsdtensor = nap.TsdTensor(t=np.arange(100), d=np.random.rand(100, 5, 5), time_units="s")
tsdframe = nap.TsdFrame(t=np.arange(100), d=np.random.rand(100, 3), columns = ['a', 'b', 'c'])
tsd = nap.Tsd(t=np.arange(100), d=np.random.rand(100))
ts = nap.Ts(t=np.arange(100))
print(tsdtensor)
Time (s)
---------- -----------------------------
0.0 [[0.340472 ... 0.356418] ...]
1.0 [[0.269904 ... 0.917864] ...]
2.0 [[0.115274 ... 0.756709] ...]
3.0 [[0.928524 ... 0.05617 ] ...]
4.0 [[0.037624 ... 0.106516] ...]
5.0 [[0.640203 ... 0.276471] ...]
6.0 [[0.941893 ... 0.711332] ...]
...
93.0 [[0.864251 ... 0.671104] ...]
94.0 [[0.53349 ... 0.89316] ...]
95.0 [[0.08305 ... 0.008207] ...]
96.0 [[0.447086 ... 0.549397] ...]
97.0 [[0.263038 ... 0.238491] ...]
98.0 [[0.942365 ... 0.248045] ...]
99.0 [[0.765614 ... 0.883394] ...]
dtype: float64, shape: (100, 5, 5)
Tsd and Ts can be converted to a pandas.Series.
print(tsd.as_series())
0.0 0.673382
1.0 0.968410
2.0 0.712533
3.0 0.102297
4.0 0.950268
...
95.0 0.442806
96.0 0.838779
97.0 0.909161
98.0 0.958402
99.0 0.349215
Length: 100, dtype: float64
TsdFrame to a pandas.DataFrame.
print(tsdframe.as_dataframe())
a b c
0.0 0.082595 0.601209 0.954433
1.0 0.568727 0.009565 0.777085
2.0 0.738111 0.791079 0.765133
3.0 0.354647 0.079110 0.025338
4.0 0.415659 0.445700 0.391219
... ... ... ...
95.0 0.471532 0.198085 0.610189
96.0 0.007996 0.448200 0.424725
97.0 0.521639 0.526945 0.421416
98.0 0.199843 0.387189 0.992849
99.0 0.382742 0.649231 0.682613
[100 rows x 3 columns]
Attributes#
The numpy array is accesible with the attributes .values, .d and functions .as_array(), to_numpy().
The time index array is a TsIndex object accessible with .index or .t.
.shape and .ndim are also accessible.
print(tsdtensor.ndim)
print(tsdframe.shape)
print(len(tsd))
3
(100, 3)
100
Slicing#
Slicing is very similar to numpy array. The first dimension is always time and time support is always passed on if a pynapple object is returned.
First 10 elements. Return a TsdTensor
print(tsdtensor[0:10])
Time (s)
---------- -----------------------------
0 [[0.340472 ... 0.356418] ...]
1 [[0.269904 ... 0.917864] ...]
2 [[0.115274 ... 0.756709] ...]
3 [[0.928524 ... 0.05617 ] ...]
4 [[0.037624 ... 0.106516] ...]
5 [[0.640203 ... 0.276471] ...]
6 [[0.941893 ... 0.711332] ...]
7 [[0.515855 ... 0.962367] ...]
8 [[0.492742 ... 0.587588] ...]
9 [[0.503138 ... 0.532664] ...]
dtype: float64, shape: (10, 5, 5)
First column. Return a Tsd
print(tsdframe[:,0])
Time (s)
---------- ---------
0.0 0.0825953
1.0 0.568727
2.0 0.738111
3.0 0.354647
4.0 0.415659
5.0 0.12464
6.0 0.390361
...
93.0 0.54286
94.0 0.780268
95.0 0.471532
96.0 0.0079956
97.0 0.521639
98.0 0.199843
99.0 0.382742
dtype: float64, shape: (100,)
First element. Return a numpy ndarray
print(tsdtensor[0])
[[3.40472023e-01 8.28804988e-02 2.24376709e-01 4.30269297e-04
3.56418288e-01]
[2.24517619e-01 9.52943359e-01 6.58609384e-01 9.41806636e-01
9.86217502e-01]
[3.80096585e-01 9.53835778e-01 3.34085819e-01 4.17397777e-02
4.40983719e-03]
[1.61589054e-01 3.29339992e-01 5.60455507e-01 6.94723698e-01
5.71422066e-01]
[6.55680345e-01 4.51383175e-01 2.74459248e-01 2.49902220e-01
1.73102716e-01]]
The time support is never changing when slicing time down.
print(tsd.time_support)
print(tsd[0:20].time_support)
index start end
0 0 99
shape: (1, 2), time unit: sec.
index start end
0 0 99
shape: (1, 2), time unit: sec.
TsdFrame offers special slicing similar to pandas.DataFrame.
Only TsdFrame can have columns labelling and indexing.
print(tsdframe.loc['a'])
print(tsdframe.loc[['a', 'c']])
Time (s)
---------- ---------
0.0 0.0825953
1.0 0.568727
2.0 0.738111
3.0 0.354647
4.0 0.415659
5.0 0.12464
6.0 0.390361
...
93.0 0.54286
94.0 0.780268
95.0 0.471532
96.0 0.0079956
97.0 0.521639
98.0 0.199843
99.0 0.382742
dtype: float64, shape: (100,)
Time (s) a c
---------- ------- -------
0.0 0.0826 0.95443
1.0 0.56873 0.77708
2.0 0.73811 0.76513
3.0 0.35465 0.02534
4.0 0.41566 0.39122
5.0 0.12464 0.43502
6.0 0.39036 0.90089
... ... ...
93.0 0.54286 0.11828
94.0 0.78027 0.59749
95.0 0.47153 0.61019
96.0 0.008 0.42473
97.0 0.52164 0.42142
98.0 0.19984 0.99285
99.0 0.38274 0.68261
dtype: float64, shape: (100, 2)
Arithmetic#
Arithmetical operations works similar to numpy
tsd = nap.Tsd(t=np.arange(5), d=np.ones(5))
print(tsd + 1)
Time (s)
---------- --
0 2
1 2
2 2
3 2
4 2
dtype: float64, shape: (5,)
It is possible to do array operations on the time series provided that the dimensions matches. The output will still be a time series object.
print(tsd - np.ones(5))
Time (s)
---------- --
0 0
1 0
2 0
3 0
4 0
dtype: float64, shape: (5,)
Nevertheless operations like this are not permitted :
try:
tsd + tsd
except Exception as error:
print(error)
operand type(s) all returned NotImplemented from __array_ufunc__(<ufunc 'add'>, '__call__', Time (s)
---------- --
0 1
1 1
2 1
3 1
4 1
dtype: float64, shape: (5,), Time (s)
---------- --
0 1
1 1
2 1
3 1
4 1
dtype: float64, shape: (5,)): 'Tsd', 'Tsd'
Array operations#
The most common numpy functions will return a time series if the output first dimension matches the shape of the time index.
Here the TsdTensor is averaged along the time axis. The output is a numpy array.
print(np.mean(tsdtensor, 0))
[[0.50945475 0.48282365 0.53798135 0.48230101 0.51596222]
[0.53253661 0.51555342 0.48041094 0.54177887 0.47659594]
[0.52388269 0.48345424 0.5169777 0.51159584 0.49213497]
[0.48231331 0.46596175 0.49307879 0.47949993 0.48196281]
[0.53837372 0.52941534 0.52336084 0.5400076 0.54057215]]
Here averaging across the second dimension returns a TsdFrame.
print(np.mean(tsdtensor, 1))
Time (s) 0 1 2 3 4
---------- ------- ------- ------- ------- -------
0.0 0.35247 0.55408 0.4104 0.38572 0.41831
1.0 0.3943 0.59 0.46872 0.46555 0.59819
2.0 0.44652 0.55535 0.66467 0.61493 0.50013
3.0 0.64029 0.65279 0.29158 0.35767 0.21111
4.0 0.44496 0.56122 0.3706 0.66629 0.35616
5.0 0.59584 0.29085 0.47707 0.50101 0.48376
6.0 0.67579 0.72677 0.52956 0.6127 0.46744
... ... ... ... ... ...
93.0 0.53725 0.43968 0.4314 0.61646 0.55416
94.0 0.32509 0.36895 0.59897 0.64687 0.67398
95.0 0.4565 0.57446 0.4286 0.24048 0.24125
96.0 0.69321 0.37305 0.48605 0.50566 0.54889
97.0 0.5792 0.58037 0.85881 0.57723 0.53814
98.0 0.61356 0.55985 0.5927 0.66453 0.46785
99.0 0.61311 0.48823 0.32155 0.55001 0.37884
dtype: float64, shape: (100, 5)
This is not true for FFT functions though.
try:
np.fft.fft(tsd)
except Exception as error:
print(error)
no implementation found for 'numpy.fft.fft' on types that implement __array_function__: [<class 'pynapple.core.time_series.Tsd'>]
Concatenating#
It is possible to concatenate time series providing than they don’t overlap meaning time indexe should be already sorted through all time series to concatenate
tsd1 = nap.Tsd(t=np.arange(5), d=np.ones(5))
tsd2 = nap.Tsd(t=np.arange(5)+10, d=np.ones(5)*2)
tsd3 = nap.Tsd(t=np.arange(5)+20, d=np.ones(5)*3)
print(np.concatenate((tsd1, tsd2, tsd3)))
Time (s)
---------- --
0.0 1
1.0 1
2.0 1
3.0 1
4.0 1
10.0 2
11.0 2
...
13.0 2
14.0 2
20.0 3
21.0 3
22.0 3
23.0 3
24.0 3
dtype: float64, shape: (15,)
It’s also possible to concatenate vertically if time indexes matches up to pynapple float precision
tsdframe = nap.TsdFrame(t=np.arange(5), d=np.random.randn(5, 3))
print(np.concatenate((tsdframe, tsdframe), 1))
Time (s) 0 1 2 3 4 ...
---------- -------- -------- -------- -------- -------- -----
0 -1.18026 0.27981 1.52746 -1.18026 0.27981 ...
1 1.24402 -1.26586 0.60125 1.24402 -1.26586 ...
2 -1.39881 -1.21509 -2.14744 -1.39881 -1.21509 ...
3 0.55969 -0.74905 -0.41613 0.55969 -0.74905 ...
4 0.67176 0.15671 -2.53477 0.67176 0.15671 ...
dtype: float64, shape: (5, 6)
Spliting#
Array split functions are also implemented
print(np.array_split(tsdtensor[0:10], 2))
[Time (s)
---------- -----------------------------
0 [[0.340472 ... 0.356418] ...]
1 [[0.269904 ... 0.917864] ...]
2 [[0.115274 ... 0.756709] ...]
3 [[0.928524 ... 0.05617 ] ...]
4 [[0.037624 ... 0.106516] ...]
dtype: float64, shape: (5, 5, 5), Time (s)
---------- -----------------------------
5 [[0.640203 ... 0.276471] ...]
6 [[0.941893 ... 0.711332] ...]
7 [[0.515855 ... 0.962367] ...]
8 [[0.492742 ... 0.587588] ...]
9 [[0.503138 ... 0.532664] ...]
dtype: float64, shape: (5, 5, 5)]
Modifying#
It is possible to modify a time series element wise
print(tsd1)
tsd1[0] = np.pi
print(tsd1)
Time (s)
---------- --
0 1
1 1
2 1
3 1
4 1
dtype: float64, shape: (5,)
Time (s)
---------- -------
0 3.14159
1 1
2 1
3 1
4 1
dtype: float64, shape: (5,)
It is also possible to modify a time series with logical operations
tsd[tsd.values>0.5] = 0.0
print(tsd)
Time (s)
---------- --
0 0
1 0
2 0
3 0
4 0
dtype: float64, shape: (5,)
Sorting#
It is not possible to sort along the first dimension as it would break the sorting of the time index
tsd = nap.Tsd(t=np.arange(100), d=np.random.rand(100))
try:
np.sort(tsd)
except Exception as error:
print(error)
no implementation found for 'numpy.sort' on types that implement __array_function__: [<class 'pynapple.core.time_series.Tsd'>]