← Back to branch summary

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

« back to all changes in this revision

Viewing changes to prim/help/extracrefe.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/extracrefe.hlq
 
1
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
2
%.COPYRIGHT  (c)  1986-2008 European Southern Observatory
 
3
%.IDENT      extracrefe.hlq
 
4
%.AUTHOR     KB, IPG/ESO
 
5
%.KEYWORDS   MIDAS, help files, EXTRACT/REFERENCE_IMAGE
 
6
%.PURPOSE    On-line help file for the command: EXTRACT/REFERENCE_IMAGE
 
7
%.VERSION    1.0  04-JUNE-1986 : Creation, KB
 
8
%----------------------------------------------------------------
 
9
\se
 
10
SECTION./REFE
 
11
\es\co
 
12
EXTRACT/REFERENCE_IMAGE                                 22-JAN-2008   KB
 
13
\oc\su
 
14
EXTRACT/REFERENCE_IMAGE in ref out low[,hi] [inout_flag]
 
15
        extract subimage according to reference image
 
16
\us\pu
 
17
Purpose:      
 
18
           Extract pixels from input image according to reference image.
 
19
\up\sy
 
20
Syntax:       
 
21
           EXTRACT/REFERENCE_IMAGE in ref out low[,hi] [inout_flag]
 
22
\ys\pa
 
23
           in = input frame
 
24
\ap\pa
 
25
           ref = reference frame, must have same dimension as input frame;
 
26
              defaulted to the input image
 
27
\ap\pa
 
28
           out = resulting 1-dimensional frame
 
29
\ap\pa
 
30
           low,hi = (closed) interval for pixel values in ref. frame
 
31
              low may be set to "<" to indicate minval of ref. frame
 
32
              hi may be set to ">" to indicate maxval of ref. frame
 
33
\ap\pa
 
34
           inout_flag = IN or OUT, to indicate if we look inside or outside
 
35
              the interval [low,high]
 
36
\ap\no
 
37
Note:         
 
38
           For all pixels in the ref. frame with a value inside or
 
39
           outside the interval [low,hi], depending upon the 'inout_flag'
 
40
           parameter, the corresponding pixels of the input frame are 
 
41
           copied into the result frame, which will be a 1-dim image 
 
42
           (i.e. the pixels will be stored as one vector. 
 
43
              By changing the descriptors NAXIS, NPIX, etc. one could then 
 
44
           adapt the result frame to your needs.
 
45
              A previous version of this command used a different, very
 
46
           simple rule for extracting pixels:
 
47
           For all pixels in the ref. frame with a value >= 'low',
 
48
           the corresponding pixels of the input frame are copied into the
 
49
           result frame.
 
50
           For backwards compatibility this rule is used when only one
 
51
           value is entered for the 'low,hi' parameter and 'inout_flag'
 
52
           is not set.
 
53
              The no. of pixels found is stored in OUTPUTI(15).
 
54
 
 
55
\on\see
 
56
See also:     
 
57
           EXTRACT/IMAGE, EXTRACT/LINE, FIND/PIXEL
 
58
\ees\exs
 
59
Examples:
 
60
\ex
 
61
           EXTRACT/REFERENCE durazno ref result 97.3,> 
 
62
             Frame result.bdf will contain all pixels of durazno.bdf where
 
63
             the corresponding pixel in ref.bdf has a value >= 97.3
 
64
\xe\ex
 
65
           EXTRACT/REFERENCE naranja ref result 97.3,> out
 
66
             Frame result.bdf will contain all pixels of naranja.bdf where
 
67
             the corresponding pixel in ref.bdf has a value < 97.3
 
68
\xe\ex
 
69
           EXTRACT/REFERENCE naranja ? result 97.3,> out
 
70
             Frame result.bdf will contain all pixels of naranja.bdf which
 
71
             have a value < 97.3
 
72
\xe\ex
 
73
           EXTRACT/REFERENCE itest ref result 2.2
 
74
             This is the previous usage of the command: frame result.bdf will 
 
75
             contain all pixels of itest.bdf where the corresponding pixel 
 
76
             in ref.bdf has a value >= 2.2
 
77
\xe\ex
 
78
\xe \sxe