Documentation

From VipsWiki

Revision as of 12:31, 2 December 2009 John (Talk | contribs) (→Nip guides) ← Previous diff		Revision as of 12:48, 30 June 2010 John (Talk | contribs) Next diff →
Line 7:		Line 7:
	while using the program.		while using the program.
-	; [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/html/nipguide/nipguidese1.html Quick interface tour] : Runs quickly though some easy stuff to show how the interface works.	+	; [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/html/nipguide/nipguidese1.html Quick interface tour] : Runs quickly though some easy stuff to show how the interface works.
-	; [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/html/nipguide/nipguidese2.html Infrared reflectogram mosaic tour] : Explains how to use nip2 to build reflectogram mosaics.	+	; [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/html/nipguide/nipguidese2.html Infrared reflectogram mosaic tour] : Explains how to use nip2 to build reflectogram mosaics.
-	; [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/html/nipguide/nipguidese3.html Nerd tour] : Goes into some detail about the insides of nip2 and how to program your own widgets.	+	; [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/html/nipguide/nipguidese3.html Nerd tour] : Goes into some detail about the insides of nip2 and how to program your own widgets.
	The [[Examples]] page summarises the example workspaces that come with nip2. Several of the [[HOWTO]] guides are worked examples.		The [[Examples]] page summarises the example workspaces that come with nip2. Several of the [[HOWTO]] guides are worked examples.
Line 19:		Line 19:
	The following full guides are on-line:		The following full guides are on-line:
-	; [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/html/nipguide/nipguide.html nip2 Users' Guide] : This is an online copy of the documentation included with the program. We have the same thing formatted as [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/pdf/nipguide.pdf PDF].	+	; [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/html/nipguide/nipguide.html nip2 Users' Guide] : This is an online copy of the documentation included with the program. We have the same thing formatted as [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/pdf/nipguide.pdf PDF].
	; [[NIP2 Beginners Guide]] : The beginners guide has now been added directly to the wiki here.		; [[NIP2 Beginners Guide]] : The beginners guide has now been added directly to the wiki here.
Line 25:		Line 25:
	== VIPS documentation ==		== VIPS documentation ==
-	* [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/html/vipsmanual/vipsmanual.html VIPS Manual]. Also available as [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/pdf/vipsmanual.pdf PDF].	+	* [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/html/vipsmanual/vipsmanual.html VIPS Manual]. Also available as [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/pdf/vipsmanual.pdf PDF].
-	* [http://www.vips.ecs.soton.ac.uk/supported/7.20/doc/html/libvips/index.html API documentation]	+	* [http://www.vips.ecs.soton.ac.uk/supported/7.22/doc/html/libvips/index.html API documentation]
	* [http://www.vips.ecs.soton.ac.uk/supported/7.18/doc/html/man Manual pages] for every operation.		* [http://www.vips.ecs.soton.ac.uk/supported/7.18/doc/html/man Manual pages] for every operation.
	* Various [[Hello World]] programs		* Various [[Hello World]] programs

---

Revision as of 12:48, 30 June 2010

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

Nip 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 Examples page summarises the example workspaces that come with nip2. Several of the HOWTO guides are worked examples.

Nip 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.

VIPS documentation

• 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.

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.18 docs available.