.TL
Pnmtojbig User Manual
.SH 1
PNMTOJBIG
.LP
Updated: 20 May 2000
.br
Table Of Contents
.SH 2
NAME
.LP
pnmtojbig - PNM to JBIG file converter
.SH 2
SYNOPSIS
.LP
\fBpnmtojbig\fR
[\fIoptions\fR]
[\fIinput-file\fR [\fIoutput-file\fR]]
.SH 2
DESCRIPTION
.LP
.LP
This program is part of Netpbm.
.LP
\fBpnmtojbig\fR reads a PBM or PGM image, compresses it, and
outputs the image as a JBIG bi-level image entity (BIE) file.
.LP
JBIG is a highly effective lossless compression algorithm for
bi-level images (one bit per pixel), which is particularly suitable
for scanned document pages.
.LP
A JBIG encoded image can be stored in several resolutions
(progressive mode).  These resolution layers can be stored all in one
single BIE or they can be stored in several separate BIE files.  All
resolution layers except the lowest one are stored merely as
differences to the next lower resolution layer, because this requires
less space than encoding the full image completely every time. Each
resolution layer has twice the number of horizontal and vertical
pixels than the next lower layer.  JBIG files can also store several
bits per pixel as separate bitmap planes, and \fBpnmtojbig\fR
can read a PGM file and transform it into a multi-bitplane BIE.
.SH 2
OPTIONS
.LP
.RS
.IP "\fB-q\fR"
Encode the image in one single resolution layer (sequential
mode). This is usually the most efficient compression method. By
default, the number of resolution layers is chosen automatically such
that the lowest layer image is not larger than 640 × 480 pixels.
.IP "\fB-x\fR \fInumber\fR"
Specify the maximal horizontal size of the lowest resolution
layer.  The default is 640 pixels.
.IP "\fB-y\fR \fInumber\fR"
Specify the maximal vertical size of the lowest resolution layer.
The default is 480 pixels.
.IP "\fB-l\fR \fInumber\fR"
Select the lowest resolution layer that will be written to the
BIE.  It is possible to store the various resolution layers of a JBIG
image in progressive mode into different BIEs.  Options \fB-l\fR and
\fB-h\fR allow you to select the resolution-layer interval that will
appear in the created BIE.  The lowest resolution layer has number 0
and this is also the default value.  By default, \fBpnmtojbig\fR
writes all layers.
.IP "\fB-h\fR \fInumber\fR"
Select the highest resolution layer that will be written to the
BIE.  By default, \fBpnmtojbig\fR writes all layers.  See also option
\fB-l\fR.
.IP "\fB-b\fR"
Use binary values instead of Gray code words in order to encode
pixel values in multiple bitplanes.  This option has only an effect if
the input is a PGM file and if more than one bitplane is
produced. Note that the decoder has to make the same selection but
cannot determine from the BIE, whether Gray or binary code words were
used by the encoder.
.IP "\fB-d\fR \fInumber\fR"
Specify the total number of differential resolution layers into
which the input image will be split in addition to the lowest layer.
Each additional layer reduces the size of layer 0 by 50 %.  This
option overrides options \fB-x\fR and \fB-y\fR, which are usually a
more comfortable way of selecting the number of resolution layers.
.IP "\fB-s\fR \fInumber\fR"
The JBIG algorithm splits each image into a number of horizontal
stripes.  This option specifies that each stripe shall have
\fInumber\fR lines in layer 0.  The default value is selected so that
approximately 35 stripes will be used for the whole image.
.IP "\fB-m\fR \fInumber\fR"
Select the maximum horizontal offset of the adaptive template
pixel.  The JBIG encoder uses a number of neighbour pixels in order to
get statistical a priori knowledge of the probability, whether the
next pixel will be black or white.  One single pixel out of this
template of context neighbor pixels can be moved around.  Especially
for dithered images it can be a significant advantage to have one
neighbor pixel which has a distance large enough to cover the period
of a dither function.  By default, the adaptive template pixel can be
moved up to 8 pixels away.  This encoder supports up to 23 pixels,
however as decoders are only required to support at least a distance
of 16 pixels by the standard, no higher value than 16 for
\fInumber\fR is recommended in order to maintain interoperability
with other JBIG implementations.  The maximal vertical offset of the
adaptive template pixel is always zero.
.IP "\fB-t\fR \fInumber\fR"
Encode only the specified number of most significant bit planes.
This option allows to reduce the depth of an input PGM file if not all
bits per pixel are needed in the output.
.IP "\fB-o\fR \fInumber\fR"
JBIG separates an image into several horizontal stripes,
resolution layers and planes, were each plane contains one bit per
pixel.  One single stripe in one plane and layer is encoded as a data
unit called stripe data entity (SDE) inside the BIE.  There are 12
different possible orders in which the SDEs can be stored inside the
BIE and \fInumber\fR selects which one shall be used.  The order of
the SDEs is only relevant for applications that want to decode a JBIG
file which has not yet completely arrived from e.g. a slow network
connection.  For instance some applications prefer that the outermost
of the three loops (stripes, layers, planes) is over all layers so
that all data of the lowest resolution layer is transmitted first.
.LP
The following values for \fInumber\fR select these loop
arrangements for writing the SDEs (outermost loop first):
.RS
.IP "0"
planes, layers, stripes
.IP "2"
layers, planes, stripes
.IP "3"
layers, stripes, planes
.IP "4"
stripes, planes, layers
.IP "5"
planes, stripes, layers
.IP "6"
stripes, layers, planes
.RE
.LP
All loops count starting with zero, however by adding 8 to the
above order code, the layer loop can be reversed so that it counts
down to zero and then higher resolution layers will be stored before
lower layers.  Default order is 3 which writes at first all planes of
the first stripe and then completes layer 0 before continuing with the
next layer and so on.
.IP "\fB-p\fR \fInumber\fR"
This option allows you to activate or deactivate various optional
algorithms defined in the JBIG standard.  Just add the numbers of the
following options which you want to activate in order to get the
\fInumber\fR value:
.RS
.IP "4"
deterministic prediction (DPON)
.IP "8"
typical prediction (TPBON)
.IP "16"
diff. layer typical prediction (TPDON)
.IP "64"
layer 0 two-line template (LRLTWO)
.RE
.LP
Except for special applications (like communication with JBIG
subset implementations) and for debugging purposes you will normally
not want to change anything here.  The default is 28, which provides
the best compression result.
.IP "\fB-c\fR"
The adaptive template pixel movement is determined as suggested in
annex C of the standard.  By default the template change takes place
directly in the next line which is most effective.  However a few
conformance test examples in the standard require the adaptive
template change to be delayed until the first line of the next stripe.
This option selects this special behavior, which is normally not
required except in order to pass some conformance test suite.
.IP "\fB-v\fR"
After \fBpnmtojbig\fR creates the BIE, it lists a few technical
details of the created file (verbose mode).
.RE
.SH 2
FORMATS
.LP
.LP
Most of the format \fBpnmtojbig\fR creates is defined by the
JBIG standard.
.LP
The standard, however, does not specify which values in the BIE mean
white and which mean black.  It contains a recommendation that for a 
single plane image zero mean background and one mean foreground, but
the Netpbm formats have no concept of foreground and background.  And
the standard says nothing about values for multiple plane BIEs.
.LP
\fBpnmtojbig\fR follows Markus Kuhn's implementation of the
standard in the \fBpbmtojbg\fR program that comes with his
JBIG library:  If the BIE is a single plane BIE, zero means
white and one means black.  If it is a multiple plane BIE, zero means
black and the maximal value is white.
.SH 2
STANDARDS
.LP
.LP
This program implements the JBIG image coding algorithm as
specified in ISO/IEC 11544:1993 and ITU-T T.82(1993).
.SH 2
AUTHOR
.LP
\fBpnmtojbig\fR is based on the JBIG library by Markus Kuhn, part of
his \fBJBIG-KIT\fR package.  The \fBpbmtojbg\fR program is part of
the \fIJBIG-KIT\fR package.  The most recent version of that library
and tools set is freely available on the Internet from anonymous ftp
server ftp.informatik.uni-erlangen.de
in directory pub/doc/ISO/JBIG/.
.LP
\fBpnmtojbig\fR is part of the Netpbm package of graphics tools.
.SH 2
SEE ALSO
.LP
\fBpnm\fR,
\fBjbigtopnm\fR
.SH 2
LICENSE
.LP
If you use \fBpnmtojbig\fR, you are using various patents,
particularly on its arithmetic encoding method, and in all probability
you do not have a license from the patent owners to do so.
.br
\l'5i'
.SH 2
Table Of Contents
.LP
.IP \(bu
NAME
.IP \(bu
SYNOPSIS
.IP \(bu
DESCRIPTION
.IP \(bu
OPTIONS
.IP \(bu
FORMATS
.IP \(bu
STANDARDS
.IP \(bu
AUTHOR
.IP \(bu
SEE ALSO
.IP \(bu
LICENSE
.LP