changeset 6535:3ef1aa12f04c

[project @ 2007-04-18 16:17:25 by jwe]
author jwe
date Wed, 18 Apr 2007 16:17:25 +0000
parents 7f56be6b0902
children 3c89a3f9d23e
files doc/ChangeLog doc/interpreter/Makefile.in doc/interpreter/image.txi doc/interpreter/mkcontrib.awk doc/interpreter/octave.texi doc/interpreter/preface.txi doc/interpreter/signal.txi doc/interpreter/stmt.txi
diffstat 8 files changed, 66 insertions(+), 72 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Wed Apr 18 01:00:32 2007 +0000
+++ b/doc/ChangeLog	Wed Apr 18 16:17:25 2007 +0000
@@ -1,3 +1,11 @@
+2007-04-18  John W. Eaton  <jwe@octave.org>
+
+	* interpreter/contributors.in: New file.
+	* interpreter/Makefile.in (contributors.texi): New target.
+	(clean): Also deleete contributors.texi
+	(TEXINFO): Include contributors.texi in the list.
+	(preface.texi): @include contributors.texi.
+
 2007-04-17  David Bateman  <dbateman@free.fr>
 
 	* interpreter/linalg.txi (Techniques used for Linear Algebra):
--- a/doc/interpreter/Makefile.in	Wed Apr 18 01:00:32 2007 +0000
+++ b/doc/interpreter/Makefile.in	Wed Apr 18 16:17:25 2007 +0000
@@ -53,7 +53,7 @@
 
 SUB_TEXINFO := $(SUB_SOURCE:.txi=.texi)
 
-TEXINFO := $(MAIN_TEXINFO) $(SUB_TEXINFO) ../conf.texi
+TEXINFO := $(MAIN_TEXINFO) $(SUB_TEXINFO) contributors.texi ../conf.texi
 
 FORMATTED = octave.dvi octave.ps octave.pdf \
 	octave.info octave.info-[0-9]*
@@ -62,7 +62,7 @@
 MAN_SRC := $(addsuffix .1, $(MAN_BASE))
 
 # FIXME -- need to include generated figures here...
-DISTFILES = Makefile.in dir munge-texi.cc $(MAN_SRC) \
+DISTFILES = Makefile.in contributors.in dir munge-texi.cc $(MAN_SRC) \
   $(SOURCES) $(TEXINFO) $(FORMATTED) $(IMAGES)
 
 DISTDIRS = HTML
@@ -99,7 +99,11 @@
 	$(MAKE) -C ../../scripts DOCSTRINGS
 .PHONY: scripts-DOCSTRINGS
 
-%.texi : %.txi
+contributors.texi: contributors.in
+	$(AWK) -f $(srcdir)/mkcontrib.awk $(srcdir)/contributors.in > $@-t
+	@$(simple-move-if-change-rule)
+
+$(SUB_TEXINFO) : %.texi : %.txi
 	@echo making $@ from $<
 	@./munge-texi \
 	  -d $(TOPDIR)/src/DOCSTRINGS \
@@ -242,7 +246,7 @@
 .PHONY: maintainer-clean
 
 clean-texi:
-	rm -f $(SUB_TEXINFO)
+	rm -f $(SUB_TEXINFO) contributors.texi
 .PHONY: clean-texi
 
 dist: clean-texi all
--- a/doc/interpreter/image.txi	Wed Apr 18 01:00:32 2007 +0000
+++ b/doc/interpreter/image.txi	Wed Apr 18 16:17:25 2007 +0000
@@ -12,15 +12,23 @@
 and compute the gradient of the smoothed image.
 
 @example
-I = loadimage("default.img");
-S = conv2(I, ones(5,5)/25, "same");
-[Dx, Dy] = gradient(S);
+I = loadimage ("default.img");
+S = conv2 (I, ones (5, 5) / 25, "same");
+[Dx, Dy] = gradient (S);
 @end example
 
 @noindent
 In this example @code{S} contains the smoothed image, and @code{Dx}
 and @code{Dy} contains the partial spatial derivatives of the image.
 
+@menu
+* Loading and Saving Images::   
+* Displaying Images::           
+* Representing Images::         
+* Plotting on top of Images::   
+* Color Conversion::            
+@end menu
+
 @node Loading and Saving Images
 @section Loading and Saving Images
 
@@ -31,9 +39,9 @@
 follow the structure of this code
 
 @example
-I = loadimage("my_input_image.img");
-J = process_my_image(I);
-saveimage("my_output_image.img", J);
+I = loadimage ("my_input_image.img");
+J = process_my_image (I);
+saveimage ("my_output_image.img", J);
 @end example
 
 @DOCSTRING(loadimage)
