Skip to content

Commit da2937d

Browse files
pulkkinspulkkins
committed
Documentation fixes
1 parent 1e7b7cd commit da2937d

File tree

4 files changed

+28
-27
lines changed

4 files changed

+28
-27
lines changed

‎doc/source/oflow.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,6 @@ pysteps\.optflow\.lucaskanade
2424

2525
.. autosummary::
2626
dense_lucaskanade
27-
ShiTomasi_features_to_track
28-
LucasKanade_features_tracking
29-
clean_image
30-
declustering
31-
interpolate_sparse_vectors
3227

3328
.. automodule:: pysteps.optflow.lucaskanade
3429
:members:

‎pysteps/verification/detcontscores.py

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,27 @@ def scores_det_cont_fcst(pred, obs, scores, offset=0.01):
1616
a list containing the names of the scores to be computed, the full list
1717
is:
1818
19-
+------------+--------------------------------------------------------------+
20-
| Name | Description |
21-
+============+==============================================================+
22-
| beta | linear regression slope (conditional bias) |
23-
+------------+--------------------------------------------------------------+
24-
| corr_p | pearson's correleation coefficien (linear correlation) |
25-
+------------+--------------------------------------------------------------+
26-
| corr_s | spearman's correlation coefficient (rank correlation) |
27-
+------------+--------------------------------------------------------------+
28-
| ME_add | mean error or bias of additive residuals |
29-
+------------+--------------------------------------------------------------+
30-
| ME_mult | mean error or bias of multiplicative residuals |
31-
+------------+--------------------------------------------------------------+
32-
| RMSE_add | root mean squared additive error |
33-
+------------+--------------------------------------------------------------+
34-
| RMSE_mult | root mean squared multiplicative error |
35-
+------------+--------------------------------------------------------------+
36-
| RV_add | reduction of variance (Brier Score, Nash-Sutcliffe Efficiency|
37-
+------------+--------------------------------------------------------------+
38-
| RV_mult | reduction of variance in multiplicative space |
39-
+------------+--------------------------------------------------------------+
19+
+------------+----------------------------------------------------------------+
20+
| Name | Description |
21+
+============+================================================================+
22+
| beta | linear regression slope (conditional bias) |
23+
+------------+----------------------------------------------------------------+
24+
| corr_p | pearson's correleation coefficien (linear correlation) |
25+
+------------+----------------------------------------------------------------+
26+
| corr_s | spearman's correlation coefficient (rank correlation) |
27+
+------------+----------------------------------------------------------------+
28+
| ME_add | mean error or bias of additive residuals |
29+
+------------+----------------------------------------------------------------+
30+
| ME_mult | mean error or bias of multiplicative residuals |
31+
+------------+----------------------------------------------------------------+
32+
| RMSE_add | root mean squared additive error |
33+
+------------+----------------------------------------------------------------+
34+
| RMSE_mult | root mean squared multiplicative error |
35+
+------------+----------------------------------------------------------------+
36+
| RV_add | reduction of variance (Brier Score, Nash-Sutcliffe Efficiency) |
37+
+------------+----------------------------------------------------------------+
38+
| RV_mult | reduction of variance in multiplicative space |
39+
+------------+----------------------------------------------------------------+
4040
4141
offset : float
4242
an offset that is added to both prediction and observation to avoid 0 division

‎pysteps/visualization/animations.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ def animate(R_obs, nloops=2, timestamps=None, R_fct=None, timestep_min=5,
3232
geodata : dictionary
3333
Optional dictionary containing geographical information about the field.
3434
If geodata is not None, it must contain the following key-value pairs:
35-
35+
36+
.. tabularcolumns:: |p{1.5cm}|L|
37+
3638
+-----------------+----------------------------------------------------+
3739
| Key | Value |
3840
+=================+====================================================+

‎pysteps/visualization/motionfields.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ def quiver(UV, geodata=None, **kwargs):
1616
Optional dictionary containing geographical information about the field.
1717
If geodata is not None, it must contain the following key-value pairs:
1818
19+
.. tabularcolumns:: |p{1.5cm}|L|
20+
1921
+-----------------+----------------------------------------------------+
2022
| Key | Value |
2123
+=================+====================================================+
@@ -94,6 +96,8 @@ def streamplot(UV, geodata=None, **kwargs):
9496
Optional dictionary containing geographical information about the field.
9597
If geodata is not None, it must contain the following key-value pairs:
9698
99+
.. tabularcolumns:: |p{1.5cm}|L|
100+
97101
+-----------------+----------------------------------------------------+
98102
| Key | Value |
99103
+=================+====================================================+

0 commit comments

Comments
 (0)