← Back to branch summary

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

« back to all changes in this revision

Viewing changes to contrib/wavelet/help/citterwave.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:
contrib/wavelet/help/citterwave.hlq
 
1
% @(#)citterwave.hlq    19.1 (ESO-IPG) 02/25/03 13:34:18
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1993 European Southern Observatory
 
4
%.IDENT      citterwave.hlq
 
5
%.AUTHOR     18-MAY-93, IPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, 
 
7
%.PURPOSE    On-line help file for the command: CITTERT/WAVE
 
8
%.VERSION    1.0  JS : Creation, 18-MAY-93
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./WAVE
 
12
\es\co
 
13
CITTERT/WAVE                                       JS  18-MAY-93
 
14
\oc\su
 
15
CITTERT/WAVE  Image_In Psf Imag_Out [residual] [Nb_Scales, Max_Iter]
 
16
               [N_Sigma, Noise] [Epsilon] [Fwmh]
 
17
\us\pu
 
18
Purpose:    
 
19
            Deconvolution by Van Cittert's algorithm with a regularization
 
20
            in the wavelet space. The deconvolution equation is:\\
 
21
                                I = P * O + B\\
 
22
            where I is the data,  P is the PSF, B is the nopise and O is the 
 
23
            object to determine
 
24
\up\sy
 
25
Syntax:     
 
26
          CITTERT/WAVE Image_In Psf Imag_Out [residual] [Nb_Scales, Max_Iter]
 
27
                       [N_Sigma, Noise] [Epsilon] [Fwhm]
 
28
\ys\pa
 
29
          Image_In = Name of the image I
 
30
\ap\pa
 
31
          Psf =      Name of the Point Spread Function P
 
32
\ap\pa
 
33
          Imag_Out = Name of the deconvolved image O
 
34
\ap\pa
 
35
          residual = Name of the file wich will contain the residual
 
36
                      residual = I - P * O\\  
 
37
                      default value is "residual.bdf"       
 
38
\ap\ap
 
39
          Nbr_Scale = Number of scales of the wavelet transform; default 4.
 
40
\ap\pa
 
41
          Max_Iter = maximum number of iterations; The default value is 100
 
42
\ap\pa
 
43
          N_Sigma =  threshold parameter
 
44
                     The threshold level_j at a scale j of the wavelet 
 
45
                     transform:\\
 
46
                       Level_j = N_Sigma * Noise_Standard_Deviation_Scale_j
 
47
                     The standard deviation of the noise at the scale j is
 
48
                     estimated from the noise standard deviation of the image
 
49
                     N_Sigma = 4 is the default value.
 
50
\ap\pa
 
51
          Sigma_Noise = Standard deviation of the noise. If Sigma_Noise = 0. 
 
52
                     then the standard deviation of the noise is estimated in 
 
53
                     the program. The default value is 0.
 
54
\ap\pa
 
55
          Epsilon =  Convergence parameter; default value is 0.001
 
56
\ap\pa
 
57
          Fwhm =     Full Width at Half Maximum. This parameter allows us to 
 
58
                     reduce the resolution in the deconvolved image. If 
 
59
                     Fwhm is greater than 0. then the resolution is limited 
 
60
                     the image of a star will be Gaussian with a a full width 
 
61
                     at half maximum equal to Fwmh. 
 
62
\ap\see
 
63
See also: 
 
64
          TRANSF/WAVE, FILTER/WAVE, LUCY/WAVE, GRAD/WAVE
 
65
\ees\no
 
66
Note:       
 
67
          none
 
68
\on\exs
 
69
Examples:
 
70
\ex
 
71
            CITTERT/WAVE  data psf result
 
72
            deconvolves the frame data by the psf and stores the
 
73
            deconvolved image in result. 
 
74
\xe\ex
 
75
            CITTERT/WAVE data psf result ? 4,300 3.5,50  
 
76
            the standard deviation of the noise is 50, and the threshold
 
77
            level at the scale j is: 3.5 * Standard_deviation_Scale_j
 
78
            the maximum number of iterations is 300. But the program can
 
79
            stop before, due to the convergence parameter. 4 scales are
 
80
            used in the wavelet transform.
 
81
\xe\ex
 
82
            CITTERT/WAVE data psf result ? 4,50 ? 0. 3.
 
83
            set the convergence paramater to zero, and the number of
 
84
            iterations to 50. In this case, 50 fifty iterations will be 
 
85
            done. The Full Width at Half Maximum is equal to 3.
 
86
\xe\sxe
 
87
 
 
88
 
 
89