@@ -66,9 +74,9 @@
 
 In general Octave supports four different kinds of images, gray-scale
 images, RGB images, binary images, and indexed images. A gray-scale
-image is represented with a @math{M @times N} matrix in which each
+image is represented with an M-by-N matrix in which each
 element corresponds to the intensity of a pixel. An RGB image is
-represented with a @math{M @times N @times 3} array where each
+represented with an M-by-N-by3 array where each
 3-vector corresponds to the red, green, and blue intensities of each
 pixel.
 
@@ -78,12 +86,12 @@
 @code{uint8} intensities are between 0 and 255, and if it is of class
 @code{uint16} intensities are between 0 and 65535.
 
-A binary image is a @math{M @times N} matrix of class @code{logical}.
+A binary image is a M-by-N matrix of class @code{logical}.
 A pixel in a binary image is black if it is @code{false} and white
 if it is @code{true}.
 
-An indexed image consists of a @math{M @times N} matrix of integers
-and a @math{C @times 3} color map. Each integer corresponds to an
+An indexed image consists of an M-by-N matrix of integers
+and a C-by-3 color map. Each integer corresponds to an
 index in the color map, and each row in the color map corresponds to
 a RGB color. The color map must be of class @code{double} with values
 between 0 and 1.
@@ -119,10 +127,12 @@
 @math{0.99}.
 
 @example
-I = rand(100, 100);
-[row, col] = find(I > 0.99);
-imshow(I);
-hold on, plot(col, row, "ro"); hold off
+I = rand (100, 100);
+[row, col] = find (I > 0.99);
+hold ("on");
+imshow (I);
+plot (col, row, "ro");
+hold ("off");
 @end example
 
 @node Color Conversion
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/interpreter/mkcontrib.awk	Wed Apr 18 16:17:25 2007 +0000
@@ -0,0 +1,12 @@
+{ x[NR] = $0; } END {
+  print "@multitable @columnfractions .33 .33 .33";
+  rem = NR % 3;
+  n = NR - rem;
+  for (i = 1; i <= n; i += 3)
+    printf ("@item %s @tab %s @tab %s\n", x[i], x[i+1], x[i+2]);
+  if (rem == 1)
+    printf ("@item %s\n", x[NR]);
+  else if (rem == 2)
+    printf ("@item %s @tab %s\n", x[NR-1], x[NR]);
+  print "@end multitable";
+}
--- a/doc/interpreter/octave.texi	Wed Apr 18 01:00:32 2007 +0000
+++ b/doc/interpreter/octave.texi	Wed Apr 18 16:17:25 2007 +0000
@@ -448,6 +448,14 @@
 * structaccess::                
 * structintern::                
 
+Image Processing
+
+* Loading and Saving Images::   
+* Displaying Images::           
+* Representing Images::         
+* Plotting on top of Images::   
+* Color Conversion::            
+
 System Utilities
 
 * Timing Utilities::            
--- a/doc/interpreter/preface.txi	Wed Apr 18 01:00:32 2007 +0000
+++ b/doc/interpreter/preface.txi	Wed Apr 18 16:17:25 2007 +0000
@@ -61,55 +61,7 @@
 following people have helped write parts of Octave or helped out in
 various other ways (listed alphbetically).
 
