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

« back to all changes in this revision

Viewing changes to prim/help/copy_teim.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)  1996 European Southern Observatory
 
3
%.IDENT      tbl2bdf.hlq
 
4
%.AUTHOR     PJG, IPG/ESO
 
5
%.KEYWORDS   MIDAS, help files, 3D-table, image, conversion
 
6
%.PURPOSE    On-line help file for the command: COPY/TEIMA
 
7
%.VERSION    1.0  1996-Apr-12 : Creation, PJG
 
8
%----------------------------------------------------------------
 
9
\se
 
10
SECTION./TEIM
 
11
\es\co
 
12
COPY/TEIMA                                              03-AUG-2010  PJG
 
13
\oc\su
 
14
COPY/TEIMA table column rows [npix] [coor] [prefix]
 
15
        Convert a 3D-table element to a MIDAS image file
 
16
\us\pu
 
17
Purpose:
 
18
           Convert a 3D-table element (vector) to a MIDAS image file
 
19
\up\sy
 
20
Syntax: 
 
21
           COPY/TEIMA table column rows [npix] [coor] [prefix]
 
22
\ys\pa
 
23
           table = name of 3D-table
 
24
\ap\pa
 
25
           column = name of 3D-table column which should be converted to
 
26
                an image
 
27
\ap\pa
 
28
           rows = range of rows to convert
 
29
                The range can be given as a single number (i.e. only one
 
30
                row to convert) or two row numbers separated by comma
 
31
                specifying first and last row.
 
32
\ap\pa
 
33
           npix = list of no. of pixels in each dimension or column
 
34
                (of interger type) with the numbers
 
35
                If the total size of the image specified is larger than
 
36
                the length of the column element, column values will be
 
37
                repeated to fill the image. The default is a 1D image
 
38
                with a size of the column.      
 
39
\ap\pa
 
40
           coor = list of start values followed but a list of step sizes
 
41
                for each dimension or two columns (of real type) 
 
42
                with start and step values.  Either explicit values or
 
43
                columns must be used - a mix is not allowed.  Columns
 
44
                specified must have a size corresponding to the
 
45
                dimension given by the `npix' parameter.
 
46
                Default values for both start and step are 1.0.
 
47
\ap\pa
 
48
           prefix = prefix for image file to be created.
 
49
                The file name will be constructed using the prefix and
 
50
                the row number with a minmum of 4 digits. The default
 
51
                prefix is 'image'.
 
52
\ap\sa
 
53
See also:
 
54
           COPY/T3IMA, COPY/TI
 
55
\as\no
 
56
Note:
 
57
           The type of the image will be D_R8_FORMAT if the column type is 
 
58
           D_R8_FORMAT, otherwise its type will be D_R4_FORMAT. 
 
59
           If the table has a :IDENT column of character type, it will be
 
60
           used as identifier of the image.
 
61
 
 
62
           Only selected rows are processed.
 
63
\on\exs
 
64
Examples:
 
65
\ex
 
66
           COPY/TEIMA mytable :image 2,34  231 200,1 test
 
67
             Convert rows 2 to 34 of column :image in table `mytable.tbl'
 
68
             to bdf-files forcing them to be 1D with 231 pixels each.
 
69
             The start and step are 200.0 and 1.0, respectively.
 
70
             The file names will be `test0002.bdf' etc.
 
71
\xe\ex
 
72
           COPY/TEIMA myspc :spec 1023  :npix :start,:step spec
 
73
             Convert row 1023  of column :spec in table `myspc.tbl' using
 
74
             the dimension defined in the column :npix.  Start and step are
 
75
             taken from columns :start and :step, respectively.
 
76
             The file `spec1023.bdf' will be created.
 
77
\xe \sxe