← Back to branch summary

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

« back to all changes in this revision

Viewing changes to prim/help/copy_imt3.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/copy_imt3.hlq
 
1
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
2
%.COPYRIGHT  (c)  2010-2011 European Southern Observatory
 
3
%.IDENT      copy_t3im.hlq
 
4
%.AUTHOR     KB
 
5
%.KEYWORDS   MIDAS, help files, 3D-table, image, conversion
 
6
%.PURPOSE    On-line help file for the command: COPY/IMT3
 
7
%.VERSION    1.0  100830
 
8
%----------------------------------------------------------------
 
9
\se
 
10
SECTION./IT3
 
11
\es\co
 
12
COPY/IMT3                                               05-DEC-2011  KB
 
13
\oc\su
 
14
COPY/IMT3 image table [column,row] [1st_elem,noelem] [option]
 
15
        Convert a MIDAS image into an array column of a 3D-table.
 
16
\us\pu
 
17
Purpose:
 
18
           Convert a MIDAS image into an array column of a 3D-table.
 
19
\up\sy
 
20
Syntax: 
 
21
           COPY/IMT3 image table [column,row] [1st_elem,noelem] [option]
 
22
\ys\pa
 
23
           image = name of image file to be copied/converted
 
24
                for 1-dim images, one row will be filled;
 
25
                for 2-dim images, y-pix rows will be filled
 
26
\ap\pa
 
27
           table = name of new (or existing) 3D-table
 
28
\ap\pa
 
29
           column,row = column ref. and starting row no.;
 
30
                defaulted to :Values,@1
 
31
\ap\pa
 
32
           1st_elem,noelem = 1st element and no. of elements
 
33
                to write in array column;
 
34
                default is 1st element and no. of x-pixels of image,
 
35
                i.e. = 1,npix[0]
 
36
\ap\pa
 
37
           option = update_flag (a) or no. of rows to allocate (b);
 
38
                (a) = UPDATE for updating an existing table;
 
39
                    = NO for creating a new table;
 
40
                (b) = no. of rows to allocate for new table; 
 
41
                defaulted to NO
 
42
\ap\pa
 
43
\ap\sa
 
44
See also:
 
45
           COPY/T3IMA, COPT/T3TAB, COPY/TEIMA, COPY/TI
 
46
\as\no
 
47
Note:
 
48
              Always complete lines of the input image, starting with the
 
49
           1st pixel are taken as input buffer. The parameter 'noelem'
 
50
           then limits the no. of pixels used.
 
51
           Therefore, if you want to copy only a part of an image,
 
52
           this subimage has to be extracted, first, and then used as
 
53
           input for COPY/IMT3.
 
54
              The type of the image will be D_I4_FORMAT for all columns
 
55
           with data of type I1, I2, or I4. 
 
56
              The copy command will be logged and appended to descriptor 
 
57
           HISTORY of the table.
 
58
\on\exs
 
59
Examples:
 
60
\ex
 
61
           COPY/IMT3 conejo coyote 
 
62
             Create table `coyote.tbl' and fill array column :Values
 
63
             with data from image `conejo.bdf'. The elements of this column 
 
64
             will have the size of the image line (npix[0]). If it's a 1-dim 
 
65
             image, only row no. 1 of the table will filled, for a 2-dim image
 
66
             y-pix (npix[1]) rows will be created and filled.
 
67
\xe\ex
 
68
           COPY/IMT3 conejo coyote ? ? 200
 
69
             As above, but allocate at least 200 rows, even if npix[1]
 
70
             of `conejo.bdf' is < 200.
 
71
\xe\ex
 
72
           COPY/IMT3 conejo coyote ? 2, update
 
73
              Update column :Values of `coyote.tbl' and fill the array
 
74
              starting with the 2nd element of the column in row 1.
 
75
              For 2-dim input image npix[1] rows will be filled, unless
 
76
              this would exceed the no. of allocated rows of `coyote.tbl',
 
77
              in that case the no. of rows to fill is truncated.
 
78
\xe\ex
 
79
           COPY/IMT3 conejo coyote :sierra,@2 
 
80
             As above, but create a column labeled :sierra and start with
 
81
             the 2nd row. 
 
82
             OJO: The 1st row of the new table will be also selected but 
 
83
             filled with Null value!.
 
84
\xe\ex
 
85
           COPY/IMT3 conejo puma :sierra,@3 ? UPDA
 
86
              Update column :sierra of `puma.tbl' and add a 3rd row, filled
 
87
              from `conejo.bdf' (if at least 3 rows are allocated).
 
88
\xe \sxe