docs for hough funcs

This commit is contained in:
John Cupitt 2014-04-01 19:45:51 +01:00
parent fb24bc84d3
commit b1c0acf3e2
2 changed files with 17 additions and 3 deletions

View File

@ -280,10 +280,16 @@ vips_hough_circle_init( VipsHoughCircle *hough_circle )
*
* Find the circular Hough transform of an image. @in must be one band, with
* non-zero pixels for image edges. @out is three-band, with the third channel
* representing the detected circle radius.
*
* representing the detected circle radius. The operation scales the number of
* votes by circle circumference so circles of differing size are given equal
* weight.
*
* Use @max_radius and @min_radius to set the range of radii to search for.
*
* Use @scale to set how @in coordinates are scaled to @out coordinates. A
* @scale of 3, for example, will make @out 1/3rd of the width and height of
* @in, and reduce the number of radii tested (and hence the number of bands
* int @out) by a factor of three as well.
*
* See also: vips_hough_line().
*

View File

@ -171,7 +171,15 @@ vips_hough_line_init( VipsHoughLine *hough_line )
* @width: horizontal size of parameter space
* @height: vertical size of parameter space
*
* See also:
* Find the line Hough transform for @in. @in must have one band. @out has one
* band, with pixels being the number of votes for that line. The X dimension
* of @out is the line angle, the Y dimension is the distance of the line from
* the origin.
*
* Use @width @height to set the size of the parameter space image (@out),
* that is, how accurate the line determination should be.
*
* See also: vips_hough_circle().
*
* Returns: 0 on success, -1 on error
*/