← Back to branch summary

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

« back to all changes in this revision

Viewing changes to stdred/ccdred/help/skyflaccd.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/ccdred/help/skyflaccd.hlq
 
1
% @(#)skyflaccd.hlq     19.1 (ESO-IPG) 02/25/03 14:15:05
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1993 European Southern Observatory
 
4
%.IDENT      skyflaccd.hlq
 
5
%.AUTHOR     RHW, IPG/ESO
 
6
%.KEYWORDS   MIDAS, ccd package, SKYFLAT/CCD
 
7
%.PURPOSE    On-line help file for the command: SKYFLAT/CCD
 
8
%.VERSION    930827 RHW Documentation created
 
9
%---------------------------------------------------------------------
 
10
\se
 
11
SECTION./CCD
 
12
\es\co
 
13
SKYFLAT/CCD                                                     25-Mar-1993 RHW
 
14
\oc\su
 
15
SKYCOR/CCD [in_spec] [out_frm] [xboxmn,xboxmx] [yboxmn,yboxmx] [clip] 
 
16
           [lowsig,higsig]
 
17
        Apply sky observation to flat field to remove illumination pattern
 
18
\us\pu
 
19
Purpose: 
 
20
        Apply sky observation to flat field to remove illumination pattern
 
21
\up\sy
 
22
Syntax:     
 
23
        SKYFLAT/CCD [in_spec] [out_frm] [xboxmn,xboxmx] [yboxmn,yboxmx]
 
24
                    [clip] [lowsig,higsig]
 
25
\ys\pa
 
26
        in_spec = single sky frame or MIDAS CCD reduction table (with the
 
27
                  extension .tbl) containing the names of the sky frame(s) 
 
28
                  in column :SKY. Default input is taken from the keyword 
 
29
                  CCD_IN.
 
30
\ap\pa
 
31
        out_frm = name of the illumination corrected sky flat field. Default 
 
32
                  the output file the same as the input sky flat frame. Hence,
 
33
                  by default the input sky flat frame will be OVERWRITTEN.\\
 
34
                  This parameter is only used is case of single frame input 
 
35
                  for the first parameter. In case the output is taken a 
 
36
                  reduction table the output frame(s) will also OVERWRITE the 
 
37
                  original flat frames.
 
38
\ap\pa  
 
39
        xboxmn,xboxmx = minimum and maximum smoothing box size along the x 
 
40
                  axes.  The minimum box size is used at the edges and grows 
 
41
                  to the maximum size in the middle of the image.  This 
 
42
                  allows the smoothed image to better represent gradients 
 
43
                  at the edge of the image. If a size is less then 1 it is 
 
44
                  interpreted as a fraction of the image size. If a size is
 
45
                  greater than or equal to 1 then it is the box size in 
 
46
                  pixels.  A size greater than the size of image selects a 
 
47
                  box equal to the size of the image. Default values are taken
 
48
                  from the keyword IL_XBOX.
 
49
\ap\pa
 
50
        yboxmn,yboxmx = see above. Default values are taken from IL_YBOX.
 
51
\ap\pa
 
52
        clip =    Clean the input frame(s) of objects? If yes then a clipping 
 
53
                  algorithm is used to detect and exclude objects from the 
 
54
                  smoothing. Default taken from IL_CLIP.
 
55
\ap\pa
 
56
        lowsig,higgsig = sigma clipping thresholds above and below the 
 
57
                  smoothed illumination. Default values are taken from
 
58
                  the keyword IL_SIGMA. The keyword is only read in case 
 
59
                  clip=yes.
 
60
\ap\no
 
61
Note:     
 
62
        The command operates very similar to the command REDUCE/CCD, which
 
63
        the exception that the command not check for the exposure type of 
 
64
        the input frame.
 
65
 
 
66
        In case the input is an association table the command will check for
 
67
        the existence of the flat frames in the column :SKY in the association
 
68
        table. Flat frames that do not exit will be created first, provided 
 
69
        the association table contain the :SKY column. Other relevant 
 
70
        calibration frames for processing the flat frames, will be taken 
 
71
        from the corresponding calibration columns.\\
 
72
 
 
73
        After the reduced sky frame is obtained, the sky illumination frame 
 
74
        is produced by heavily smoothing the calibrated sky frames using a 
 
75
        moving "boxcar" average. The effects of objects in the frames may be 
 
76
        minimized by using a sigma clipping algorithm to detect and exclude 
 
77
        the objects from the average. This illumination frame will be used to 
 
78
        make an illumination corrected flat field (sky flat) according to the 
 
79
        formula: \\
 
80
                     f_new = f_old*ill_sky/scale, where\\
 
81
        f_new is the corrected flat field, f_old is the original input flat,
 
82
        used to reduce the blank sky frame, ill_sky is the illumination 
 
83
        correction determined from the sky, and scale is the nomalisation 
 
84
        factor. \\
 
85
 
 
86
        The original flat frame is multiplied by the scaled sky illumination 
 
87
        correction frame to produce the illumination corrected flat. The 
 
88
        output will OVERWRITE the original (reduced) flat frames. Hence, the 
 
89
        output sky flat will automatically be used as flat in subsequent 
 
90
        calibration procedure(s).\\
 
91
        NOTE: THE MASTER FLAT FIELDS WILL BE OVERWRITTEN BY THE CORRECTED ONES.
 
92
\\
 
93
        In the case of single frame input and all calibration frames input 
 
94
        will be taken from the SC_ keywords and must exist. Also here, by
 
95
        default in the output illumination corrected flat will replace the 
 
96
        input flat.\\
 
97
 
 
98
        The IM_SEC keyword may be used to assign a region of interest for which
 
99
        the correction has to be done.\\
 
100
 
 
101
        For more information see the CCD chapter in Volume B of the User's 
 
102
        manual.
 
103
 
 
104
\on\see
 
105
See also:   
 
106
        SET/CCD, SHOW/CCD, HELP/CCD, REDUCE/CCD, SKYCOR/CCD, 
 
107
\ees\exs
 
108
Examples:
 
109
\ex
 
110
        SKYFLAT/CCD redtbl.tbl
 
111
        Reduce all sky frames in the the ccd reduction table redtbl.tbl. All 
 
112
        master calibration frames will be obtained from that reduction table. 
 
113
        Do the calibration according to the keyword settings, including the 
 
114
        flat fielding. From the calibrated sky produce the illumination frame,
 
115
        using the  `IL_' keyword settings. Hereafter compute the output sky 
 
116
        flat by multiplying the illumination frame with the original flat 
 
117
        field. The output sky flats will have overwrite the original flats.
 
118
\xe\ex
 
119
        SKYFLAT/CCD m100rraw_sk m100rraw_sf
 
120
        Start the ccd reduction sequence for the frame m100rraw. The output
 
121
        frame will be m100rraw_sf. In case only dark and flat field correction
 
122
        is to be applied the names of these two calibration frames will be 
 
123
        obtained from the keyword SC_DKFRM and SC_FFFRM, respectively.
 
124
\xe\sxe
 
125
 
 
126
 
 
127