Skip to content

Commit 2e1d4b4

Browse files
committed
.
2 parents 02d2964 + 4c90f08 commit 2e1d4b4

1 file changed

Lines changed: 21 additions & 18 deletions

File tree

CImg.h

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31537,9 +31537,9 @@ namespace cimg_library {
3153731537

3153831538
//! Pointwise min operator between instance image and a value.
3153931539
/**
31540-
\param val Value used as the reference argument of the min operator.
31540+
\param value Value used as the reference argument of the min operator.
3154131541
\note Replace each pixel value \f$I_{(x,y,z,c)}\f$ of the image instance by
31542-
\f$\mathrm{min}(I_{(x,y,z,c)},\mathrm{val})\f$.
31542+
\f$ \mathrm{min}(I_{(x,y,z,c)},\mathrm{val}) \f$.
3154331543
**/
3154431544
CImg<T>& min(const T& value) {
3154531545
if (is_empty()) return *this;
@@ -31595,7 +31595,7 @@ namespace cimg_library {
3159531595

3159631596
//! Pointwise max operator between instance image and a value.
3159731597
/**
31598-
\param val Value used as the reference argument of the max operator.
31598+
\param value Value used as the reference argument of the max operator.
3159931599
\note Replace each pixel value \f$I_{(x,y,z,c)}\f$ of the image instance by
3160031600
\f$\mathrm{max}(I_{(x,y,z,c)},\mathrm{val})\f$.
3160131601
**/
@@ -31653,7 +31653,7 @@ namespace cimg_library {
3165331653

3165431654
//! Pointwise minabs operator between instance image and a value.
3165531655
/**
31656-
\param val Value used as the reference argument of the minabs operator.
31656+
\param value Value used as the reference argument of the minabs operator.
3165731657
\note Replace each pixel value \f$I_{(x,y,z,c)}\f$ of the image instance by
3165831658
\f$\mathrm{minabs}(I_{(x,y,z,c)},\mathrm{val})\f$.
3165931659
**/
@@ -31712,7 +31712,7 @@ namespace cimg_library {
3171231712

3171331713
//! Pointwise maxabs operator between instance image and a value.
3171431714
/**
31715-
\param val Value used as the reference argument of the maxabs operator.
31715+
\param value Value used as the reference argument of the maxabs operator.
3171631716
\note Replace each pixel value \f$I_{(x,y,z,c)}\f$ of the image instance by
3171731717
\f$\mathrm{maxabs}(I_{(x,y,z,c)},\mathrm{val})\f$.
3171831718
**/
@@ -32877,7 +32877,7 @@ namespace cimg_library {
3287732877

3287832878
//! Solve a (possibly over- or under-determined) linear system using QR decomposition.
3287932879
/**
32880-
\brief Solve the matrix equation \f$ A\,X = B \f$, where the current instance \fs *this represents \f$ B \f$,
32880+
\brief Solve the matrix equation \f$ A\,X = B \f$, where the current instance \c *this represents \f$ B \f$,
3288132881
and the argument \c A is the system matrix. This method supports both over-determined and
3288232882
under-determined systems by internally performing a QR decomposition.
3288332883

@@ -35427,7 +35427,7 @@ namespace cimg_library {
3542735427

3542835428
//! Add random noise to pixel values.
3542935429
/**
35430-
\param sigma Amplitude of the random additive noise. If \p sigma<0, it stands for a percentage of the
35430+
\param amplitude Amplitude of the random additive noise. If \p sigma<0, it stands for a percentage of the
3543135431
global value range.
3543235432
\param noise_type Type of additive noise (can be \p 0=gaussian, \p 1=uniform, \p 2=Salt and Pepper,
3543335433
\p 3=Poisson or \p 4=Rician).
@@ -36815,7 +36815,7 @@ namespace cimg_library {
3681536815
//! Return palette \e "flag", containing 256 colors entries in RGB.
3681636816
/**
3681736817
\return The following \c 256x1x1x3 colormap is returned:
36818-
\image html ref_palette_flag.jpg
36818+
\image html ref_colormap_flag.jpg
3681936819
**/
3682036820
static const CImg<Tuchar>& flag_LUT256() {
3682136821
static CImg<Tuchar> palette;
@@ -39870,7 +39870,7 @@ namespace cimg_library {
3987039870

3987139871
//! Warp image content by a warping field.
3987239872
/**
39873-
\param warp Warping field.
39873+
\param p_warp Warping field.
3987439874
\param mode Can be { 0=backward-absolute | 1=backward-relative | 2=forward-absolute | 3=foward-relative }
3987539875
\param interpolation Can be <tt>{ 0=nearest | 1=linear | 2=cubic }</tt>.
3987639876
\param boundary_conditions Boundary conditions <tt>{ 0=dirichlet | 1=neumann | 2=periodic | 3=mirror }</tt>.
@@ -41997,8 +41997,8 @@ namespace cimg_library {
4199741997
\param zsize Depth of the resulting image (~0U means 'instance_depth/zstride').
4199841998
\note
4199941999
- The correlation of the image instance \p *this by the kernel \p kernel is defined to be:
42000-
$res(x,y,z) = sum_{i,j,k} (*this)(\alpha_x\;x + \beta_x\;(i - c_x),\alpha_y\;y + \beta_y\;(j -
42001-
c_y),\alpha_z\;z + \beta_z\;(k - c_z))*kernel(i,j,k).$
42000+
\f$ res(x,y,z) = sum_{i,j,k} (*this)(\alpha_x\;x + \beta_x\;(i - c_x),\alpha_y\;y + \beta_y\;(j -
42001+
c_y),\alpha_z\;z + \beta_z\;(k - c_z))*kernel(i,j,k) \f$
4200242002
**/
4200342003
template<typename t>
4200442004
CImg<T>& correlate(const CImg<t>& kernel, const unsigned int boundary_conditions=1,
@@ -42469,8 +42469,8 @@ namespace cimg_library {
4246942469
\param zsize Depth of the resulting image (~0U means 'instance_depth/zstride').
4247042470
\note
4247142471
- The convolution of the image instance \p *this by the kernel \p kernel is defined to be:
42472-
res(x,y,z) = sum_{i,j,k} (*this)(\alpha_x\;x - \beta_x\;(i - c_x),\alpha_y\;y
42473-
- \beta_y\;(j - c_y),\alpha_z\;z - \beta_z\;(k - c_z))*kernel(i,j,k).
42472+
\f$ res(x,y,z) = sum_{i,j,k} (*this)(\alpha_x\;x - \beta_x\;(i - c_x),\alpha_y\;y
42473+
- \beta_y\;(j - c_y),\alpha_z\;z - \beta_z\;(k - c_z))*kernel(i,j,k) \f$.
4247442474
**/
4247542475
template<typename t>
4247642476
CImg<T>& convolve(const CImg<t>& kernel, const unsigned int boundary_conditions=1,
@@ -47502,6 +47502,7 @@ namespace cimg_library {
4750247502
\param[in,out] imag Imaginary part of the pixel values.
4750347503
\param axis Axis along which the FFT is computed.
4750447504
\param is_inverse Tells if the forward (\c false) or inverse (\c true) FFT is computed.
47505+
\param nb_threads Set the maximum number of threads used for FFT computation.
4750547506
**/
4750647507
static void FFT(CImg<T>& real, CImg<T>& imag, const char axis, const bool is_inverse=false,
4750747508
const unsigned int nb_threads=0) {
@@ -49755,6 +49756,8 @@ namespace cimg_library {
4975549756
\param opacity Drawing opacity.
4975649757
\param pattern An integer whose bits describe the line pattern.
4975749758
\param init_hatch Tells if a reinitialization of the hash state must be done.
49759+
\param draw_last_pixel Tells if last pixel of the line must be drawn or not (e.g. can be disabled
49760+
when drawing multi-line curves with transparency).
4975849761
\note
4975949762
- Set \p init_hatch = false to draw consecutive hatched segments without breaking the line pattern.
4976049763
\par Example:
@@ -50832,9 +50835,9 @@ namespace cimg_library {
5083250835
\param y1 Y-coordinate of the second vertex in the image instance.
5083350836
\param x2 X-coordinate of the third vertex in the image instance.
5083450837
\param y2 Y-coordinate of the third vertex in the image instance.
50835-
\param color1 Pointer to \c spectrum() consecutive values of type \c T, defining the color of the first vertex.
50836-
\param color2 Pointer to \c spectrum() consecutive values of type \c T, defining the color of the second vertex.
50837-
\param color3 Pointer to \c spectrum() consecutive values of type \c T, defining the color of the third vertex.
50838+
\param color0 Pointer to \c spectrum() consecutive values of type \c T, defining the color of the first vertex.
50839+
\param color1 Pointer to \c spectrum() consecutive values of type \c T, defining the color of the second vertex.
50840+
\param color2 Pointer to \c spectrum() consecutive values of type \c T, defining the color of the third vertex.
5083850841
\param opacity Drawing opacity.
5083950842
**/
5084050843
template<typename tc>
@@ -52730,8 +52733,8 @@ namespace cimg_library {
5273052733
\param opacity Drawing opacity.
5273152734
\param font_height Height of the text font (exact match for 13,32,64,128, interpolated otherwise).
5273252735
\note To ensure thread-safety, this function uses mutex lock. For real multi-threading drawing of text,
52733-
use another version of `CImg<T>::draw_text()` with argument `font`, that must be a copy of what is returned
52734-
by `CImgList<T>::font()`.
52736+
use another version of \c CImg<T>::draw_text() with argument `font`, that must be a copy of what is returned
52737+
by \c CImgList<T>::font().
5273552738
**/
5273652739
template<typename tc1, typename tc2>
5273752740
CImg<T>& draw_text(const int x0, const int y0,

0 commit comments

Comments
 (0)