-@noindent
-Andy Adler, Joel Andersson, Muthiah Annamalai,
-Shai Ayal, Roger Banks, Ben Barrowes, Alexander Barth, 
-David Bateman, Heinz Bauschke, Karl Berry, David Billinghurst, 
-Don Bindner, Jakub Bogusz, Marcus Brinkmann, Remy Bruno, 
-Marco Caliari, Daniel Calvelo, John C. Campbell, Jean-Francois Cardoso, 
-Joao Cardoso, Larrie Carr, David Castelow, Vincent Cautaerts, 
-Clinton Chee, Albert Chin-A-Young, J. D. Cole, Martin Costabel, 
-Michael Creel, Jeff Cunningham, Martin Dalecki, Jorge Barros de Abreu,
-Philippe Defert, Bill Denney, David M. Doolin, Pascal A. Dupuis,
-John W. Eaton, Dirk Eddelbuettel, Paul Eggert, Stephen Eglen, Peter Ekberg, 
-Rolf Fabian, Stephen Fegan, Ramon Garcia Fernandez, Torsten Finke, 
-Jose Daniel Munoz Frias, Castor Fu, Eduardo Gallestey, Walter Gautschi, 
-Klaus Gebhardt, Driss Ghaddab, Nicolo Giorgetti,
-Michael Goffioul, Glenn Golden, Tomislav Goles, Keith Goodman, 
-Etienne Grossmann, Kai Habel, William Poetra Yoga Hadisoeseno, Benjamin Hall, 
-Kim Hansen, Soren Hauberg, Daniel Heiserer, Yozo Hida, 
-Roman Hodek, A. Scottedward Hodel, Richard Allan Holcombe, Tom Holroyd, 
-David Hoover, Kurt Hornik, Christopher Hulbert, Cyril Humbert, 
-Teemu Ikonen, Alan W. Irwin, Geoff Jacobsen, Mats Jansson, 
-Cai Jianming, Steven G. Johnson, Heikki Junes, Atsushi Kajita, 
-Mohamed Kamoun, Lute Kamstra, Mumit Khan, Paul Kienzle, 
-Aaron A. King, Arno J. Klaassen, Geoffrey Knauth, Heine Kolltveit, 
-Ken Kouno, Oyvind Kristiansen, Piotr Krzyzanowski, Volker Kuhlmann, 
-Miroslaw Kwasniak, Rafael Laboissiere, Kai Labusch, Claude Lacoursiere, 
-Walter Landry, Duncan Temple Lang, Bill Lash, Dirk Laurie, 
-Maurice LeBrun, Friedrich Leisch, Benjamin Lindner, Ross Lippert, 
-David Livings, Erik de Castro Lopo, Massimo Lorenzin, Hoxide Ma, 
-James Macnicol, Jens-Uwe Mager, Ricardo Marranita, Orestes Mas, 
-Makoto Matsumoto, Laurent Mazet, G. D. McBain, Stefan Monnier, 
-Antoine Moreau, Kai P. Mueller, Victor Munoz, Carmen Navarrete, 
-Todd Neal, Al Niessner, Rick Niles, Takuji Nishimura, 
-Eric Norum, Michael O'Brien, Thorsten Ohl, Arno Onken, 
-Luis F. Ortiz, Luis Ortiz, Scott Pakin, Gabriele Pannocchia, 
-Sylvain Pelissier, Per Persson, Jim Peterson, Danilo Piazzalunga, 
-Nicholas Piper, Hans Ekkehard Plesser, Tom Poage, Orion Poplawski, 
-Ondrej Popp, Jef Poskanzer, Francesco Potorti, James B. Rawlings, 
-Eric S. Raymond, Balint Reczey, Michael Reifenberger, Petter Risholm, 
-Matthew W. Roberts, Andrew Ross, Mark van Rossum, Kevin Ruland, 
-Olli Saarela, Toni Saarela, Juhani Saastamoinen, Ben Sapp, 
-Alois Schloegl, Michel D. Schmid, Nicol N. Schraudolph, Ludwig Schwardt, 
-Daniel J. Sebald, Dmitri A. Sergatskov, Baylis Shanks, Joseph P. Skudlarek, 
-John Smith, Julius Smith, Shan G. Smith, Joerg Specht, 
-Quentin H. Spencer, Christoph Spiel, Richard Stallman, Russell Standish, 
-Doug Stewart, Thomas Stuart, Ariel Tankus, Georg Thimm, 
-Thomas Treichl, Utkarsh Upadhyay, Stefan van der Walt, Peter Van Wieren, 
-James R. Van Zandt, Gregory Vanuxem, Ivana Varekova, Thomas Walter, 
-Olaf Weber, Thomas Weber, Bob Weigel, Andreas Weingessel, 
-Fook Fah Yap, Michael Zeising, Federico Zenith, and Alex Zvoleff.
+@include contributors.texi
 
 Special thanks to the following people and organizations for
 supporting the development of Octave:
--- a/doc/interpreter/signal.txi	Wed Apr 18 01:00:32 2007 +0000
+++ b/doc/interpreter/signal.txi	Wed Apr 18 16:17:25 2007 +0000
@@ -5,10 +5,6 @@
 @node Signal Processing
 @chapter Signal Processing
 
-I hope that someday Octave will include more signal processing
-functions.  If you would like to help improve Octave in this area,
-please contact @email{bug@@octave.org}.
-
 @DOCSTRING(detrend)
 
 @DOCSTRING(fft)
--- a/doc/interpreter/stmt.txi	Wed Apr 18 01:00:32 2007 +0000
+++ b/doc/interpreter/stmt.txi	Wed Apr 18 16:17:25 2007 +0000
@@ -290,6 +290,10 @@
 endswitch
 @end example
 
+@menu
+* Notes for the C programmer::  
+@end menu
+
 @node Notes for the C programmer
 @subsection Notes for the C programmer