← Back to branch summary

~ubuntu-branches/ubuntu/wily/eso-midas/wily-proposed

« back to all changes in this revision

Viewing changes to prim/help/indiskfits.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/indiskfits.hlq
 
1
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
2
%.COPYRIGHT  (c)  1990-2010 European Southern Observatory
 
3
%.IDENT      indiskfits.hlq
 
4
%.AUTHOR     KB, IPG/ESO
 
5
%.KEYWORDS   MIDAS, help files, INDISK/FITS
 
6
%.PURPOSE    On-line help file for the command: INDISK/FITS
 
7
%.VERSION    1.0  05-NOV-1993 : Creation, KB
 
8
%----------------------------------------------------------------
 
9
\se
 
10
SECTION./FITS
 
11
\es\co
 
12
INDISK/FITS                                             17-JUN-02010  KB
 
13
\oc\su
 
14
INDISK/FITS in_files [out_spec] [option] [INTAPE_flag] [empty_header]
 
15
        read FITS files from disk
 
16
\us\pu
 
17
Purpose:
 
18
          Read FITS files from disk and convert to Midas format.
 
19
\up\sy
 
20
Syntax: 
 
21
          INDISK/FITS in_files [out_spec] [option] [INTAPE_flag] [empty_header]
 
22
\ys\pa
 
23
          in_files = filename(s) of FITS files separated by a comma;
 
