diff doc/interpreter/image.txi @ 8148:213dd524f96b

Improve documentation for image I/O.
author sh@sh-laptop
date Thu, 25 Sep 2008 13:43:42 -0400
parents 01fac748b680
children b93ac0586e4b
line wrap: on
line diff
--- a/doc/interpreter/image.txi	Thu Sep 25 13:03:17 2008 -0400
+++ b/doc/interpreter/image.txi	Thu Sep 25 13:43:42 2008 -0400
@@ -26,7 +26,7 @@
 and compute the gradient of the smoothed image.
 
 @example
-I = loadimage ("default.img");
+I = imread ("myimage.jpg");
 S = conv2 (I, ones (5, 5) / 25, "same");
 [Dx, Dy] = gradient (S);
 @end example
@@ -47,20 +47,22 @@
 @section Loading and Saving Images
 
 The first step in most image processing tasks is to load an image
-into Octave. Currently Octave only support saving images in the
-Portable Pixmap Format (PPM), PostScript, and Octave's own format, and
-loading images in Octave's format. Most image processing code will
-follow the structure of this code
+into Octave. This is done using the @code{imread} function, which uses the
+@code{GraphicsMagick} library for reading. This means a vast number of image
+formats is supported.  The @code{imwrite} function is the corresponding function
+for writing images to the disk.
+
+In summary, most image processing code will follow the structure of this code
 
 @example
-I = loadimage ("my_input_image.img");
+I = imread ("my_input_image.img");
 J = process_my_image (I);
-saveimage ("my_output_image.img", J);
+imwrite ("my_output_image.img", J);
 @end example
 
-@DOCSTRING(loadimage)
+@DOCSTRING(imread)
 
-@DOCSTRING(saveimage)
+@DOCSTRING(imwrite)
 
 @DOCSTRING(IMAGE_PATH)