← Back to branch summary

~ubuntu-branches/debian/jessie/eso-midas/jessie

« back to all changes in this revision

Viewing changes to prim/help/outdissfit.hlq

  • Committer: Package Import Robot
  • Author(s): Ole Streicher
  • Date: 2014-04-22 14:44:58 UTC
  • Revision ID: package-import@ubuntu.com-20140422144458-okiwi1assxkkiz39
Tags: upstream-13.09pl1.2+dfsg
Import upstream version 13.09pl1.2+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
prim/help/outdissfit.hlq
 
1
% @(#)outdissfit.hlq    19.1 (ESO-DMD) 02/25/03 14:03:32
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1998 European Southern Observatory
 
4
%.IDENT      outdissfit.hlq
 
5
%.AUTHOR     PJG, DPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, OUTDISK/SFITS
 
7
%.PURPOSE    On-line help file for the command: OUTDISK/SFITS
 
8
%.VERSION    1.0  14-MAY-1998 : Creation, PJG
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./SFIT
 
12
\es\co
 
13
OUTDISK/SFITS                                           13-JUL-2001  PJG
 
14
\oc\su
 
15
OUTDISK/SFITS input_string out flags copy_keyw_flag
 
16
        convert set of MIDAS files to a single FITS file on disk
 
17
\us\pu
 
18
Purpose:    
 
19
            Convert a set of MIDAS files to single FITS disk file.
 
20
\up\sy
 
21
Syntax:     
 
22
            OUTDISK/SFITS input_string out flags copy_keyw_flag
 
23
\ys\pa
 
24
            input_string = name of catalog (abc.cat) or list of one or 
 
25
                  more frames (images or tables separated by a comma) 
 
26
                  which should be converted into a single disk file in 
 
27
                  FITS format. 
 
28
                  If the first frame refers to a table a minimum prime 
 
29
                  FITS header will be generated. The input frames will be 
 
30
                  written in the order given using IMAGE-extensions for 
 
31
                  images and TABLE/BINTABLE-extensions for tables. 
 
32
                  Note: names of tables must be given with their file 
 
33
                        extension.
 
34
\ap\pa
 
35
            out = name of FITS file to be created.  A full file name, a
 
36
                  basename with out extension or an extension only can
 
37
                  be given. A name starting with a '.' is assumed
 
38
                  to specify an extension while a name without a '.' is
 
39
                  interpreted as a basename without extension.  The
 
40
                  default extension is '.fits'.  If no output name is
 
41
                  given the basename of the first input frame is used.
 
42
\ap\pa
 
43
            flags = 3-character flag: format, display and cut.
 
44
                  type flag : B(asic) FITS e.g. BITPIX=8,16 or 32
 
45
                                   for frames and ASCII for tables.\\
 
46
                              O(riginal) data format i.e. the FITS
 
47
                                   format closest to frame format
 
48
                                   including BITPIX=-32,-64 (IEEE-FP) and
 
49
                                   BINTABLE for tables. \\
 
50
                  display flag: F(ull), S(hort) or N(one) \\
 
51
                  cut flag: C(ut) using LHCUTS(3-4) for frames or display
 
52
                            format for tables. \\
 
53
                  Defaulted to OSN
 
54
\ap\pa
 
55
            copy_keyw_flag = COPY or NO;
 
56
                  if this flag is set, the parameter `input_string' has to
 
57
                  be a single Midas table file;
 
58
                  the descriptors (FITS keywords) of the table extension
 
59
                  (except the standard table descr.) are then copied to 
 
60
                  the prime header of the output FITS file.
 
61
                  The `out' parameter is defaulted to the basename of the
 
62
                  input table and type ".tfits' appended;
 
63
                  defaulted to NO
 
64
\ap\sa
 
65
See also:
 
66
            OUTDISK/FITS, OUTTAPE/FITS, COPY/II, INTAPE/FITS, INDISK/FITS,
 
67
            CREATE/ICAT, SET/ICAT
 
68
\as\no
 
69
Note:
 
70
            It is normally assumed that a FITS file with multiple
 
71
            extensions of the same type contains the keywords EXTNAME
 
72
            and EXTVER to uniquely identify the extension within the
 
73
            FITS file.  The user is responsible for ensuring that
 
74
            this is done by defining corresponding descriptors in the
 
75
            MIDAS frames.
 
76
               Names like &a, &b.tbl are not accepted, use middumma.bdf and
 
77
            middummb.tbl instead.
 
78
               The different parameters may be referenced in any order via
 
79
            INFILE=  OUTFILE=  FLAGS=
 
80
               MIDAS images are normally stored as floating point numbers.
 
81
            Such files are by default written using the BITPIX=-32 i.e.
 
82
            IEEE floating point format. The BINTABLE extension is used
 
83
            for tables.  Please, check if the FITS reader you want to read
 
84
            the data with has been upgraded to include these FITS formats
 
85
            and extensions.
 
86
            If that is not the case, use the 'B' format flag to force
 
87
            OUTDISK/SFITS to write image with BITPIX=8,16,32 and tables in
 
88
            TABLE extension format.
 
89
               If your MIDAS frames are "essentially" 16bit integer frames
 
90
            use the command COPY/II first to convert them to 16bit data
 
91
            frames and then do the OUTDISK/SFITS to obtain a 16bit FITS file.
 
92
\on\exs
 
93
Examples:
 
94
\ex
 
95
            OUTDISK/SFITS  myimage
 
96
              Convert the image 'myimage' to a FITS file with the
 
97
              name 'myimage.fits' using IEEE floating point format
 
98
              if required.
 
99
\xe\ex
 
100
            OUTDISK/SFITS  myimage,mytable.tbl,mypsf  .mt
 
101
              Convert the frames 'myimage,mytable,mypsf' to a single
 
102
              FITS file with one prime data matrix ('mydata'), a
 
103
              BINTABLE extension ('mytable') and an IMAGE extension
 
104
              ('mypsf').  The name of the FITS file will be
 
105
              'myimage.mt'.
 
106
\xe\ex
 
107
            OUTDISK/SFITS  mycat.cat myfile.fits
 
108
              Assuming the image catalog `mycat.cat' contains entries
 
109
              for 'myimage.bdf', `mytable.tbl', `mypsf.bdf' these frames
 
110
              are converted to the single FITS file `myfile.fits'.
 
111
\xe\ex
 
112
            OUTDISK/SFITS  mytable.tbl table.fits
 
113
              Convert the table 'mytable' to a FITS file with a
 
114
              minimum prime header and a BINTABLE extension.  The
 
115
              output FITS file will get the name 'table.fits'.
 
116
\xe\ex
 
117
            OUTDISK/SFITS  mytable.tbl ? ? copy
 
118
              As above but also copy all descriptors (except the standard 
 
119
              table descr) of `mytable.tbl' to the prime header of the 
 
120
              output FITS file 'mytable.tfits'.
 
121
\xe\ex
 
122
            OUTDISK/SFITS  myimage,mytable.tbl ? BSN
 
123
              Convert the frames 'myimage,mytable' to a single FITS
 
124
              file with one prime data matrix ('mydata') with
 
125
              BITPIX=8,16,32 and a TABLE extension ('mytable').
 
126
              The output FITS file will be 'myimage.fits'.
 
127
\xe \sxe