libvips

vips_black ()

int
vips_black (VipsImage **out,
            int width,
            int height,
            ...);

Optional arguments:

Make a black unsigned char image of a specified size.

See also: vips_xyz(), vips_text(), vips_gaussnoise().

vips_xyz ()

int
vips_xyz (VipsImage **out,
          int width,
          int height,
          ...);

Optional arguments:

Create a two-band uint32 image where the elements in the first band have the value of their x coordinate and elements in the second band have their y coordinate.

You can make any image where the value of a pixel is a function of its (x, y) coordinate by combining this operator with the arithmetic operators.

Set csize , dsize , esize to generate higher dimensions and add more bands. The extra dimensions are placed down the vertical axis. Use vips_grid() to change the layout.

See also: vips_grey(), vips_grid(), vips_identity().

vips_grey ()

int
vips_grey (VipsImage **out,
           int width,
           int height,
           ...);

Optional arguments:

Create a one-band float image with the left-most column zero and the right-most 1. Intermediate pixels are a linear ramp.

Set uchar to output a uchar image with the leftmost pixel 0 and the rightmost 255.

See also: vips_xyz(), vips_identity().

vips_gaussmat ()

int
vips_gaussmat (VipsImage **out,
               double sigma,
               double min_ampl,
               ...);

Optional arguments:

Creates a circularly symmetric Gaussian image of radius sigma . The size of the mask is determined by the variable min_ampl ; if for instance the value .1 is entered this means that the produced mask is clipped at values less than 10 percent of the maximum amplitude.

The program uses the following equation:

H(r) = exp(-(r * r) / (2 * sigma * sigma ))

The generated image has odd size and its maximum value is normalised to 1.0, unless precision is VIPS_PRECISION_INTEGER.

If separable is set, only the centre horizontal is generated. This is useful for separable convolutions.

If precision is VIPS_PRECISION_INTEGER, an integer gaussian is generated. This is useful for integer convolutions.

"scale" is set to the sum of all the mask elements.

See also: vips_logmat(), vips_conv().

vips_logmat ()

int
vips_logmat (VipsImage **out,
             double sigma,
             double min_ampl,
             ...);

Optional arguments:

Creates a circularly symmetric Laplacian of Gaussian mask of radius sigma . The size of the mask is determined by the variable min_ampl ; if for instance the value .1 is entered this means that the produced mask is clipped at values within 10 percent of zero, and where the change between mask elements is less than 10%.

The program uses the following equation: (from Handbook of Pattern Recognition and image processing by Young and Fu, AP 1986 pages 220-221):

H(r) = (1 / (2 * M_PI * s4)) * (2 - (r2 / s2)) * exp(-r2 / (2 * s2))

where s2 = sigma * sigma , s4 = s2 * s2, r2 = r * r.

The generated mask has odd size and its maximum value is normalised to 1.0, unless precision is VIPS_PRECISION_INTEGER.

If separable is set, only the centre horizontal is generated. This is useful for separable convolutions.

If precision is VIPS_PRECISION_INTEGER, an integer mask is generated. This is useful for integer convolutions.

"scale" is set to the sum of all the mask elements.

See also: vips_gaussmat(), vips_conv().

vips_text ()

int
vips_text (VipsImage **out,
           const char *text,
           ...);

Optional arguments:

Draw the string text to an image. out is normally a one-band 8-bit unsigned char image, with 0 for no text and 255 for text. Values between are used for anti-aliasing.

Set rgba to enable RGBA output. This is useful for colour emoji rendering, or support for pango markup features like <span foreground="red">Red!</span>.

text is the text to render as a UTF-8 string. It can contain Pango markup, for example <i>The</i>Guardian.

font is the font to render with, as a fontconfig name. Examples might be sans 12 or perhaps bitstream charter bold 10.

You can specify a font to load with fontfile . You'll need to also set the name of the font with font .

width is the number of pixels to word-wrap at. By default, lines of text wider than this will be broken at word boundaries. Use wrap to set lines to wrap on word or character boundaries, or to disable line breaks.

Set justify to turn on line justification. align can be used to set the alignment style for multi-line text to the low (left) edge centre, or high (right) edge. Note that the output image can be wider than width if there are no word breaks, or narrower if the lines don't break exactly at width .