24
              or name of ASCII file (indicated by filetype `.cat')
 
25
              containing FITS filenames ;
 
26
              or name of Midas catalog with FITS files;
 
27
              also wildcard characters are supported.
 
28
\ap\pa
 
29
          out_spec = corresponding MIDAS filenames separated by a comma;
 
30
              or name of ASCII file (indicated by filetype `.cat') with 
 
31
              corresponding Midas filenames;
 
32
              or name of Midas catalog with result names;
 
33
              or string "ROOT=abcd" to build output file names as
 
34
              abcd0001.TYPE, abcd0002.TYPE, ... with TYPE is "bdf", "tbl",
 
35
                                 or "fit" depending on type of FITS file;
 
36
              or string "NAME=INPUT" to use input names as result names
 
37
              with the relevant Midas file type (TYPE as above)
 
38
              if the param `out_spec' is omitted, output names are built as
 
39
              toto0001.TYPE, toto0002.TYPE, ...
 
40
\ap\pa
 
41
          option = OC or ON (or NO) to keep the original name of the files,
 
42
              i.e RESTORE/NAME is executed in the end for each result file,
 
43
              renaming them according to the FITS keyword (descr) FILENAME;
 
44
              OC - with overwrite confirmation, ON - without confirmation,
 
45
              NO - keep name as specified in parameter `out_spec';
 
46
              defaulted to NO
 
47
\ap\pa
 
48
          INTAPE_flag = 3-character flag as used with INTAPE/FITS command,
 
49
              list, create, keywrd flag:
 
50
              list flag:   F(ull), S(hort), N(one) 
 
51
              create flag: N(o create), O(original format),
 
52
                           F(loating point format) 
 
53
              keywrd flag: Y(es history stored), N(o history stored),
 
54
                           C(ode hierarchical keywords) or
 
55
                           A(ll keywords stored also with empty
 
56
                           data matrix) 
 
57
              defaulted to NOY - so it's not exactly as in the INTAPE command, 
 
58
              where the default is SOY
 
59
\ap\pa
 
60
          empty_header = YES or NO, suppress or don't suppress the first
 
61
                empty primary header (for tables and images);
 
62
                defaulted to YES
 
63
\ap\sa
 
64
See also:
 
65
          INTAPE/FITS, INDISK/ASCII, INDISK/MFITS,
 
66
          OUTDISK/FITS, OUTTAPE/FITS, RESTORE/NAME [Filename]
 
67
          @a inoutFITS
 
68
\as\no
 
69
Note:  
 
70
          If not as many output file names as input names are given, the names
 
71
          `toto0001.TYPE', `toto0002.TYPE', ... are used.
 
72
          The command works for images, tables and fitfiles.
 
73
             The INTAPE_flag is passed on unchanged to the underlying 
 
74
          INTAPE/FITS command.
 
75
             All result names are stored in ASCII file outnames.cat (not a full
 
76
          Midas catalog), the no. of created files is stored in MID$INFO(7).
 
77
              The parameters may also be cross referenced via
 
78
          IN=, OUT=, OPTION=, FLAG= and TBLCOMP=
 
79
 
 
80
          Midas does not have an internal 32bit unsigned integer format.
 
81
          FITS data in that format  will be converted to double precision.
 
82
\on\exs
 
83
Examples:
 
84
\ex
 
85
          INDISK/FITS xyz
 
86
            Convert FITS file `xyz' to `toto0001.bdf' or `toto0001.tbl'
 
87
            or `toto0001.fit' depending upon if `xyz' was an image, table
 
88
            or fit file.
 
89
\xe\ex
 
90
          INDISK/FITS tst0003.mt prado.midas
 
91
            Convert FITS file `tst0003.mt' to `prado.midas'
 
92
\xe\ex
 
93
          INDISK/FITS tst0004.mt ? OC
 
94
            Assuming that the FITS file `tst0004.mt' has a char. FITS keyword 
 
95
            named FILENAME containing `vieux_port.bdf' convert FITS file
 
96
            `tst0004.mt' to MIDAS file `vieux_port.bdf'. If a file named
 
97
            `vieux_port.bdf' already exist, ask for confirmation before
 
98
            overwriting it.
 
99
\xe\ex
 
100
          INDISK/FITS paradis.cat paradis.out
 
101
            Read ASCII file `paradis.cat' and convert the FITS files with
 
102
            names in that file to MIDAS files with the corresponding names in
 
103
            file `paradis.out' 
 
104
\xe\ex
 
105
          INDISK/FITS paradis.cat ? ON p4=SFY
 
106
            Read ASCII file `paradis.cat' and convert the FITS files with
 
107
            names in that file to MIDAS files with names as descr. FILENAME
 
108
            of the FITS input files (will usually be the same as the physical
 
109
            filename...). All image data will be stored as real values.
 
110
\xe\ex
 
111
          INDISK/FITS luminy* panier.dat
 
112
            Convert all FITS files matching the pattern `luminy*' to MIDAS 
 
113
            files with names according to entries in ASCII file `panier.dat'
 
114
\xe\ex
 
115
          INDISK/FITS luminy* ROOT=cassis
 
116
            As above but names of MIDAS files will be built as
 
117
            `cassis0001.bdf', `cassis0002.bdf', ...
 
118
\xe\ex
 
119
          INDISK/FITS luminy* ROOT=cas@sis
 
120
            As above but `cas@sis0001.bdf' is a bad MIDAS filename, therefore
 
121
            a warning message will be displayed and names will be built as
 
122
            `cas_sis0001.bdf', `cas_sis0002.bdf', ...
 
123
\xe\ex
 
124
          INDISK/FITS prado.cat NAME=input
 
125
            Read ASCII file `prado.cat' and convert the FITS files with
 
126
            names in that file to MIDAS files with same name and as 
 
127
            type the relevant Midas type (.bdf, or .tbl, or .fit).
 
128
\xe\ex
 
129
          INDISK/FITS tst0009.mt 
 
130
            Assuming that the FITS file `tst0009.mt' just contains an empty
 
131
            primary header and a table extension, we get as result the
 
132
            Midas table toto0001.tbl. Thus, a result like from INTAPE/FITS.
 
133
\xe\ex
 
134
          INDISK/FITS tst0009.mt ? ? ? NO
 
135
            We do save the 1st empty primary header (with all its possible
 
136
            descriptors (FITS keywords)) as a Midas image. And, get as 
 
137
            result the Midas image toto0001.bdf (NAXIS = 0) and the table
 
138
            toto0002.tbl. Thus, a result like from INDISK/MFITS.
 
139
\xe \sxe