← Back to branch summary

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

« back to all changes in this revision

Viewing changes to prim/help/overpltabl.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/overpltabl.hlq
 
1
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
2
%.COPYRIGHT  (c)  1990-2010 European Southern Observatory
 
3
%.IDENT      overpltabl.hlq
 
4
%.AUTHOR     RHW, IPG/ESO
 
5
%.KEYWORDS   MIDAS, help files, OVERPLOT/TABLE
 
6
%.PURPOSE    On-line help file for the command: OVERPLOT/TABLE
 
7
%.VERSION    1.0 09-JUN-1986 RHW Creation
 
8
%.VERSION    2.0 93-Oct-1993 RvH OVERPLOT/TABLE can handle 3D tables
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./TABL
 
12
\es\co
 
13
OVERPLOT/TABLE                                          01-OCT-1993  RvH
 
14
\oc\su
 
15
OVERPLOT/TABLE table [plane1] [plane2] [x_sc,y_sc[,x_off,y_off]] 
 
16
        [symbols] [lines] [flag_dir]
 
17
        plot table data on selected plotting device
 
18
\us\pu
 
19
Purpose:    
 
20
            Overplot table data on selected plotting device
 
21
\up\sy
 
22
Syntax:     
 
23
            OVERPLOT/TABLE table [plane1] [plane2] [x_sc,y_sc[,x_off,y_off]]
 
24
                           [symbols] [lines] [flag_dir]
 
25
\ys\pa
 
26
            table  = name of table file
 
27
\ap\pa
 
28
            plane1 = vector or plane in abscissa (x-axis); default is 
 
29
                     sequence number, however see the note below.
 
30
\ap\pa
 
31
            plane2 = vector or plane in ordinate (y-axis); default is 
 
32
                     sequence number, however see the note below.
 
33
\ap\pa
 
34
            symbols = symbol types to be used in the plot; input can be given
 
35
                     as s_start:s_end:s_incr or s_nr1,s_nr2,s_nr3, ...
 
36
                     or any combination of these two possibilities separated 
 
37
                     by a comma. Default is the symbol type set by SET/GRAP. 
 
38
                     Data points on different lines in the extracted planes 
 
39
                     will be presented with different symbols if more than one
 
40
                     symbol type is given. The program will cycle though the 
 
41
                     given symbols if the number of lines exceed the number of
 
42
                     given symbols.
 
43
\ap\pa
 
44
            lines  = line types to be used in the plot; input can be given
 
45
                     as l_start:l_end:l_incr or l_nr1,l_nr2,l_nr3, ...
 
46
                     or any combination of these two possibilities separated
 
47
                     by a comma. PLOT/TABLE will draw lines if STYPE is equal 
 
48
                     to zero or if you specify here one or more line type 
 
49
                     to be used in the plot. Data points on the first axis 
 
50
                     of a plane will be connected with a line of given type, 
 
51
                     and if the number of lines exceed the number of given 
 
52
                     line types the program will cycle through the line types.
 
53
\ap\pa
 
54
            flag_dir = flag_dir specifies the way both planes are read.
 
55
                     Two values can be given: "D"efault and "O"pposite.\\
 
56
                     - a plane along a column in the depth direction is by
 
57
                       default stored column by column (thus the first axis
 
58
                       is along the columns, and each column can be 
 
59
                       represented by a symbol and/or line type).\\
 
60
                     - a plane along a row in the depth direction is by 
 
61
                       default stored array by array.\\
 
62
                     - a plane at a certain depth is stored column by column \\
 
63
                     Note that this flag also affects the way a vector
 
64
                     is treated!
 
65
\ap\no
 
66
Note:
 
67
               The new OVERPLOT/TABLE command is able to display data 
 
68
            from a 3D table.
 
69
            A 3D table has 3 axes: column, row and depth (or array). The
 
70
            preliminary syntax allows you to define the following planes:
 
71
               #n[i..j]       : a plane along column "n", 
 
72
                                from depth "i" to "j", 
 
73
               @r#n..m[i..j] : a plane along row "r", from column "n" 
 
74
                                to "m" and from depth "i" to "j", 
 
75
               [i]#n..m      : a plane along depth "i", from column "n" 
 
76
                                to "m". 
 
77
            It is also possible to refer to a column by its name ":name".
 
78
            The default for the range in depth or columns are all selected 
 
79
            elements along the depth or column axis. 
 
80
            To specify one element one may type [i] or #n. A range of rows 
 
81
            can only be selected by using the command SELECT/TABLE. 
 