height is the maximum number of pixels high the generated text can be. This only takes effect when dpi is not set, and width is set, making a box. In this case, vips_text() will search for a dpi and set of line breaks which will just fit the text into width and height .

You can use autofit_dpi to read out the DPI selected by auto fit.

dpi sets the resolution to render at. "sans 12" at 72 dpi draws characters approximately 12 pixels high.

spacing sets the line spacing, in points. It would typically be something like font size times 1.2.

You can read the coordinate of the top edge of the character from Xoffset / Yoffset. This can be helpful if you need to line up the output of several vips_text().

See also: vips_bandjoin(), vips_composite().

vips_gaussnoise ()

int
vips_gaussnoise (VipsImage **out,
                 int width,
                 int height,
                 ...);

Optional arguments:

Make a one band float image of gaussian noise with the specified distribution. The noise distribution is created by averaging 12 random numbers with the appropriate weights.

See also: vips_black(), vips_xyz(), vips_text().

vips_eye ()

int
vips_eye (VipsImage **out,
          int width,
          int height,
          ...);

Optional arguments:

Create a test pattern with increasing spatial frequency in X and amplitude in Y. factor should be between 0 and 1 and determines the maximum spatial frequency.

Set uchar to output a uchar image.

See also: vips_zone().

vips_sines ()

int
vips_sines (VipsImage **out,
            int width,
            int height,
            ...);

Optional arguments:

Creates a float one band image of the a sine waveform in two dimensions.

The number of horizontal and vertical spatial frequencies are determined by the variables hfreq and vfreq respectively. The function is useful for creating displayable sine waves and square waves in two dimensions.

If horfreq and verfreq are integers the resultant image is periodical and therefore the Fourier transform does not present spikes

Pixels are normally in [-1, +1], set uchar to output [0, 255].

See also: vips_grey(), vips_xyz().

vips_zone ()

int
vips_zone (VipsImage **out,
           int width,
           int height,
           ...);

Optional arguments:

Create a one-band image of a zone plate.

Pixels are normally in [-1, +1], set uchar to output [0, 255].

See also: vips_eye(), vips_xyz().

vips_sdf ()

int
vips_sdf (VipsImage **out,
          int width,
          int height,
          VipsSdfShape shape,
          ...);

Optional arguments:

Create a signed distance field (SDF) image of the given shape. Different shapes use different combinations of the optional arguments, see below.

shape VIPS_SDF_SHAPE_CIRCLE: create a circle centred on a , radius r .

shape VIPS_SDF_SHAPE_BOX: create a box with top-left corner a and bottom-right corner b .

shape VIPS_SDF_SHAPE_ROUNDED_BOX: create a box with top-left corner a and bottom-right corner b , whose four corners are rounded by the four-element float array corners . corners will default to 0.0.

shape VIPS_SDF_SHAPE_LINE: draw a line from a to b .

See also: vips_grey(), vips_grid(), vips_xyz().

vips_identity ()

int
vips_identity (VipsImage **out,
               ...);

Optional arguments:

Creates an identity lookup table, ie. one which will leave an image unchanged when applied with vips_maplut(). Each entry in the table has a value equal to its position.

Use the arithmetic operations on these tables to make LUTs representing arbitrary functions.

Normally LUTs are 8-bit. Set ushort to create a 16-bit table.

Normally 16-bit tables have 65536 entries. You can set this smaller with size .

See also: vips_xyz(), vips_maplut().

vips_buildlut ()

int
vips_buildlut (VipsImage *in,
               VipsImage **out,
               ...);

This operation builds a lookup table from a set of points. Intermediate values are generated by piecewise linear interpolation. The lookup table is always of type VIPS_FORMAT_DOUBLE, use vips_cast() to change it to the type you need.

For example, consider this 2 x 2 matrix of (x, y) coordinates:

We then generate a 1 x 256 element LUT like this:

This is then written as the output image, with the left column giving the index in the image to place the value.

The (x, y) points don't need to be sorted: we do that. You can have several Ys, each becomes a band in the output LUT. You don't need to start at zero, any integer will do, including negatives.

See also: vips_identity(), vips_invertlut(), vips_cast(), vips_maplut().

