Skip to content

Commit 6dd5faa

Browse files
authored
Update docstring for viewshed (#807)
1 parent 555706c commit 6dd5faa

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

xrspatial/viewshed.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -1606,15 +1606,19 @@ def viewshed(raster: xarray.DataArray,
16061606
observer_elev : float
16071607
Observer elevation above the terrain.
16081608
target_elev : float
1609-
Target elevation offset above the terrain.
1609+
Target elevation offset above the terrain, which is the height
1610+
in surface units to be added to the z-value of each pixel
1611+
when it is being analyzed for visibility.
16101612
16111613
Returns
16121614
-------
16131615
viewshed: xarray.DataArray
16141616
A cell x in the visibility grid is recorded as follows:
16151617
If it is invisible, then x is set to INVISIBLE.
16161618
If it is visible, then x is set to the vertical angle w.r.t
1617-
the viewpoint.
1619+
the viewpoint. The value returned is in [0, 180]. A value of 0 is
1620+
directly below the specified viewing position,
1621+
90 is due horizontal, and 180 is directly above the observer.
16181622
16191623
Examples
16201624
--------

0 commit comments

Comments
 (0)