Documentation

From VipsWiki

Contents 1 nip2 documentation 1.1 nip2 quickstart 1.2 nip2 guides 2 libvips documentation 3 Publications 4 Old documentation

nip2 documentation

nip2 quickstart

Here are some quick guides to introduce nip2. These guides are part of the nip2 manual: click Help / Contents to view the guide while using the program.

Quick interface tour 

Runs quickly though some easy stuff to show how the interface works.

Infrared reflectogram mosaic tour 

Explains how to use nip2 to build reflectogram mosaics.

Nerd tour 

Goes into some detail about the insides of nip2 and how to program your own widgets.

The vips blog 

Has posts about using nip2 and the development of the system.

https://github.com/jcupitt/libvips and https://github.com/jcupitt/nip2 

All of the sourcecode, and the build systems.

The Examples page summarises the example workspaces that come with nip2. Several of the HOWTO guides are worked examples.

nip2 guides

The following full guides are on-line:

nip2 Users' Guide 

This is an online copy of the documentation included with the program. We have the same thing formatted as PDF.

NIP2 Beginners Guide 

The beginners guide has now been added directly to the wiki here.

libvips documentation

The libvips page has a bullet-point overview of the features. We have the following detailed guides:

• VIPS Manual. Also available as PDF.
• API documentation
• Manual pages for every operation.
• Various Hello World programs
• gtkdisp, a tiny demo program that displays a VIPS image pipeline in a window. C and C++ versions

There's also a package of example code and images for vips 7.10 in the vips-7.10 download area.

We are currently (March 2013) about 80% of the way through a complete rewrite of libvips. The guides above describe the vips7 API which is still there and still supported via a compatibility layer. The vips7 API will continue to be supported for the foreseeable future.

The docs for the new libvips API are here if you're curious. But these are not yet fully nailed down, so be careful.

Publications

Consider referencing one of these in your publications if you use VIPS/nip --- it helps us keep it going.

Martinez, K. and Cupitt, J. (2005) VIPS ― a highly tuned image processing software architecture. In Proceedings of IEEE International Conference on Image Processing 2, pp. 574-577, Genova.

Cupitt, J., Boobis, A., Jones, H. (2007) Automating image analysis with VIPS, Poster presentation, Hounsfield Memorial Lectures on Medical Imaging.

Cupitt, J. and Martinez, K. (1996) VIPS: An image processing system for large images, Proc. SPIE, vol. 2663, pp. 19--28.

Old documentation

We still have the vips-7.22 docs available.