summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-leap-15-6/man1/pamtofits.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/opensuse-leap-15-6/man1/pamtofits.1')
-rw-r--r--upstream/opensuse-leap-15-6/man1/pamtofits.1110
1 files changed, 110 insertions, 0 deletions
diff --git a/upstream/opensuse-leap-15-6/man1/pamtofits.1 b/upstream/opensuse-leap-15-6/man1/pamtofits.1
new file mode 100644
index 00000000..e1fedbcb
--- /dev/null
+++ b/upstream/opensuse-leap-15-6/man1/pamtofits.1
@@ -0,0 +1,110 @@
+\
+.\" 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 "Pamtofits User Manual" 0 "25 September 2005" "netpbm documentation"
+
+.SH NAME
+
+pamtofits - convert a Netpbm image into FITS format
+
+.UN synopsis
+.SH SYNOPSIS
+
+\fBpamtofits\fP
+[\fB-max\fP \fIf\fP]
+[\fB-min\fP \fIf\fP]
+[\fIpamfile\fP]
+
+.UN description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBpamtofits\fP reads a PNM or PAM image as input and produces a FITS
+(Flexible Image Transport System) file as output. The resolution of
+the output file is either 8 bits/pixel, or 16 bits/pixel, depending on
+the value of maxval in the input file. If the input file is a PBM or
+PGM image, the output file consists of a single plane image (NAXIS =
+2). If instead the input file is a PPM image, the output file will
+consist of a three-plane image (NAXIS = 3, NAXIS3 = 3).
+
+.UN options
+.SH OPTIONS
+.PP
+\fB-min\fP and \fB-max\fP tell \fBpamtofits\fP what "physical
+values" zero and maxval sample values, respectively, in the input
+image represent. Physical values are a FITS concept. \fBpamtofits\fP
+sets up the \fBBSCALE\fP and \fBBZERO\fP FITS header cards to indicate
+this information.
+.PP
+The default for \fB-min\fP is 0 and for \fB-max\fP is the maxval,
+which means if you don't specify these options, the FITS physical values
+are in fact the original Netpbm sample values.
+.PP
+\fBpamtofits\fP always sets up the FITS header \fBDATAMIN\fP and
+\fBDATAMAX\fP cards to indicate that the highest physical value in
+the image is the one corresponding to the Netpbm maxval and the lowest is
+that corresponding to Netpbm zero. This isn't really how those cards are
+supposed to be used, since the input image doesn't necessarily contain
+the full possible range of sample values. It is a conservative
+approximation.
+
+.UN notes
+.SH NOTES
+
+.UN pixelorder
+.SS Pixel Order
+.PP
+The FITS specification does not specify which data in the file corresponds
+to which pixel in the image (i.e. which bytes are the top left pixel,
+etc.). Netpbm uses the common sense, most popular arrangement: row major, top
+to bottom, left to right. That means in a 10 wide by 20 high image, the first
+10 pixels in the file are the top row and the last 10 are the bottom row.
+Within each row, the first pixel is the leftmost one and the last pixel is
+the rightmost one.
+.PP
+\fBNetpbm\fP has always done that, since it first understood the
+FITS format in 1989, so it is something of a de facto standard. Nobody
+reported trouble with that until 2008.
+.PP
+However, at least some versions of ImageMagick and Gimp (as seen in 2008)
+use bottom to top order, so if you use on of these to display a FITS image
+generated by \fBpamtofits\fP, it will appear upside down. To fix that,
+use \fBpamflip -topbottom\fP on the image before feeding it
+to \fBpamtofits\fP.
+.PP
+Since 2008, people have noted that NASA distributes FITS files with
+bottom to top order.
+
+
+.UN history
+.SH HISTORY
+.PP
+\fBpamtofits\fP was originally \fBpnmtofits\fP and did not handle
+PAM input. It was extended and renamed in Netpbm 10.30 (October 2005).
+.PP
+\fBpnmtofits\fP was itself an extension of \fBpgmtofits\fP, which
+was added to Pbmplus in 1989.
+
+.UN seealso
+.SH SEE ALSO
+.BR "fitstopnm" (1)\c
+\&,
+.BR "pam" (5)\c
+\&
+
+.UN author
+.SH AUTHOR
+
+Copyright (C) 1989 by Wilson H. Bent (\fIwhb@hoh-2.att.com\fP), with
+modifications by Alberto Accomazzi (\fIalberto@cfa.harvard.edu\fP).
+.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/pamtofits.html
+.PP \ No newline at end of file