From f07e517474d076d4badb6298c2e1b87af7560b70 Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Thu, 26 Mar 2009 17:05:40 +0000 Subject: [PATCH] stuff --- TODO | 11 +++++++++++ doc/src/cppintro.tex | 14 +++++++------- doc/src/fileformat.tex | 10 +++++----- doc/src/vimage.tex | 12 ++++++------ 4 files changed, 29 insertions(+), 18 deletions(-) diff --git a/TODO b/TODO index 489cd202..d24ad505 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,16 @@ +- VipsFormat.3 man page should list all formats, since eg. radiance does not + have a separate im_rad2vips page + + also matlab read + +- need man pages for im_affinei, im_affinei_all + + page for VipsInterpolate.3? along the lines of VipsFormat + - read through docs for 7.18 stuff + :set spell + - update function list in refs WONTFIX for 7.18 diff --git a/doc/src/cppintro.tex b/doc/src/cppintro.tex index c1495c84..20bea9b9 100644 --- a/doc/src/cppintro.tex +++ b/doc/src/cppintro.tex @@ -7,7 +7,8 @@ far easier to use: almost all creation, destruction and error handling issues are handled for you automatically. The Python interface is a very simple wrapping of this C++ API generated -automatically with SWIG. The two interfaces are identical, except for language +automatically with SWIG. It adds a few utility methods noted below, but +otherwise the two interfaces are identical other than language syntax. \subsection{If you've used the C API} @@ -19,7 +20,7 @@ A typical build line for the C++ program might be: \begin{verbatim} g++ invert.cc \ - `pkg-config vipsCC-7.14 \ + `pkg-config vipsCC-7.18 \ --cflags --libs` \end{verbatim} @@ -50,10 +51,9 @@ later. If you run this program with a bad input file, for example, you get the following output: \begin{verbatim} -example% invert jim fred -invert: VIPS error: im_open: - "jim" is not a supported - format +$ invert jim fred +invert: VIPS error: format_for_file: + file "jim" not found \end{verbatim} \end{itemize} @@ -69,7 +69,7 @@ main (int argc, char **argv) if (argc != 3) { std::cerr << "usage: " << argv[0] << " infile outfile\n"; - exit (1); + return (1); } try diff --git a/doc/src/fileformat.tex b/doc/src/fileformat.tex index 6e15e14c..a8fabbe6 100644 --- a/doc/src/fileformat.tex +++ b/doc/src/fileformat.tex @@ -6,8 +6,8 @@ but the VIPS format is not widely used and you may have problems reading your images into other packages. If you intend to keep an image, it's much better to save it as TIFF, -JPEG, PNG or PBM/PGM/PPM. VIPS can transparently read and write all these -formats. +JPEG, PNG, PBM/PGM/PPM or HDR. VIPS can transparently read and write all +these formats. \subsection{VIPS file header} \label{sec:header} @@ -26,7 +26,7 @@ The \ct{Type} field, the \ct{Xres}/\ct{Yres} fields, and the (if you convert an image to \cielab{} colour space with \ct{im\_XYZ2Lab()}, for example, VIPS will set \ct{Type} to be \ct{IM\_TYPE\_LAB}), but never uses these values itself in determining the action of an image processing -function. These fields are to help the user, and to help application +function. These fields are to help the user and to help application programs built on VIPS which are trying to present image data to the user in a meaningful way. @@ -141,8 +141,8 @@ complex number. All values are stored in the host-machine's native number representation (that is, either most-significant first, as in SPARC and 680x0 machines, or -least-significant first, for Intel and DEC machines). The VIPS library will -automatically byte-swap for you if necessary, but this can be slow. +least-significant first, for Intel and DEC machines). If necessary, the VIPS +library will automatically byte-swap for you during read. \subsection{Storage formats} diff --git a/doc/src/vimage.tex b/doc/src/vimage.tex index b1438ca6..10be1d96 100644 --- a/doc/src/vimage.tex +++ b/doc/src/vimage.tex @@ -25,7 +25,7 @@ The named image file is opened read-only. This is the default mode. \item[\texttt{"w"}] A \verb+VImage+ is created which, when written to, will write pixels to disc -in the specified file. +in the specified file. Any existing file of this name is deleted. \item[\texttt{"t"}] As the \verb'"w"' mode, but pixels written to the \verb+VImage+ will be saved @@ -38,8 +38,8 @@ see~\pref{sec:compute}. \item[\texttt{"rw"}] As the \verb'"r"' mode, but the image is mapped into your address space -read-write. This mode is only provided for the use of paintbox-style -applications, which need to directly modify an image. See \pref{sec:inplace}. +read-write. This mode is useful for paintbox-style +applications which need to directly modify an image. See \pref{sec:inplace}. \end{description} @@ -68,7 +68,7 @@ from another image processing system), and the second makes a \verb+VImage+ from an \verb+IMAGE+. In both these two cases, the VIPS C++ API does not assume responsibility -for the resouces: it's up to you to make sure the buffer is freed. +for the resources: it's up to you to make sure the buffer is freed. The Python interface adds the usual \verb+frombuffer+ and \verb+fromstring+ methods. @@ -126,7 +126,7 @@ Writing to the descriptor \verb+out+ will cause a TIFF image to be written to disc with deflate compression. See the manual page for \verb+im_open(3)+ for details of all the file formats -and conversions available. See the man page for \verb+im_format(3)+ for a +and conversions available. See the man page for \verb+VipsFormat(3)+ for a lower-level API which lets you control more of the detail of reading and writing data and is more suitable for large files. @@ -232,7 +232,7 @@ See also \verb+frombuffer+ and \verb+fromstring+ above. \subsection{Assignment} -\verb+VImage+ defines copy and assignment, with reference-counted +\verb+VImage+ defines copy and assignment, with reference-counted, pointer-style semantics. For example, if you write: \begin{verbatim}