[method]

vips_invertlut ()

int
vips_invertlut (VipsImage *in,
                VipsImage **out,
                ...);

Optional arguments:

Given a mask of target values and real values, generate a LUT which will map reals to targets. Handy for linearising images from measurements of a colour chart. All values in [0,1]. Piecewise linear interpolation, extrapolate head and tail to 0 and 1.

Eg. input like this:

Means a patch with 10% reflectance produces an image with 20% in channel 1, 30% in channel 2, and 10% in channel 3, and so on.

Inputs don't need to be sorted (we do that). Generate any precision LUT, default to 256 elements.

It won't work too well for non-monotonic camera responses (we should fix this). Interpolation is simple piecewise linear; we ought to do something better really.

See also: vips_buildlut().

[method]

vips_tonelut ()

int
vips_tonelut (VipsImage **out,
              ...);

Optional arguments:

vips_tonelut() generates a tone curve for the adjustment of image levels. It is mostly designed for adjusting the L* part of a LAB image in a way suitable for print work, but you can use it for other things too.

The curve is an unsigned 16-bit image with (in_max + 1) entries, each in the range [0, out_max ].

Lb , Lw are expressed as 0-100, as in LAB colour space. You specify the scaling for the input and output images with the in_max and out_max parameters.

vips_mask_ideal ()

int
vips_mask_ideal (VipsImage **out,
                 int width,
                 int height,
                 double frequency_cutoff,
                 ...);

Optional arguments:

Make an ideal high- or low-pass filter, that is, one with a sharp cutoff positioned at frequency_cutoff , where frequency_cutoff is in the range 0 - 1.

This operation creates a one-band float image of the specified size. The image has values in the range [0, 1] and is typically used for multiplying against frequency domain images to filter them. Masks are created with the DC component at (0, 0). The DC pixel always has the value 1.0.

Set nodc to not set the DC pixel.

Set optical to position the DC component in the centre of the image. This makes the mask suitable for multiplying against optical Fourier transforms. See vips_wrap().

Set reject to invert the sense of the filter. For example, low-pass becomes low-reject.

Set uchar to output an 8-bit unsigned char image rather than a float image. In this case, pixels are in the range [0 - 255].

See also: vips_mask_ideal(), vips_mask_ideal_ring(), vips_mask_ideal_band(), vips_mask_butterworth(), vips_mask_butterworth_ring(), vips_mask_butterworth_band(), vips_mask_gaussian(), vips_mask_gaussian_ring(), vips_mask_gaussian_band().

vips_mask_ideal_ring ()

int
vips_mask_ideal_ring (VipsImage **out,
                      int width,
                      int height,
                      double frequency_cutoff,
                      double ringwidth,
                      ...);

Optional arguments:

Make an ideal ring-pass or ring-reject filter, that is, one with a sharp ring positioned at frequency_cutoff of width width , where frequency_cutoff and width are expressed as the range 0 - 1.

See also: vips_mask_ideal().

vips_mask_ideal_band ()

int
vips_mask_ideal_band (VipsImage **out,
                      int width,
                      int height,
                      double frequency_cutoff_x,
                      double frequency_cutoff_y,
                      double radius,
                      ...);

Optional arguments:

Make an ideal band-pass or band-reject filter, that is, one with a sharp cutoff around the point frequency_cutoff_x , frequency_cutoff_y , of size radius .

See also: vips_mask_ideal().

vips_mask_butterworth ()

int
vips_mask_butterworth (VipsImage **out,
                       int width,
                       int height,
                       double order,
                       double frequency_cutoff,
                       double amplitude_cutoff,
                       ...);

Optional arguments:

Make an butterworth high- or low-pass filter, that is, one with a variable, smooth transition positioned at frequency_cutoff , where frequency_cutoff is in range 0 - 1. The shape of the curve is controlled by order --- higher values give a sharper transition. See Gonzalez and Wintz, Digital Image Processing, 1987.

See also: vips_mask_ideal().

vips_mask_butterworth_ring ()

int
vips_mask_butterworth_ring (VipsImage **out,
                            int width,
                            int height,
                            double order,
                            double frequency_cutoff,
                            double amplitude_cutoff,
                            double ringwidth,
                            ...);

