← Back to branch summary

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

« back to all changes in this revision

Viewing changes to prim/help/read_desc.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/read_desc.hlq
 
1
% @(#)read_desc.hlq     19.1 (ESO-IPG) 02/25/03 14:03:37 
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
4
%.IDENT      read_desc.hlq
 
5
%.AUTHOR     KB, IPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, READ/DESCR
 
7
%.PURPOSE    On-line help file for the command: READ/DESCR
 
8
%.VERSION    1.0  13-APR-1984 : Creation, KB
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./DESC
 
12
\es\co
 
13
READ/DESCR                                      25-JUL-2000  KB
 
14
\oc\su
 
15
READ/DESCR name [descr_list] [disp_flag]
 
16
        display descriptor values of frame or table 
 
17
\us\pu
 
18
Purpose: 
 
19
           Display descriptor values of Midas image or table
 
20
           or FITS header of FITS file.
 
21
\up\sb
 
22
Subject:
 
23
           Descriptors, Data frames, Tables
 
24
\bs\sy
 
25
Syntax: 
 
26
           READ/DESCR name [descr_list] [disp_flag]
 
27
\ys\pa
 
28
           name = name of data frame holding descriptor;
 
29
              default file type is .bdf; so if you want to see the descriptors
 
30
              of a table, you have to append also the type (e.g.: `.tbl')
 
31
              to the filename
 
32
\ap\pa
 
33
           descr_list = descriptor name(s) or pattern(s) separated by a comma,
 
34
\\
 
35
              or `*' to display all descriptors,
 
36
\\
 
37
              or patternA|patternB (character `|' as used for OR in C or the 
 
38
              pipe symbol in Unix) to display all descriptors with names
 
39
              matching patternA but not patternB,
 
40
\\
 
41
              or 'name.ascii' if ASCII file `name.ascii' contains the 
 
42
              descriptors to be read (file type .ascii is required); 
 
43
\\
 
44
              defaulted to the list of standard descriptors of images or tables
 
45
\ap\pa
 
46
           disp_flag = B(rief) or F(ull) or H(ide Header Info);
 
47
\\
 
48
              B: show only desriptor name(s) and value(s)
 
49
\\
 
50
              F: show also descriptor type and no. of elements as well as
 
51
                 related help text if available;
 
52
\\
 
53
              H: show only desriptor value(s)
 
54
\\
 
55
              defaulted to B
 
56
\ap\sa
 
57
See also:
 
58
           WRITE/DESCR, SHOW/DESCR, PRINT/DESCR, DELETE/DESCR, COPY/DD
 
59
\\
 
60
           WRITE/DHELP
 
61
\as\no
 
62
Note:    
 
63
           For patterns there are the following possibilities:
 
64
\\
 
65
              `abc*' => all descr. beginning with `abc' match
 
66
\\
 
67
              `*abc' => all descr. ending with `abc' match
 
68
\\
 
69
              `*abc*' => all descr. containing `abc' match
 
70
\\
 
71
              `abc*def' => all descr. beginning with `abc' and ending 
 
72
              with `def' match the pattern.
 
73
\\
 
74
           If all descriptors of the frame are displayed (descr_list = '*')
 
75
              you can also exclude (up to 4) descriptors which should NOT be
 
76
              displayed, by adding their names separated by a comma, or a
 
77
              single pattern (see above) defining them.
 
78
\\
 
79
           If descr_list is set to a specific descr. name, also the first
 
80
              4(5) elements of integer keyword OUTPUTI are filled:
 
81
\\
 
82
              OUTPUTI(1) = 1 or 0, if specified descr. exists or not.
 
83
\\
 
84
              If OUTPUTI(1) is 1, then (2) = descr. type (1,2,3 or 4 for
 
85
              integer, real, character or double descr);
 
86
              (3) and (4) hold no. of elements and bytes per element of 
 
87
              descr.
 
88
              And if `disp_flag' was set to Full, OUTPUTI(5) contains the
 
89
              size of the help text of the descriptor (-1, if no help).
 
90
              This information can then be used in a procedure.
 
91
           For a description of the standard descriptors of an image or
 
92
              a table, see the MIDAS Environment document, Appendix C.
 
93
\on\exs
 
94
Examples:
 
95
\ex
 
96
           READ/DESCR durazno STEP  
 
97
             Display contents of descriptor STEP of frame `durazno.bdf'.
 
98
\xe\ex
 
99
           READ/DESCR durazno start,step full
 
100
             Display descriptors STEP and START of frame `durazno.bdf' in
 
101
             extended format. Also, display the corresponding help text if
 
102
             available.
 
103
\xe\ex
 
104
           READ/DESCR naranja.tbl *
 
105
             Display all descriptors of table file `naranja.tbl'.
 
106
\xe\ex
 
107
           READ/DESCR fresa *,histogram,hist_bins
 
108
             Display all descriptors of image `fresa.bdf' except the two
 
109
             descriptors HISTOGRAM and HIST_BINS.
 
110
\xe\ex
 
111
           READ/DESCR fresa *,histo*
 
112
             Display all descriptors of image `fresa.bdf' except all
 
113
             descriptors beginning with HISTO (so also HISTORY would not be
 
114
             displayed).
 
115
\xe\ex
 
116
           READ/DESCR manzana naxis,*det*
 
117
             Display descr. NAXIS and all descriptors of frame `manzana.bdf' 
 
118
             with names containing `DET', e.g. ESO.DET.CHIP1.PSZX.
 
119
\xe\ex
 
120
           READ/DESCR pera ESO.*|*.det.*
 
121
             Display all hierarchical ESO keywords of `pera.bdf' except those 
 
122
             containing `DET', e.g. ESO.DET.CHIP1.PSZX would not be shown.
 
123
\xe\ex
 
124
           READ/DESCR platano papaya.ascii
 
125
             Display all descriptors which are in the ASCII file `papaya.ascii'
 
126
             E.g. if `papaya.ascii' contains the two records:
 
127
\\
 
128
             naxis,npix,start,step
 
129
\\
 
130
             history
 
131
\\
 
132
             the descriptors NAXIS, NPIX, START, STEP and HISTORY of frame
 
133
             `platano.bdf' would be displayed.
 
134
\xe \sxe