summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man1/jpeg2ktopam.1
blob: 3431cf8aaada31ff4ea9f6fa5785ebd18961fb92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Jpeg2ktopam User Manual" 0 "08 October 2009" "netpbm documentation"

.SH NAME
jpeg2ktopam - convert JPEG-2000 code stream to PAM/PNM

.UN synopsis
.SH SYNOPSIS

\fBjpeg2ktopam\fP
[\fB-verbose\fP]
[\fB-debuglevel=\fP\fInumber\fP]
\fIfilename\fP

.SH OPTION USAGE
.PP
Minimum unique abbreviation of option is acceptable.  You may use double
hyphens instead of single hyphen to denote options.  You may use white
space in place of the equals sign to separate an option name from its value.

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBjpeg2ktopam\fP converts the named JPEG-2000 file (JP2 or JPC),
or Standard Input if no file is named, to a PBM, PGM, PPM, or PAM
file on Standard Output.
.PP
The JPEG-2000 specification specifies two different formats: JP2 and
JPEG-2000 code stream (JPC).  JP2 represents a visual image quite
specifically, whereas JPC is a more or less arbitrary array of codes.  A JP2
image contains a JPC stream and metadata describing how that stream represents
a visual image.  \fBjpeg2ktopam\fP converts both.
.PP
If the color space identified in the image is grayscale
(JAS_IMAGE_CS_GRAY), \fBjpeg2ktopam\fP generates a PGM image, unless the
image contains only one bit per pixel, in which case \fBjpeg2ktopam\fP
generates PBM.  If the color space is RGB (JAS_IMAGE_CS_RGB),
\fBjpeg2ktopam\fP generates a PPM image.  If the input image is anything
else, \fBjpeg2ktopam\fP generates a PAM image with no tuple type identified.
.PP
In the PGM and PPM cases, \fBjpeg2ktopam\fP assumes the intensity
values in the input image have the same meaning as for PGM and PPM.
One thing that implies is the ITU-R Recommendation BT.709 color space,
which means the assumption is false for JP2 input.  JP2 input uses
SRGB color encoding.  So if you use \fBjpeg2ktopam\fP to convert a
JP2 image to PPM, it changes the visual image (slightly) -- the colors
in the output are not the same as in the input.
.PP
In the PAM image, the output samples are numerically identical to
the input samples.  If the input samples are signed, they are
represented in two's complement form in the output (because PAM
samples are always unsigned).  The PAM plane numbers are identical to
the JPC component numbers.
.PP
A JPEG-2000 image has a "precision," which is the number of bits used for
each code (in Netpbm lingo, "sample").  Actually, each component has a
separate precision.  The maxval of a PGM, PPM, or PAM output is the
largest number you can represent in the JPEG-2000 precision of the JPEG-2000
component with the greatest precision.  The samples in all components are
scaled to that maxval.  So if the red component has a precision of 4 bits
and the green component has a precision of 6 bits, the maxval is 63 and
the red component codes from the JPEG-2000 image are multiplied by 63/15 to
generate the output samples.
.PP
\fBjpeg2ktopam\fP interprets the JPEG-2000 input with the 
.UR http://www.ece.uvic.ca/~mdadams/jasper/
Jasper JPEG-2000 library
.UE
\&.  See documentation of the library for details on what
\fBjpeg2ktopam\fP handles.  Note that the Jasper library contains
facilities for writing PNM images, but \fBjpeg2ktopam\fP does not use
those.  It uses the Netpbm library instead.  Note that the makers of
the Jasper library write it "JasPer," but Netpbm documentation follows
standard American English typography rules, which don't allow that
kind of capitalization.
.PP
Use \fBpamtojpeg2k\fP to convert in the other direction.
.PP
The program \fBjasper\fP, which is packaged with the Jasper 
JPEG-2000 library, also converts between JPEG-2000 and PNM formats.
Because it's packaged with the library, it may exploit it better, 
especially recently added features.  However, since it does not use the
Netpbm library to read and write the Netpbm formats, it doesn't do as
good a job on that side.

.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBjpeg2ktopam\fP recognizes the following
command line options:



.TP
\fB-verbose\fP
This option causes \fBjpeg2ktopam\fP to issue informational
messages about the conversion process.

.TP
\fB-debuglevel\fP=\fInumber\fP
This option controls debug messages from the Jasper library.  
\fBjpeg2ktopam\fP passes \fInumber\fP as the debug level to the Jasper
JPEG-2000 decoder.


     
.UN examples
.SH EXAMPLES

.nf
  jpeg2ktopam myimg.jpc >myimg.ppm

.fi

.UN jpeg2000
.SH ABOUT JPEG-2000
.PP
See
.BR "the \fBpamtojpeg2k\fP manual" (1)\c
\&
for general information on JPEG-2000 compression and the
JPEG-2000 formats.

.UN seealso
.SH SEE ALSO
.BR "pamtojpeg2k" (1)\c
\&,
.BR "jpegtopnm" (1)\c
\&,
.BR "ppm" (5)\c
\&,
.BR "pgm" (5)\c
\&,
.BR "pbm" (5)\c
\&,
.BR "pam" (5)\c
\&,

.UN history
.SH HISTORY
.PP
\fBjpeg2ktopam\fP was added to Netpbm in Release 10.12 (November 2002).
.PP
Before Netpbm 10.49 (December 2009), \fBjpeg2ktopam\fP could not convert
a JP2 file -- only JPC.
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/jpeg2ktopam.html
.PP