Skip to content

Commit 96c2391

Browse files
committed
add examples in range_query and knn_query
1 parent add4fb0 commit 96c2391

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

pymove/query/query.py

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,25 @@ def range_query(
6565
------
6666
ValueError: if distance measure is invalid
6767
68+
Examples
69+
--------
70+
>>> from pymove.query.query import range_query
71+
>>> traj_df
72+
lat lon datetime id
73+
0 16.4 -54.9 2014-10-11 18:00:00 1
74+
1 16.4 -55.9 2014-10-12 00:00:00 1
75+
2 16.4 -56.9 2014-10-12 06:00:00 1
76+
>>> move_df
77+
lat lon datetime id
78+
0 33.1 -77.0 2012-05-19 00:00:00 2
79+
1 32.8 -77.1 2012-05-19 06:00:00 3
80+
2 32.5 -77.3 2012-05-19 12:00:00 4
81+
>>> range_query(
82+
>>> traj_df, move_df, min_dist=80.5
83+
>>> )
84+
lat lon datetime id
85+
1 32.8 -77.1 2012-05-19 06:00:00 3
86+
2 32.5 -77.3 2012-05-19 12:00:00 4
6887
"""
6988
result = traj.copy()
7089
result.drop(result.index, inplace=True)
@@ -139,6 +158,27 @@ def knn_query(
139158
------
140159
ValueError: if distance measure is invalid
141160
161+
Examples
162+
--------
163+
>>> from pymove.query.query import knn_query
164+
>>> traj_df
165+
lat lon datetime id
166+
0 16.4 -54.9 2014-10-11 18:00:00 1
167+
1 16.4 -55.9 2014-10-12 00:00:00 1
168+
2 16.4 -56.9 2014-10-12 06:00:00 1
169+
>>> move_df
170+
lat lon datetime id
171+
0 33.1 -77.0 2012-05-19 00:00:00 2
172+
1 32.8 -77.1 2012-05-19 06:00:00 3
173+
2 32.5 -77.3 2012-05-19 12:00:00 4
174+
>>> knn_query(
175+
>>> traj_df, move_df, k=1
176+
>>> )
177+
lat lon datetime id
178+
0 16.4 -54.9 2014-10-11 18:00:00 1
179+
1 16.4 -55.9 2014-10-12 00:00:00 1
180+
2 16.4 -56.9 2014-10-12 06:00:00 1
181+
2 32.5 -77.3 2012-05-19 12:00:00 4
142182
"""
143183
k_list = pd.DataFrame([[np.Inf, 'empty']] * k, columns=['distance', TRAJ_ID])
144184

0 commit comments

Comments
 (0)