sergiotarxz/libvips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improve min/max docs

Browse Source 
thanks Paul, see

https://github.com/jcupitt/libvips/issues/252
This commit is contained in:
John Cupitt 2015-04-12 11:25:46 +01:00
parent 58ff66254d
commit d8018e8126
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libvips/arithmetic/max.c
View File

@ -495,8 +495,9 @@ vips_max_init( VipsMax *max )
*
* This operation finds the maximum value in an image.
*
* If the image contains several maximum values, only the first @size
* found are returned.
* By default it finds the single largest value. If @size is set >1, it will
* find the @size largest values. It will stop searching early if has found
* enough values.
*
* It operates on all
* bands of the input image: use vips_stats() if you need to find an
@ -506,7 +507,8 @@ vips_max_init( VipsMax *max )
*
* You can read out the position of the maximum with @x and @y. You can read
* out arrays of the values and positions of the top @size maxima with
* @out_array, @x_array and @y_array.
* @out_array, @x_array and @y_array. These values are returned sorted from
* largest to smallest.
*
* See also: vips_min(), vips_stats().
*

7
libvips/arithmetic/min.c
View File

@ -498,8 +498,9 @@ vips_min_init( VipsMin *min )
*
* This operation finds the minimum value in an image.
*
* If the image contains several minimum values, only the first @size
* found are returned.
* By default it finds the single smallest value. If @size is set >1, it will
* find the @size smallest values. It will stop searching early if has found
* enough values.
*
* It operates on all
* bands of the input image: use vips_stats() if you need to find an
@ -510,6 +511,8 @@ vips_min_init( VipsMin *min )
* You can read out the position of the minimum with @x and @y. You can read
* out arrays of the values and positions of the top @size minima with
* @out_array, @x_array and @y_array.
* These values are returned sorted from
* smallest to largest.
*
* See also: vips_min(), vips_stats().
*