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

« back to all changes in this revision

Viewing changes to prim/help/createcolu.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:
 
1
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
2
%.COPYRIGHT  (c)  1990-2010 European Southern Observatory
 
3
%.IDENT      createcolu.hlq
 
4
%.AUTHOR     JDP, IPG/ESO
 
5
%.KEYWORDS   MIDAS, help files, CREATE/COLUMN
 
6
%.PURPOSE    On-line help file for the command: CREATE/COLUMN
 
7
%.VERSION    1.0  12-OCT-1983 : Creation, JDP
 
8
%.VERSION    1.1  04-Mar-1991 : New Table Version, FO
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./COLU
 
12
\es\co
 
13
CREATE/COLUMN                                           18-AUG-2010   JDP
 
14
\oc\su
 
15
CREATE/COLUMN table column [unit] [format] [type]
 
16
        create a table column
 
17
\us\pu
 
18
Purpose:      
 
19
           Creates a new column in a table. Values in the column are
 
20
           initialized to NULL. Information associated with that column is
 
21
           also initialized. A column may have a depth, i.e each element
 
22
           of the table may be itself an array.
 
23
\up\sy
 
24
Syntax:  
 
25
           CREATE/COLUMN table column [unit] [format] [type]
 
26
\ys\pa
 
27
           table = table name
 
28
\ap\pa
 
29
           column = column reference (by label, i.e. :name),
 
30
                    max. 16 chars. including the ':'
 
31
\ap\pa
 
32
           unit = optional units included in double quotation marks,
 
33
                  max. 16 chars.; blanks are used by default
 
34
\ap\pa
 
35
           format = format associated with the column according to the
 
36
\\
 
37
                    FORTRAN-77 rules, with some extensions. The format 
 
38
                    is used by default when the table is displayed 
 
39
                    (commands READ/TABLE and PRINT/TABLE). 
 
40
                    Possible formats are (lower-case edit the sign)
 
41
                    for characters: Aww   
 
42
                    for integers:   Iww      iww      (sign edited)
 
43
                                    Xww      Oww      for hexa / octal
 
44
                                    Tww.dd   tww.dd   for Date+Time
 
45
                                                      (seconds since 1970)
 
46
                                    Zww      zww      zero-filled
 
47
                    for floating:   Fww.dd   fww.dd   (sign edited)
 
48
                                    Eww.dd   eww.dd   (sign edited)
 
49
                                    Gww.dd  
 
50
                                    Rww.dd   rww.dd   for Right Ascensions
 
51
                                    Sww.dd   sww.dd   for Sexagesimal (decl.)
 
52
                                    Tww.dd   tww.dd   for Date+Time (JD)
 
53
                                    Zww.dd   zww.dd   zero-filled
 
54
                    Default format is E12.6 for R*4,D24.17 for R*8,I11 for I*4 
 
55
\ap\pa
 
56
           type   = column type including its dimension within  parenthesis
 
57
                    Possible types are 
 
58
                    R*4(array_size)   real single precision (default)
 
59
                    R*8(array_size)   real double precision
 
60
                    C*n               character string, n bytes length
 
61
                    I*n(array_size)   signed integer (n = 1 , 2 or 4)
 
62
                    U*4(array_size)   unsigned integer
 
63
                    Default array_size is 1.
 
64
\on\see
 
65
See also:
 
66
           NAME/COLUMN, WRITE/TABLE, PLOT/TABLE
 
67
\ees\ap\no
 
68
Note:         1) Column labels and/or units > 16 chars. will be truncated,
 
69
           but the command will not abort, just a warning message displayed.
 
70
              2) The special function M$EXISTC(table,label) may be used at 
 
71
           the command level to check whether a column exists or not. 
 
72
           The function returns -2 if the table doesn't exist, the physical 
 
73
           number of the column or -1 of the column doesn't exist.
 
74
              3) Most of the MIDAS commands are not able yet to deal with 
 
75
           3D tables. If, e.g., a column is declared as being an array of 
 
76
           dimension 12, these commands will only be able to access, for 
 
77
           each row of the table, the first element of the array. 
 
78
           An exception is the command PLOT/TAB, which is able to plot the 
 
79
           data points in a 3-dim table.
 
80
\on\exs
 
81
Examples:
 
82
\ex
 
83
           CREATE/COLUMN mytable :RADVEL "KM.SEC-1" E12.3
 
84
\xe\ex
 
85
           CREATE/COLUMN mytable :FLUX R*4(12) "Jy" E12.3
 
86
             Create a column labeled :FLUX made of 12 real numbers (array)
 
87
             in table `mytable.tbl'.
 
88
\xe\sxe