← Back to branch summary

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

« back to all changes in this revision

Viewing changes to stdred/feros/help/extracfero.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/feros/help/extracfero.hlq
 
1
% @(#)extracfero.hlq    19.1 (ESO-IPG) 02/25/03 14:20:55
 
2
% @(#)extractfero.hlq 1.0 (ESO-IPG) 13-11-1997
 
3
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
4
%.COPYRIGHT  (c)  1997 European Southern Observatory
 
5
%.IDENT      extracfero.hlq
 
6
%.AUTHOR     AM, LSW Heidelberg, IPG/ESO
 
7
%.KEYWORDS   MIDAS, help files, EXTRACT/FEROS 
 
8
%.PURPOSE    On-line help file for the command: EXTRACT/FEROS
 
9
%.VERSION    1.0  13-NOV-97 : Creation, AM
 
10
%----------------------------------------------------------------
 
11
\se
 
12
SECTION./FEROS
 
13
\es\co
 
14
EXTRACT/FEROS                                        23-FEB-99 AM/OS
 
15
\oc\su
 
16
EXTRACT/FEROS straimage extimage extparams otherparams ccdparams copcoefftbl
 
17
        extract spectrum
 
18
\us\pu
 
19
Purpose:    
 
20
            Extract straightened echelle spectrum using the standard or
 
21
            optimum extraction algorithm.
 
22
\up\sy
 
23
Syntax:     
 
24
            EXTRACT/FEROS [straightimage] [extimage] [extparams]
 
25
              [otherparams] [ccdparams] [copcoefftable]
 
26
 
 
27
\ys\pa
 
28
            straightimage = root name of input file
 
29
 
 
30
\ap\pa
 
31
            extimage = root name of output file
 
32
 
 
33
\ap\pa
 
34
            extparams = spectrograph extractmode getprofile writeimages
 
35
            Extraction parameters
 
36
                spectrograph = spectrograph type
 
37
                valid values are
 
38
                F for single fiber and
 
39
                G for double fiber (default)
 
40
                
 
41
                extractmode = extraction mode
 
42
                valid values are
 
43
                S for standard extraction, (default)
 
44
                O for optimum extraction with cosmic masking and
 
45
                M for standard extraction with cosmic masking
 
46
                
 
47
                getprofile = get spatial profile
 
48
                valid values are
 
49
                Y for yes (default) and
 
50
                N for no
 
51
 
 
52
                writeimages = write additional images with fitted profile
 
53
                              and masked pixels (optimum extraction only)
 
54
                              this is intended for debugging purposes
 
55
                valid values are
 
56
                Y for yes and
 
57
                N for no (default)
 
58
 
 
59
\ap\pa
 
60
            otherparams = fitdeg,iterations
 
61
            Other parametres
 
62
                fitdeg = degree of the polynomial that is fitted to the orders
 
63
                iterations = number of iterations in optimum extraction
 
64
 
 
65
\ap\pa
 
66
            ccdparams = ccd_ron,ccd_gain,ccd_thres
 
67
            CCD parameters
 
68
                ccd_ron = CCD readout noise (electrons)
 
69
                ccd_gain = CCD gain (electrons / ADU)
 
70
                ccd_thres = threshold value for optimum extraction (ADU)
 
71
 
 
72
\ap\pa
 
73
            copcoefftable = root name of table with coefficients for the
 
74
                            cross order profile
 
75
 
 
76
\ap\sa
 
77
See also: 
 
78
            RECTIFY/FEROS, BACKGR/FEROS, DEFINE/FEROS
 
79
\as\no
 
80
 
 
81
 
 
82
Note:       
 
83
           
 
84
            1) extimage is the root name of the output image. For  single
 
85
               fiber spectrographs this is also the complete name of the
 
86
               output image. For double fiber spectra two output files are
 
87
               created. Their names are generated from the root name and
 
88
               the appendices 1 and 2.
 
89
 
 
90
            2) extparams: The four values must be entered without separators.
 
91
               If getprofile is set to N, then a table named copcoefftable
 
92
               with prevoiusly determined cross order profile coefficients
 
93
               must exist on disk. If writeimages is set to Y, then images
 
94
               with the fitted cross order profile and the masked pixels
 
95
               are written to files named fitted_img.bdf and mask_img.bdf.
 
96
 
 
97
            3) otherparams: iterations can be used to limit the number of
 
98
               masked pixels when using optimum extraction. It is the maximum
 
99
               number of pixels that are allowed to be masked.
 
100
 
 
101
            4) straightimage is only used, if spectrograph is set to F or G.
 
102
               straightimage is the root name of the input image. For single
 
103
               fiber spectrographs the names of the files to be used are
 
104
               generated from the root name and the appendices _C, _D, _X.
 
105
               For double fiber spectrographs  the names of the files to be
 
106
               used are generated from the root name and the appendices _C1,
 
107
               _D1, _X1, _C2, _D2, _X2. straightimage can be created with
 
108
               the command STARIGHTEN/FEROS.
 
109
 
 
110
            5) copcoefftable is the root name of the cross order coefficient
 
111
               file. For single fiber spectrographs this is also the
 
112
               complete name of the coefficient file. For double fiber spectra
 
113
               two coefficient files are created. Their names are generated
 
114
               from the root name and the appendices 1 and 2. If getprofile
 
115
               is set to Y, then the spatial profile is determined from
 
116
               straightimage and the coefficients are saved to copcoefftable.
 
117
               If getprofile is set to N, then a table named copcoefftable
 
118
               with prevoiusly determined cross order profile coefficients
 
119
               must exist on disk.
 
120
 
 
121
            6) The distinction between single fiber and double fiber is
 
122
               made via the keyword FIBER_MODE.
 
123
 
 
124
            7) If writeimages is set to Y, then additional images with
 
125
               fitted cross order profiles with root name specified by
 
126
               the keyword FIT_IMG  and with maskd pixels with root name 
 
127
               specified by the keyword MASK_IMG are written to disk. For
 
128
               single fiber spectrographs the root names are also the complete
 
129
               filenames. For double fiber spectrographs the filenames are
 
130
               generated from the root names and the appendices 1 and 2.
 
131
 
 
132
\on\exs
 
133
Examples:
 
134
\ex
 
135
            EXTRACT/FEROS  ? extracted GOYN ? ? cop_coeffs
 
136
            A double fiber spectrum with root file name straightened
 
137
            is extracted with the optimum exctraction alogrithm and
 
138
            stored in files with root name extracted. The cross order
 
139
            profile is determined from files with root name straghtened
 
140
            and the cross order coefficients are stored in files with
 
141
            root name cop_coeffs. No images with fitted cross order
 
142
            profiles or masked pixels are written.
 
143
\xe\ex
 
144
            EXTRACT/FEROS ? ? FONY
 
145
            A single fiber spectrum is extracted with the optimum
 
146
            extraction algorithm. The cross order profile coefficients
 
147
            are taken from a previously saved file. Default values for
 
148
            the file names and other parametrs are used. Images with
 
149
            fitted cross order profiles and with masked pixels are written
 
150
            to disk.
 
151
\xe \sxe