82
               When the user gives a "?" for one of the two planes the 
 
83
            values in the other plane will plotted against its sequence number.
 
84
            Only one of the plane input parameters can be defaulted to 
 
85
            sequence number. So, `table plane1 ?' and `table ? plane2' 
 
86
            are both valid input parameter strings, `table ? ?' is not. 
 
87
               The program allows to plot data extracted from planes with 
 
88
            different orientations against each other. But the number of
 
89
            elements along the first axis of the planes have to be equal.
 
90
            Remember that you can define the first axis by using "flag_dir". 
 
91
               It is possible to plot a vector against a plane or the 
 
92
            other way around:
 
93
            plane1 = @3[4] (a vector along row 3 at array element 4) and 
 
94
            plane2 = @6    (a plane with all the data values at row 6). 
 
95
            The program will apply the same restrictions to the first plane
 
96
            as put on the second plane, ONLY if both planes have the same
 
97
            orientation AND if the first plane is defaulted to all elements
 
98
            in a certain direction, while the second is not. 
 
99
            For example: if plane1 = #2 and plane2 = #3[2..5] then the 
 
100
            program will only extract array elements 2 to 5 from both planes. 
 
101
            If you do not want this you will have to define first plane2 
 
102
            and plane1 as the next parameter or explicitly define the first 
 
103
            plane from the first to the last element. 
 
104
               The 2-D version of OVERPLOT/TABLE is rewritten in such a 
 
105
            way that the old parameter list is still valid if your input 
 
106
            table is 2-D. The program will treat a column as a plane with 
 
107
            one array element at depth = 1. But you can also define a row 
 
108
            and plot it against an other row, column or sequence number.
 
109
               The functions LOG and LN, decimal and natural logs
 
110
            respectively, can be applied to the data to be plotted.
 
111
               Be aware that in case you plan to connect the data points with 
 
112
            a line (see SET/GRAPHICS) the data points will be connected in the
 
113
            same order as they appear in the table. In order to sort the data
 
114
            first (either in decreasing or increasing order) use the sorting
 
115
            command SORT/TABLE.
 
116
               After the overplot the last (over)plotted data set is the 
 
117
            active one and subsequent commands will work on these data.
 
118
 
 
119
            Note: This command is currently not working for images with
 
120
            non-linear world coordinates. Use LOAD/TABLE in that case.
 
121
\on\see
 
122
See also:   
 
123
            PLOT/TABLE, PLOT/ERROR, TUTORIAL/GRAPH,SET/GRAPHICS, SHOW/GRAPHICS
 
124
\ees\exs
 
125
Examples:
 
126
\ex
 
127
            OVERPLOT/TAB 2D-table :MAGNITUDE LOG(:TEMPERATURE)
 
128
            Overplot column :MAGNITUDE versus the logarithmic value of column 
 
129
            :TEMPERATURE (base 10) of table `2D-table'.
 
130
\xe\ex
 
131
            OVERPLOT/TAB 3D-table LN(#3[1]) ?  3:6:1,10  ? Def,Op 
 
132
            Will do the same as the previous example. But it will plot the 
 
133
            first array element of a plane along column 3 against sequence
 
134
            number.
 
135
\xe\ex
 
136
            OVERPLOT/TAB 3D-table #3 #5 3:6:1,10 1,4
 
137
            Plot the values found in a plane along column 3 against column 5.
 
138
            The data will be presented according to the following scheme: 
 
139
            array element:  1  2  3  4  5  6  7  8  etc. 
 
140
            line type    :  1  4  1  4  1  4  1  4  ...  
 
141
            symbol type  :  3  4  5  6 10  3  4  5  ...  
 
142
\xe\ex
 
143
            OVERPLOT/TAB 3D-table @3:name @5 3:6:1,10 1,4
 
144
            Take a vector at row 3, column "name" as abscissa and 
 
145
            the plane along row 5 in the depth direction as ordinate. 
 
146
            Plotted with the same line and symbol types as in the previous 
 
147
            example. The vector and plane are both read (by default) array
 
148
            by array, thus there are no dimensional problems.
 
149
\xe\ex
 
150
            OVERPLOT/TAB 3D-table [3]#1..4 #2[1..4] 3:6:1,10 1,4
 
151
            Take plane along depth 3, from column 1 to 4 as abscissa and 
 
152
            the plane along column 2, from depth 1 to 4 as ordinate.
 
153
            Both planes are read column by column so four lines will be
 
154
            plotted with resp. line type 1, 4, 1, 4.
 
155
\xe \sxe