mirror of
https://github.com/wassname/scikit-image.git
synced 2026-07-02 05:16:25 +08:00
doc strings
This commit is contained in:
@@ -6,6 +6,27 @@ from skimage import util
|
||||
|
||||
|
||||
cdef inline int _clip(np.int_t x, np.int_t low, np.int_t high):
|
||||
"""Clips coordinate between high and low.
|
||||
|
||||
This method was created so that `hessian_det_appx` does not have to make
|
||||
a Python call.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x : int
|
||||
Coordinate to be clipped.
|
||||
low : int
|
||||
The lower bound.
|
||||
high : int
|
||||
The higher bound.
|
||||
|
||||
Returns
|
||||
-------
|
||||
x : int
|
||||
`x` clipped between 'high' and `low`.
|
||||
|
||||
"""
|
||||
|
||||
if(x > high):
|
||||
return high
|
||||
if(x < low):
|
||||
|
||||
Reference in New Issue
Block a user