Victoria Oberascher commited on
Commit
03937fd
1 Parent(s): 2278280

add detailed description for the input parameters

Browse files
Files changed (1) hide show
  1. README.md +8 -0
README.md CHANGED
@@ -81,6 +81,14 @@ prediction_points = [
81
 
82
  ##### Calculate horizon metrics
83
 
 
 
 
 
 
 
 
 
84
  ```python
85
  import evaluate
86
 
 
81
 
82
  ##### Calculate horizon metrics
83
 
84
+ ###### Input parameters
85
+
86
+ - **vertical_fov_degrees (in degrees)**: vertical field of view
87
+ - **height (in pixels)**: height of the images
88
+ - **roll_threshold (in degrees)**: This value is internally converted to a slope threshold. It is used to determine the number of slope error jumps. A slope error jump is counted if the difference in slope error between two successive frames exceeds this threshold.
89
+
90
+ - **pitch_threshold (in degrees)**: This value is internally converted to the midpoint. It is used as a threshold to determine the number of midpoint error jumps. A midpoint error jump is counted if the difference in midpoint error between two successive frames exceeds this threshold.
91
+
92
  ```python
93
  import evaluate
94