diff options
author | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2007-04-01 19:41:20 +0000 |
---|---|---|
committer | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2007-04-01 19:41:20 +0000 |
commit | e08af64f639fed5202c9830389ba68ccfa052bcd (patch) | |
tree | 777c63c48698e4eff3931de0d0ea07541628e634 | |
parent | 0489fedf1457a3752d22ef00ba37703e4ee27474 (diff) | |
download | netpbm-mirror-e08af64f639fed5202c9830389ba68ccfa052bcd.tar.gz netpbm-mirror-e08af64f639fed5202c9830389ba68ccfa052bcd.tar.xz netpbm-mirror-e08af64f639fed5202c9830389ba68ccfa052bcd.zip |
"miscellaneous update"
git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@272 9d0c8265-081b-0410-96cb-a4ca84ce46f8
-rw-r--r-- | pamdice.html | 4 | ||||
-rw-r--r-- | pamundice.html | 225 | ||||
-rw-r--r-- | pnmindex.html | 67 | ||||
-rw-r--r-- | pnmtile.html | 34 |
4 files changed, 275 insertions, 55 deletions
diff --git a/pamdice.html b/pamdice.html index 28d45778..0659e157 100644 --- a/pamdice.html +++ b/pamdice.html @@ -66,7 +66,7 @@ also use <P><B>pnmcat</B>. than the whole image to process. For example, you might have an image so large that an image editor can't read it all into memory or processes it very slowly. With <b>pamdice</b>, you can split it into smaller pieces, -edit one a time, and then reassemble them. +edit one at a time, and then reassemble them. <p>Another use for this is to print a large image in small printer-sized pieces that you can glue together. <b>ppmglobe</b> does a similar thing; @@ -126,6 +126,8 @@ pixels. By default, there is no overlap. <H2 id="history">HISTORY</H2> +<p><b>pamdice</b> was new in Netpbm 9.25 (March 2002). + <p>Before Netpbm 10.29 (August 2005), there was a limit of 100 slices in each direction. diff --git a/pamundice.html b/pamundice.html new file mode 100644 index 00000000..801d34cc --- /dev/null +++ b/pamundice.html @@ -0,0 +1,225 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<HTML><HEAD><TITLE>Pamdice User Manual</TITLE></HEAD> +<BODY> +<H1>pamdice</H1> +Updated: 1 April 2007 +<BR> +<A HREF="#index">Table Of Contents</A> + +<H2>NAME</H2> + +pamundice - combine grid of images (tiles) into one + +<h2 id="example">EXAMPLE</h2> + +<pre> +<kbd> + $ pamdice myimage.ppm -outstem=myimage_part -width=10 -height=8 + $ pamundice myimage_part_%1d_%1a.ppm -across=10 -down=8 >myimage.ppm + + $ pamundice myimage.ppm myimage_part_%2a -across=13 -hoverlap=9 +</kbd> +</pre> + + +<H2 id="synopsis">SYNOPSIS</H2> + +<B>pamundice</B> + +[<B>-across=</B><I>n</I>] + +[<B>-down=</B><I>n</I>] + +[<B>-hoverlap=</B><I>pixels</I>] + +[<B>-voverlap=</B><I>pixels</I>] + +[<B>-verbose</B>] + +<i>input_filename_pattern</i> + + +<P>You can use the minimum unique abbreviation of the options. You can use +two hyphens instead of one. You can separate an option name from its value +with white space instead of an equals sign. + +<H2 id="description">DESCRIPTION</H2> + +<p>This program is part of <a href="index.html">Netpbm</a>. + +<p><b>pamundice</b> reads a bunch of PAM, PBM, PGM, or PPM images as +input and combines them as a grid of tiles into a single output +image of the same kind on Standard Output. + +<p>You can optionally make the pieces overlap. + +<P>See the <i>input_filename_pattern</i> argument for information on +naming of the input files. + +<p>The input images must all have the same format (PAM, PPM, etc.) +and maxval and for PAM must have the same depth and tuple type. +All the images in a rank (horizontal row of tiles) must have the +same height. All the images in a file (vertical column of tiles) +must have the same width. But it is not required that every rank +have the same height or every file have the same width. + +<p><b>pamdice</b> is the inverse of <b>pamundice</b>. You can use +<b>pamundice</b> to reassemble an image sliced up by <b>pamdice</b>. +You can use <b>pamdice</b> to recreate the tiles of an image created +by <b>pamundice</b>, but to do this the original ranks must all have +been the same height except for the bottom one and the original files +must all have been the same width except the right one. + +<p>One use for this is to make pieces that take less computer +resources than the whole image to process. For example, you might +have an image so large that an image editor can't read it all into +memory or processes it very slowly. You can split it into smaller +pieces with <b>pamdice</b>, edit one at a time, and then reassemble them +with <b>pamundice</b>. + +<p>An alternative to join images in a single direction (i.e. a single +rank or a single file) is <b>pnmcat</b>. <b>pnmcat</b> gives you more +flexibility than <b>pamundice</b> in identifying the input images: you +can supply them on Standard Input or as a list of arbitrarily named +files. + +<p>To join piecewise photographs, use <b>pnmstitch</b> instead of +<b>pamundice</b>, because it figures out where the pieces overlap, +even if they don't overlap exactly vertically or horizontally. + +<p>To create an image of the same tile repeated in a grid, that's +<b>pnmtile</b>. + +<p><b>pnmindex</b> does a similar thing to <b>pamundice</b>: it +combines a bunch of small images in a grid into a big one. But its +purpose is to produce a an index image of the input images. So it +leaves space between them and has labels for them, for example. + +<h2 id="arguments">ARGUMENTS</h2> + +<p>There is one non-option argument, and it is mandatory: +<i>input_filename_pattern</i>. This tells <b>pamundice</b> what files +contain the input tiles. + +<p><b>pamundice</b> reads the input images from files which are named +with a pattern that indicates their positions in the combined image. +For example, <b>tile_00_05.ppm</b> could be the 6th tile over in the +1st rank, while <b>tile_04_01</b> is the 2nd tile over in the 5th rank. + +<p>You cannot supply any of the data on Standard Input, and the files +must be the kind that <b>pamundice</b> can close and reopen and read +the same image a second time (e.g. a regular file is fine; a named +pipe is probably not). + +<p><i>input_filename_pattern</i> is a printf-style pattern. (See the +standard C library <b>printf</b> subroutine). For the example above, +it would be <b>tile_%2d_%2a.ppm</b>. The only possible conversion +specifiers are: + +<dl> + +<dt><b>d</b> +<dd>"down": The rank (row) number, starting with 0. + +<dt><b>a</b> +<dd>"across": The file (column) number, starting with 0. + +<dt><b>%</b> +<dd>The per cent character (%). + +</dl> + +<p>The number between the % and the conversion specifier is the +precision and is required. It says how many characters of the file +name are described by that conversion. The rank or file number is +filled with leading zeroes as necessary. + +<p>So the example <b>tile_%2d_%2a.ppm</b> means to get the name of +the file that contains the tile at Rank 0, File 5, you: + +<ul> + +<li>replace the "%2d" with the rank number, as a 2 digit +decimal number: "00" + +<li>Replace the "%2a" with the file number, as a 2 digit +decimal number: "05" +</ul> + +<p>Note that this pattern describes file names that <b>pamdice</b> +produces, except that the precision may be more or less. +(<b>pamdice</b> uses however many digits are required for the highest +numbered image). + + +<H2 id="options">OPTIONS</H2> + +<DL COMPACT> +<DT><B>-across=</B><I>N</I> + +<DD>This is the number of tiles across in the grid, i.e. the number of +tiles in each rank, or the number of files. + +<p>Default is 1. + + +<DT><B>-down=</B><I>N</I> + +<DD>This is the number of tiles up and down in the grid, i.e. the +number of tiles in each file, or the number of ranks. + +<p>Default is 1. + +<DT><B>-hoverlap=</B><I>pixels</I> + +<DD>This is the amount in pixels to overlap the tiles horizontally. +<b>pamundice</b> clips this much off the right edge of every tile +before joining it to the adjacent image to the right. The tiles along +the right edge remain whole. + +<p>There must not be any input image narrower than this. + +<p>Note that this undoes the effect of the same <b>-hoverlap</b> +option of <b>pamdice</b>. + +<p>Default is zero -- no overlap. + +<DT><B>-voverlap=</B><I>pixels</I> + +<DD>This is analogous to <b>-hoverlap</b>, but <b>pamundice</b> +clips the bottom edge of each image before joining it to the one below. + +<DT><B>-verbose</B> + +<DD>Print information about the processing to Standard Error. + +</DL> + +<H2 id="history">HISTORY</H2> + +<p><b>pamundice</b> was new in Netpbm 10.39 (June 2007). Before that, +<b>pnmcat</b> is the best substitute. + + +<H2 id="seealso">SEE ALSO</H2> + +<B><A HREF="pamdice.html">pamundice</A></B>, +<B><A HREF="pnmcat.html">pnmcat</A></B>, +<B><A HREF="pnmindex.html">pnmindex</A></B>, +<B><A HREF="pnmtile.html">pnmtile</A></B>, +<B><A HREF="pnm.html">pnm</A></B> +<B><A HREF="pam.html">pnm</A></B> + +<HR> +<H2 id="index">Table Of Contents</H2> +<UL> +<LI><A HREF="#example">EXAMPLE</A> +<LI><A HREF="#synopsis">SYNOPSIS</A> +<LI><A HREF="#description">DESCRIPTION</A> +<LI><A HREF="#options">ARGUMENTS</A> +<LI><A HREF="#options">OPTIONS</A> +<LI><A HREF="#history">HISTORY</A> +<LI><A HREF="#seealso">SEE ALSO</A> +</UL> +</BODY> +</HTML> diff --git a/pnmindex.html b/pnmindex.html index 5512ae4b..220495c8 100644 --- a/pnmindex.html +++ b/pnmindex.html @@ -2,69 +2,68 @@ <HTML><HEAD><TITLE>Pnmindex User Manual</TITLE></HEAD> <BODY> <H1>pnmindex</H1> -Updated: 9 January 1991 +Updated: 1 April 2007 <BR> <A HREF="#index">Table Of Contents</A> -<A NAME="lbAB"> </A> <H2>NAME</H2> pnmindex - build a visual index of a bunch of PNM images -<A NAME="lbAC"> </A> -<H2>SYNOPSIS</H2> +<H2 id="synopsis">SYNOPSIS</H2> <B>pnmindex</B> -[<B>-size</B> <I>N</I>] +[<B>-size=</B><I>N</I>] -[<B>-across</B> <I>N</I>] +[<B>-across=</B><I>N</I>] -[<B>-colors</B> <I>N</I>] +[<B>-colors=</B><I>N</I>] [<B>-black</B>] -[<B>-title</B> <I>title</I>] +[<B>-title=</B><I>title</I>] [<B>-quant</B>|<B>-noquant</B>] -<I>pnmfile</I>... +<I>pnmfile</I> ... -<A NAME="lbAD"> </A> -<H2>DESCRIPTION</H2> +<P>You can use the minimum unique abbreviation of the options. You can use +two hyphens instead of one. You can separate an option name from its value +with white space instead of an equals sign. + + +<H2 id="description">DESCRIPTION</H2> <p>This program is part of <a href="index.html">Netpbm</a>. <B>pnmindex</B> creates an index image containing thumbnail (small) -versions of a bunch of PNM files you supply. +versions of a bunch of PNM files you supply. (Akin to a photographic +"contact sheet." <P><B>pnmindex</B> labels each thumbnail and, optionally, contains a title. -<P>If you just want to concatenate some images together, use -<B>pnmcat</b> for that. If you want to make a grid of the same image -repeated over and over, that's <b>pnmtile</b>. +<P>If you just want to concatenate some images together in a grid, use +<b>pamundice</b> for that. <p>If you want to take apart the image you generated with <b>pnmindex</b>, use <b>pamdice</b> or <b>pamcut</b>. -<A NAME="ixAAC"></A> -<P> -<A NAME="lbAE"> </A> -<H2>OPTIONS</H2> +<H2 id="options">OPTIONS</H2> <DL COMPACT> -<DT><B>-size</B> <I>N</I> +<DT><B>-size=</B><I>N</I> <DD>The size of each thumbnail. The image is scaled to fit maximally inside a <I>N</I> x <I>N</I> pixel box without changing its aspect ratio. Default is 100. -<DT><B>-across</B> <I>N</I> +<DT><B>-across=</B><I>N</I> <DD>The number of thumbnails in each row. Default is 6. -<DT><B>-colors</B> <I>N</I> +<DT><B>-colors=</B><I>N</I> <DD>The maximum number of colors allowed in the overall image. If it would otherwise have more colors than these, <B>pnmindex</B> quantizes @@ -79,7 +78,7 @@ the result. The default is 256. normally it's white and the labels are black lettering on white background, but the <B>-black</B> option reverses this. -<DT><B>-title </B><I>title</I> +<DT><B>-title=</B><I>title</I> <DD> Specifies a title top place at the top of the image. @@ -97,8 +96,7 @@ it with <B>-noquant.</B> </DL> -<A NAME="lbAF"> </A> -<H2>SEE ALSO</H2> +<H2 id="seealso">SEE ALSO</H2> <B><A HREF="pamscale.html">pamscale</A></B>, @@ -112,27 +110,26 @@ it with <B>-noquant.</B> <B><A HREF="pamdice.html">pamdice</A></B>, +<B><A HREF="pamundice.html">pamundice</A></B>, + <B><A HREF="pnmtile.html">pnmtile</A></B>, <B><A HREF="pnm.html">pnm</A></B> -<A NAME="lbAG"> </A> -<H2>AUTHOR</H2> +<H2 id="author">AUTHOR</H2> <p>Copyright (C) 1991 by Jef Poskanzer. <p><B>-title</B> and <B>-noquant</B> added 2000 by John Heidemann. <HR> -<A NAME="index"> </A> -<H2>Table Of Contents</H2> +<H2 id="index">Table Of Contents</H2> <UL> -<LI><A HREF="#lbAB">NAME</A> -<LI><A HREF="#lbAC">SYNOPSIS</A> -<LI><A HREF="#lbAD">DESCRIPTION</A> -<LI><A HREF="#lbAE">OPTIONS</A> -<LI><A HREF="#lbAF">SEE ALSO</A> -<LI><A HREF="#lbAG">AUTHOR</A> +<LI><A HREF="#synopsis">SYNOPSIS</A> +<LI><A HREF="#description">DESCRIPTION</A> +<LI><A HREF="#options">OPTIONS</A> +<LI><A HREF="#seealso">SEE ALSO</A> +<LI><A HREF="#author">AUTHOR</A> </UL> </BODY> </HTML> diff --git a/pnmtile.html b/pnmtile.html index ebc00dec..be4fd592 100644 --- a/pnmtile.html +++ b/pnmtile.html @@ -2,23 +2,21 @@ <HTML><HEAD><TITLE>Pnmtile User Manual</TITLE></HEAD> <BODY> <H1>pnmtile</H1> -Updated: 06 March 2003 +Updated: 01 April 2007 <BR> <A HREF="#index">Table Of Contents</A> -<A NAME="lbAB"> </A> <H2>NAME</H2> pnmtile - replicate an image to fill a specified region -<A NAME="lbAC"> </A> -<H2>SYNOPSIS</H2> + +<H2 id="synopsis">SYNOPSIS</H2> <B>pnmtile</B> <I>width</I> <i>height</I> [<I>pnmfile</I>] -<A NAME="lbAD"> </A> -<H2>DESCRIPTION</H2> +<H2 id="description">DESCRIPTION</H2> <p>This program is part of <a href="index.html">Netpbm</a>. @@ -31,32 +29,30 @@ format as output. <p>You can explicitly concatenate an image to itself (or anything else) with <b>pnmcat</b>. -<p>If you're trying to tile multiple images into a superimage (such as -a thumbnail sheet), see <b>pnmindex</b>. +<p>If you're trying to tile multiple images into a superimage, +see <b>pamundice</b> or (for a thumbnail sheet) <b>pnmindex</b>. + -<A NAME="lbAE"> </A> -<H2>SEE ALSO</H2> +<H2 id="seealso">SEE ALSO</H2> +<A HREF="pamundice.html">pamdice</A>, <A HREF="pnmcat.html">pnmcat</A>, <A HREF="pamdice.html">pamdice</A>, <A HREF="pnmindex.html">pnmindex</A>, <A HREF="pampop9.html">pampop9</A>, <A HREF="pnm.html">pnm</A> -<A NAME="lbAF"> </A> -<H2>AUTHOR</H2> +<H2 id="author">AUTHOR</H2> Copyright (C) 1989 by Jef Poskanzer. <HR> -<A NAME="index"> </A> -<H2>Table Of Contents</H2> +<H2 id="index">Table Of Contents</H2> <UL> -<LI><A HREF="#lbAB">NAME</A> -<LI><A HREF="#lbAC">SYNOPSIS</A> -<LI><A HREF="#lbAD">DESCRIPTION</A> -<LI><A HREF="#lbAE">SEE ALSO</A> -<LI><A HREF="#lbAF">AUTHOR</A> +<LI><A HREF="#synopsis">SYNOPSIS</A> +<LI><A HREF="#description">DESCRIPTION</A> +<LI><A HREF="#seealso">SEE ALSO</A> +<LI><A HREF="#author">AUTHOR</A> </UL> </BODY> </HTML> |