about summary refs log tree commit diff
path: root/fitstopnm.html
blob: 03d394d5ebdbffce054584d8d837086b38dd9c95 (plain) (blame)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML><HEAD><TITLE>Fitstopnm User Manual</TITLE></HEAD>
<BODY>
<H1>fitstopnm</H1>
Updated: 22 May 2007
<BR>
<A HREF="#index">Table Of Contents</A>

<H2>NAME</H2>
fitstopnm - convert a FITS file into a PNM image

<H2 id="synopsis">SYNOPSIS</H2>

<B>fitstopnm</B>
[<B>-image=</B><I>N</I>]
[<B>-scanmax</B>]
[<B>-printmax</B>]
[<B>-min=</B><I>f</I>]
[<B>-max=</B><I>f</I>]
[<b>-omaxval=</b><i>N</i>
[<I>FITSfile</I>]

<p>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.


<H2 id="description">DESCRIPTION</H2>

<p>This program is part of <a href="index.html">Netpbm</a>.

<p><b>fitstopnm</b> reads a FITS (Flexible Image Transport System) file as
input and produces a PPM image if the FITS file consists of 3 image planes
(NAXIS = 3 and NAXIS3 = 3), or a PGM image if the FITS file consists of 2
image planes (NAXIS = 2), or if you specify the <B>-image</B> option.

<P>The program tells you what kind of PNM image it is writing.


<H2 id="options">OPTIONS</H2>

<dl>

<dt><b>-image=</b><i>N</i>

<dd>This is for FITS files with three axes.  The assumption is that
the third axis is for multiple images, and this option lets you select
which one you want.

<dd><b>-omaxval=</b><i>N</i>

<P>This is the maxval that the output PNM image is to have.

<p>By default, the maxval is the least possible to retain all the
precision of the FITS input.  That means the difference between the
highest and lowest sample value in the input.  If the values range
from -5 to 100, for example, the default maxval would be 106 and each
PNM sample value would correspond to one FITS sample value.

<p>For a FITS input with floating point sample values, the precision is
essentially unlimited, so this is not possible.  In that case, the default
maxval is simply 255.

<p>This option was new in Netpbm 10.39 (June 2007).  Before that, the
output maxval is always the default.

<dt><b>-min=</b><I>float</I>
<dt><b>-max=</b><i>float</i>
<dd>

<P>You can use these options to override the min and max values as
read from the FITS header or the image data if the header has no
DATAMIN and DATAMAX keywords.

<dt><b>-scanmax</b>
<dd>
Use this option to force the program to scan the data even when the
header has DATAMIN and DATAMAX.

<dt><b>-printmax</b>

<dd>With this option, the program just prints the min and max values
and quits without doing its normal job.

<p>This is for use in shell programs.  Example:

<pre>
<code>
    eval 'fitstopnm -printmax $filename | \
    awk {min = $1; max = $2} \
          END {print "min=" min; " max=" max}'
</code>
</pre>

</dl>

<h2 id="notes">NOTES</h2>

<h3 id="pixelorder">Pixel Order</h3>

<p>You may need to pass the output of <b>fitstopnm</b> through <b>pamflip
-topbottom</b>.  See <a href="pamtofits.html#pixelorder"><b>pamtofits</b></a>


<H2 id="seealso">SEE ALSO</H2>

<A HREF="pamtofits.html">pamtofits</A>,
<A HREF="pamflip.html">pamflip</A>,
<A HREF="pgm.html">pgm</A>
<a href="http://fits.gsfc.nasa.gov/fits_intro.html">FITS</a>

<H2 id="author">AUTHOR</H2>

Copyright (C) 1989 by Jef Poskanzer, with modifications by Daniel
Briggs (<A HREF="mailto:dbriggs@nrao.edu">dbriggs@nrao.edu</A>) and
Alberto Accomazzi (<A
HREF="mailto:alberto@cfa.harvard.edu">alberto@cfa.harvard.edu</A>).


<HR>
<H2 id="index">Table Of Contents</H2>
<UL>
<LI><A HREF="#synopsis">SYNOPSIS</A>
<LI><A HREF="#description">DESCRIPTION</A>
<LI><A HREF="#options">OPTIONS</A>
<LI><A HREF="#notes">NOTES</A>
  <ul>
  <li><a href="#pixelorder">Pixel Order</a>
  </ul>
<LI><A HREF="#seealso">SEE ALSO</A>
<LI><A HREF="#author">AUTHOR</A>
</UL>
</BODY>
</HTML>