← Back to branch summary

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

« back to all changes in this revision

Viewing changes to stdred/irspec/help/subtrairsp.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:
stdred/irspec/help/subtrairsp.hlq
 
1
% @(#)subtrairsp.hlq    19.1 (ESO-IPG) 02/25/03 14:23:17 
 
2
% @(#)
 
3
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
4
%.COPYRIGHT  (c)  1992 European Southern Observatory
 
5
%.IDENT      rectifirsp.hlq
 
6
%.AUTHOR     E.Oliva, Arcetri (Florence)
 
7
%.KEYWORDS   MIDAS, help files, SUBTRACT/IRSPEC
 
8
%.PURPOSE    On-line help file for the command: SUBTRACT/IRSPEC
 
9
%.VERSION    1.0  22-SEP-1992 : Creation, E.Oliva
 
10
%----------------------------------------------------------------
 
11
\se
 
12
SECTION./IRSPEC
 
13
\es\co
 
14
SUBTRACT/IRSPEC                            22-SEP-1992 EO
 
15
\oc\su
 
16
SUBTRACT/IRSPEC in_ima out_ima degree [exclude=area_to_exclude]
 
17
             [cont=continuum_image] [load=load_option]
 
18
         Fit and subtract, row by row, polynomial to a given image.
 
19
\us\pu
 
20
Purpose:    To subtract, row by row, a polynomial fit of the continuum
 
21
            from an image. The user can exclude one or more areas from
 
22
            the fit. An image containing the fitted continua can be
 
23
            also produced, if requested.
 
24
\up\sy
 
25
Syntax:     SUBTRACT/IRSPEC in_ima out_ima degree [exclude=area_to_exclude]
 
26
                            [cont=continuum_image] [load=load_option]
 
27
\ys\pa
 
28
            in_ima   = Name of the input image. Can be either 2D or 1D,
 
29
                       untouched on exit.
 
30
\ap\pa
 
31
            out_ima  = Name of the output, continuum subtracted image.
 
32
                       It will have the same size and limits as in_ima.
 
33
\ap\pa
 
34
            degree   = Degree of the interpolating polynomials.\\
 
35
\\
 
36
            Additional parameters and options.
 
37
\ap\pa
 
38
            area_to_exclude=\\
 
39
                       Defines the region(s) to exclude from the fit
 
40
                       (e.g. regions containing strong lines). You have
 
41
                       three possibilities:\\
 
42
                     - CURSOR (the default) will ask you to define with
 
43
                       the cursor the area(s) to exclude;\\
 
44
                     - [xs,ys:xe,ye] (or [xs:xe] for 1D images) defines 
 
45
                       a given area of the image (see HELP EXTR/IMA if
 
46
                       you are not familiar with this syntax);\\
 
47
                     - table_name,tbl (e.g. mytable,tbl) in case the
 
48
                       regions to exclude are stored in a table; you
 
49
                       may want to create it with the cursor using
 
50
                         GET/CURSOR table_name ? ? 999,2\\
 
51
                       for 2D images and\\
 
52
                         GET/GCURS  table_name\\
 
53
                       for 1D images.
 
54
\ap\pa
 
55
            continuum_image=\\
 
56
                       Optional name of the image containing the fitted
 
57
                       continua, defaulted to - none - (no image created).
 
58
\ap\pa
 
59
            load_option = 0,1 default=1.
 
60
                       If =0 the command works silently.
 
61
                       if =1 (default) it will display the image before 
 
62
                       and after the continuum subtraction.
 
63
\ap\no
 
64
Note:       Working with 2D images be careful not to exclude too many 
 
65
            pixels, you may get funny results. The program may get crazy
 
66
            if you exclude one or more entire rows.
 
67
\on\exs
 
68
Examples:
 
69
\ex         
 
70
            SUBTR/IRS cc0012 cc12sub 3 
 
71
\xe\ex
 
72
            SUBTR/IRS a0118 a118sub 2 e=[@12,@28:@27,@33] c=a118cont
 
73
\xe\ex
 
74
            SUBTR/IRS iras12 iras12nc 3 l=0 c=iras12c e=line2,tab
 
75
\xe\sxe
 
76
 
 
77
 
 
78
 
 
79
 
 
80
 
 
81
 
 
82
 
 
83
 
 
84
 
 
85
 
 
86
 
 
87
 
 
88