Optional arguments:

Make a butterworth ring-pass or ring-reject filter, that is, one with a variable, smooth transition positioned at frequency_cutoff of width width , where frequency_cutoff is in the range 0 - 1. The shape of the curve is controlled by order --- higher values give a sharper transition. See Gonzalez and Wintz, Digital Image Processing, 1987.

See also: vips_mask_ideal().

vips_mask_butterworth_band ()

int
vips_mask_butterworth_band (VipsImage **out,
                            int width,
                            int height,
                            double order,
                            double frequency_cutoff_x,
                            double frequency_cutoff_y,
                            double radius,
                            double amplitude_cutoff,
                            ...);

Optional arguments:

Make an butterworth band-pass or band-reject filter, that is, one with a variable, smooth transition positioned at frequency_cutoff_x , frequency_cutoff_y , of radius radius . The shape of the curve is controlled by order --- higher values give a sharper transition. See Gonzalez and Wintz, Digital Image Processing, 1987.

See also: vips_mask_ideal().

vips_mask_gaussian ()

int
vips_mask_gaussian (VipsImage **out,
                    int width,
                    int height,
                    double frequency_cutoff,
                    double amplitude_cutoff,
                    ...);

Optional arguments:

Make a gaussian high- or low-pass filter, that is, one with a variable, smooth transition positioned at frequency_cutoff .

See also: vips_mask_ideal().

vips_mask_gaussian_ring ()

int
vips_mask_gaussian_ring (VipsImage **out,
                         int width,
                         int height,
                         double frequency_cutoff,
                         double amplitude_cutoff,
                         double ringwidth,
                         ...);

Optional arguments:

Make a gaussian ring-pass or ring-reject filter, that is, one with a variable, smooth transition positioned at frequency_cutoff of width ringwidth .

See also: vips_mask_ideal().

vips_mask_gaussian_band ()

int
vips_mask_gaussian_band (VipsImage **out,
                         int width,
                         int height,
                         double frequency_cutoff_x,
                         double frequency_cutoff_y,
                         double radius,
                         double amplitude_cutoff,
                         ...);

Optional arguments:

Make a gaussian band-pass or band-reject filter, that is, one with a variable, smooth transition positioned at frequency_cutoff_x , frequency_cutoff_y , of radius radius .

See also: vips_mask_ideal().

vips_mask_fractal ()

int
vips_mask_fractal (VipsImage **out,
                   int width,
                   int height,
                   double fractal_dimension,
                   ...);

Optional arguments:

This operation should be used to create fractal images by filtering the power spectrum of Gaussian white noise. See vips_gaussnoise().

See also: vips_mask_ideal().

vips_fractsurf ()

int
vips_fractsurf (VipsImage **out,
                int width,
                int height,
                double fractal_dimension,
                ...);

Generate an image of size width by height and fractal dimension fractal_dimension . The dimension should be between 2 and 3.

See also: vips_gaussnoise(), vips_mask_fractal().

vips_worley ()

int
vips_worley (VipsImage **out,
             int width,
             int height,
             ...);

Optional arguments:

Create a one-band float image of Worley noise. See:

https://en.wikipedia.org/wiki/Worley_noise

Use cell_size to set the size of the cells from which the image is constructed. The default is 256 x 256.

If width and height are multiples of cell_size , the image will tessellate.

See also: vips_perlin(), vips_fractsurf(), vips_gaussnoise().

vips_perlin ()

int
vips_perlin (VipsImage **out,
             int width,
             int height,
             ...);

Optional arguments:

Create a one-band float image of Perlin noise. See:

https://en.wikipedia.org/wiki/Perlin_noise

Use cell_size to set the size of the cells from which the image is constructed. The default is 256 x 256.

If width and height are multiples of cell_size , the image will tessellate.

Normally, output pixels are VIPS_FORMAT_FLOAT in the range [-1, +1]. Set uchar to output a uchar image with pixels in [0, 255].

See also: vips_worley(), vips_fractsurf(), vips_gaussnoise().

enum VipsTextWrap

Sets the word wrapping style for vips_text() when used with a maximum width.

See also: vips_text().

enum VipsSdfShape

The SDF to generate,

See also: vips_sdf().