← Back to branch summary

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

« back to all changes in this revision

Viewing changes to prim/help/plot_vect.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/plot_vect.hlq
 
1
%  @(#)plot_vect.hlq    19.1 (ESO-IPG) 02/25/03 14:03:36
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
4
%.IDENT      plot_vect.hlq
 
5
%.AUTHOR     RHW, IPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, PLOT/VECTOR
 
7
%.PURPOSE    On-line help file for the command: PLOT/VECTOR
 
8
%.VERSION    900812 RHW Implementation
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./VECT
 
12
\es\co
 
13
PLOT/VECTOR                                                     26-AUG-1991 RHW
 
14
\oc\su
 
15
PLOT/VECTOR frame_a frame_b [coord_str] [x_sc,y_sc[,x_off,y_off]] [scale_r] 
 
16
            [range] [sm_par] [head]
 
17
        plot vector map from two 2-dim. images with smoothing option
 
18
\us\pu
 
19
Purpose: 
 
20
             Plot vector map from two 2-dim. images with smoothing option
 
21
\up\sy
 
22
Syntax:
 
23
             PLOT/VECTOR frame_a frame_b [coord_str] [x_sc,y_sc[,x_off,y_off]]
 
24
                         [scale_r] [range] [sm_par] [head]
 
25
\ys\pa
 
26
             frame_a =   input frame containing the intensities
 
27
\ap\pa
 
28
             frame_b =   input frame containing the position angles
 
29
\ap\pa
 
30
             coord_str = area to be plotted in standard MIDAS notation; see 
 
31
                         MIDAS Users Guide Chapter 3. Default is either any 
 
32
                         manual setting done with by the SET/GRAPHICS command, 
 
33
                         or the whole area.
 
34
\ap\pa
 
35
             x_sc,y_sc,x_off,y_off = scale or size in the x- and y-direction,
 
36
                         offset in the x- and y-direction. For the scaling x_sc
 
37
                         and y_sc, positive numbers are interpreted as scale
 
38
                         parameters (world units/mm), negative numbers as size
 
39
                         parameters (axis will be made sc_* mm. long). A
 
40
                         combination of a positive and negative number is
 
41
                         allowed. By default the plot fills the device area. \\
 
42
                         x_off and y_off determine the distance of the lower
 
43
                         left corner of the plot to the lower left corner of 
 
44
                         the graphic device, measured in mm. By default, the 
 
45
                         plot is put at the top left of the graphic device, 
 
46
                         allowing space for the various labels.
 
47
\ap\pa
 
48
             scale_r =   scale of the vector length in intensity units/mm. By
 
49
                         default the command computes the average of the 
 
50
                         minimimum and maximum cut values in the descriptor of
 
51
                         frame_a; this average intensity will correspond to a
 
52
                         vector length of 10 mm.
 
53
\ap\pa
 
54
             range =     intensity and position angle (in degrees) ranges to 
 
55
                         be plotted. Default is all vectors (i.e. 0,0,0,360 =
 
56
                         all intensities and all position angles). The position
 
57
                         angle is defined using the standard astronomical 
 
58
                         convention: 0 is pointing to the top, and the angle 
 
59
                         increases counter-clockwise. For the length of the 
 
60
                         vector the absolute values of the pixels in the 
 
61
                         intensity image is taken; The postion angles are 
 
62
                         assumed positive.
 
63
\ap\pa
 
64
             sm_par    = smoothing parameter i.e. the number of pixels "around"
 
65
                         the central pixel which define the neighbourhood of
 
66
                         that pixel. \\
 
67
                         Total number of pixels is then: (2*sm_par + 1)**2 
 
68
                         Only integer numbers are allowed. Default is 0
 
69
\ap\pa
 
70
             head      = integer number. If the vector should have an arrow at
 
71
                         its end this parameter should be 1, else give a 0.
 
72
                         Default is 1, i.e. the arrow is drawn.
 
73
\ap\no
 
74
Note:        
 
75
             The coordinates for the area are optional. If one specifies a "?",
 
76
             the area will be take for the manual frame settings for the x-
 
77
             and y-axis. If "C" is given, the window is selected interactively
 
78
             on the display screen using the cursor facilities. The cursor will
 
79
             be set on automatically, if it is not already. To pick up the
 
80
             coordinates, switch the cursors ON and press ENTER. To exit,
 
81
             switch the cursors OFF and press ENTER.
 
82
\on\see
 
83
See also:
 
84
             OVERPLOT/VECTOR, SHOW/GRAPHICS, SET/GRAPHICS, PLOT/AXES, 
 
85
             PLOT/CONTOUR, OVERPLOT/CONTOUR, PLOT/GRAY, OVERPLOT/GRAY
 
86
\ees\exs
 
87
Examples:
 
88
\ex
 
89
             PLOT/VECT spir_i spir_p [@281,@281:@320,@320] ? 0.5 ? 1
 
90
             Plot the polarisation vector using the intensities from spir_i
 
91
             and the position angle information form spir_p. Use the default
 
92
             scale for the axes, and a scale of 0.5 units/mm for the size of
 
93
             the vectors (i.e. an intensity of 10 pixel units will make the
 
94
             vector 20 mm). Apply a box smoothing over 3x3 pixels.
 
95
\xe \sxe