Next: 2. VIPS packages Up: refguide Previous: List of Tables Contents

# 1. Introduction

This document introduces the functions available in the VIPS image processing library. For detailed information on particular functions, refer to the UNIX on-line manual pages. Enter (for example):

    example% man im_abs

for information on the function `im_abs()`.

You can also use the `vips` program to get some information on functions, see figure 1.1.

Figure 1.1: Using the vips program to get information on functions

Once you have found a function you need to use, you can call it from a C program (see the VIPS Application Programmers' Guide), you can call it from C++ (see the VIPS C++ Programmers' Guide), you can call it from the `nip` ((see the nip Users' Guide), or SIAM graphical user-interfaces, or you can run it from the UNIX command line with the `vips` program. For example:

    john% vips im_vips2tiff cam.v t1.tif none
    john% vips im_tiff2vips t1.tif t2.v.v 0
    john% vips im_equal cam.v t2.v t3.v
    john% vips im_min t3.v
    255

VIPS may have been set up at your site with a set of links which call the vips program automatically. You may also be able to type:

    john% im_vips2tiff cam.v t1.tif none
    john% im_tiff2vips t1.tif t2.v.v 0
    john% im_equal cam.v t2.v t3.v
    john% im_min t3.v

There are a few VIPS functions which you cannot run with `vips`, either because their arguments are a very strange, or because they are complete mini-applications (like `vips2dj`). These programs are listed in table 1.1, see the man pages for full details.

Table 1.1: Miscellaneous programs

Name | Description
`batch_crop` | Crop a lot of images
`batch_image_convert` | File format convert a lot of images
`batch_rubber_sheet` | Warp a lot of images
`binfile` | Read headerless image
`cooc_features` | Calculate features of a co-occurence matrix
`cooc` | Calculate a co-occurence matrix
`debugim` | Print an image pixel by pixel
`edvips` | Change fields in an image header
`find_mosaic` | Analyse a set of images for overlaps
`glds_features` | Calculate features of a grey-level distribution matrix
`glds` | Calculate a grey-level distribution matrix
`header` | Print fields from a VIPS image header
`light_correct` | Correct a set of images for shading errors
`mergeup` | Join a set of images together
`mitsub` | Format a VIPS image for output to a Mitsubishi 3600
`printlines` | Print an image a line at a time
`shrink_width` | Shrink to a specific width
`simcontr` | Demonstrate simultaneous contrast
`sines` | Generate a sinusoidal test pattern
`spatres` | Generate a spatial resolution test pattern
`squares` | Generate some squares
`vdump` | VIPS to mono Postscript
`vips-7.10` | VIPS shell interface
`vips2dj` | VIPS to high-quality colour Postscript
`vips` | VIPS universal main program

Next: 2. VIPS packages Up: refguide Previous: List of Tables Contents