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

clarify doc comments for hist_find_

Browse Source 
Say when u8 or u16 are picked.

See https://github.com/libvips/libvips/issues/2519
This commit is contained in:
John Cupitt 2021-11-07 11:14:52 +00:00
parent 6f081de0a0
commit 296fd99925
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
libvips/arithmetic/hist_find.c
View File

@ -444,7 +444,8 @@ vips_hist_find_init( VipsHistFind *hist_find )
* one-band histogram), or for all bands (producing an n-band histogram) if
* @band is -1.
*
* @in is cast to u8 or u16. @out is always u32.
* char and uchar images are cast to uchar before histogramming, all other
* image types are cast to ushort.
*
* See also: vips_hist_find_ndim(), vips_hist_find_indexed().
*

8
libvips/arithmetic/hist_find_indexed.c
View File

@ -486,8 +486,12 @@ vips_hist_find_indexed_init( VipsHistFindIndexed *indexed )
* words, element zero in @out contains the combination of all the pixels in @in
* whose corresponding pixel in @index is zero.
*
* @index must have just one band and be u8 or u16. @in must be
* non-complex. @out always has the same size and format as @in.
* char and uchar @index images are cast to uchar before histogramming, all
* other image types are cast to ushort. @index must have just one band.
*
* @in must be non-complex.
*
* @out always has the same size and format as @in.
*
* Normally, bins are summed, but you can use @combine to set other combine
* modes.

3
libvips/arithmetic/hist_find_ndim.c
View File

@ -330,7 +330,8 @@ vips_hist_find_ndim_init( VipsHistFindNDim *ndim )
* output is 1 x bins, bins x bins, or bins x bins x bins bands.
* @bins defaults to 10.
*
* Images are cast to uchar or ushort before histogramming.
* char and uchar images are cast to uchar before histogramming, all other
* image types are cast to ushort.
*
* See also: vips_hist_find(), vips_hist_find_indexed().
*