← Back to branch summary

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

« back to all changes in this revision

Viewing changes to stdred/echelle/help/extracopti.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/echelle/help/extracopti.hlq
 
1
% @(#)extracopti.hlq    19.1 (ESO-IPG) 02/25/03 14:18:33 
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
4
%.IDENT      extracopti.hlq
 
5
%.AUTHOR     MP, IPG/ESO; SW, DMD/ESO
 
6
%.KEYWORDS   MIDAS, help files, EXTRACT/OPTIMAL
 
7
%.PURPOSE    On-line help file for the command: EXTRACT/OPTIMAL
 
8
%.VERSION    1.0  28-NOV-1991 : Creation, MP
 
9
%            2.0  09-SEP-1999 : cosmic ray rejection, variance calculation
 
10
%                               and calc parameter added.
 
11
%----------------------------------------------------------------
 
12
\se
 
13
SECTION./OPTI
 
14
\es\co
 
15
EXTRACT/OPTIMAL                                         09-SEP-1999 MP/SW
 
16
\oc\su
 
17
EXTR/OPT input output  slit,ord1,ord2  [ron,g,sigma] [table] [coeffs] [calc]
 
18
         weigthed extraction of echelle orders
 
19
\us\pu
 
20
Purpose:    
 
21
            Extract echelle orders. Position of the orders are defined
 
22
            in the auxiliary table order.tbl, generated with the command
 
23
            DEFINE/ECHELLE or DEFINE/HOUGH. Orders are extracted by 
 
24
            calculating a weighted sum of the pixels values across the
 
25
            profile of the object. The algorithm is based on a paper from
 
26
            Koji Mukai(1990, Optimal Extraction of Cross-Dispersed Spectra,
 
27
            Pub. of Astr. Soc of the pacific,102:183-189).
 
28
\up\sy
 
29
Syntax:     EXTR/OPT in out slit,ord1,ord2 [ron,g,sigma] [table] [coeff] [calc]
 
30
\ys\pa
 
31
            in          = input image sampled in the usual pixel-pixel space
 
32
\ap\pa
 
33
            out         = extracted image sampled in the space pixel-order
 
34
\ap\pa
 
35
            slit        = numerical slit length in pixels
 
36
\ap\pa
 
37
            ord1,ord2   = number of the first and last order to extract.
 
38
                          Relative order numbers are displayed by the
 
39
                          command LOAD/ECHELLE.
 
40
\ap\pa
 
41
            ron,g,sigma = read-out-noise(e-), inverse gain factor (e-/ADU),
 
42
                          threshold for the removal of cosmic ray hits 
 
43
                          (in units of the standard deviation calculated
 
44
                          for each pixel from the number of electrons and
 
45
                          the ron.
 
46
                          If not provided on the command line, these values
 
47
                          are read from echelle keywords RON, GAIN, EXTSIGMA.
 
48
\ap\pa
 
49
            table   =     name of the input table providing the order 
 
50
                          definition. Default: order.tbl
 
51
\ap\pa
 
52
            coeff   =     name of the descriptor providing the coefficients
 
53
                          of the order definition. Default: COEFF.
 
54
\ap\pa
 
55
            calc    =     determine/apply weights for optimal extraction.
 
56
                          Y,name: do an optimal extraction and store the
 
57
                               weights in name.
 
58
                          N,name:  do an optimal extraction using the weights
 
59
                               name of a previously performed extraction.
 
60
                          Default: Y,weight.bdf
 
61
\ap\no
 
62
Note:       
 
63
            The parameter slit defines the integer length of the numerical
 
64
            extraction slit centered on the  current order center at every
 
65
            position along the dispersion direction. (We suppose that the
 
66
            command DEFINE/ECHELLE or DEFINE/HOUGH has been used previously 
 
67
            to find the position of the orders )
 
68
            The weigths are proportional  to the mean  order profile 
 
69
            perpendicular to the dispersion direction.
 
70
 
 
71
            This version of this command is now able to remove cosmic rays.
 
72
            Furthermore, a variance frame of the extracted orders will be
 
73
            produced. The variance frame has the same name as the extracted
 
74
            data with the prefix 'var_'.
 
75
 
 
76
            EXTRACT/OPTIMAL produces averaged spectra in the pixel-order
 
77
            space. In order to get the integral extracted orders you only have
 
78
            to multiply your result frame by the slit parameter and the
 
79
            variance frame by the squared slit parameter.
 
80
 
 
81
\on\exs
 
82
Examples:
 
83
\ex
 
84
            EXTRACT/OPT raw extract  6,1,15  40,10.,3. 
 
85
\xe\ex
 
86
            Do an optimal extraction of the object
 
87
 
 
88
            EXTRACT/OPT obj extrobj  15,1,20 ? ? ? Y,objwght.bdf
 
89
 
 
90
            Do an optimal extraction of the flatfield using the same weights
 
91
            as for the optimal extraction of the object.
 
92
 
 
93
            EXTRACT/OPT flat extrflat  15,1,20 ? ? ? N,objwght.bdf
 
94
\xe\sxe
 
95
 
 
96
 
 
97
 
 
98
 
 
99
 
 
100