casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PClarkCleanImageSkyModel.h
Go to the documentation of this file.
1 //# PClarkCleanImageSkyModel.h: Definition for PClarkCleanImageSkyModel
2 //# Copyright (C) 1996,1997,1998,1999,2001
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be adressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //#
27 //# $Id$
28 
29 #ifndef SYNTHESIS_PCLARKCLEANIMAGESKYMODEL_H
30 #define SYNTHESIS_PCLARKCLEANIMAGESKYMODEL_H
31 
33 namespace casa { //# NAMESPACE CASA - BEGIN
34 
35 //forward
36 class SkyEquation;
37 
38 // <summary>
39 // Clark Image Sky Model: Image Sky Model implementing the Clark Clean algorithm
40 // </summary>
41 
42 // <use visibility=export>
43 
44 // <reviewed reviewer="" date="" tests="" demos="">
45 
46 // <prerequisite>
47 // <li> <linkto class=ImageSkyModel>ImageSkyModel</linkto> module
48 // <li> <linkto class=ClarkCleanImageSkyModel>ClarkCleanImageSkyModel</linkto> module
49 // </prerequisite>
50 //
51 // <etymology>
52 // PClarkCleanImageSkyModel implements the Clark Clean algorithm.
53 // It is derived from <linkto class=SkyModel>SkyModel</linkto>.
54 // </etymology>
55 //
56 // <synopsis>
57 // The Clark Clean is an FFT-based clean algorithm. Cleaning is
58 // split into major and minor cycles. In a minor cycle, the
59 // brightest pixels are cleaned using only the strongest sidelobes
60 // (and main lobe) of the PSF. In the major cycle, a fully correct
61 // subtraction of the PSF is done for all points accumulated in the
62 // minor cycle using an FFT-based convolution for speed.
63 //
64 // Masking is optionally performed using a mask image: only points
65 // where the mask is non-zero are cleaned. If no mask is specified
66 // all points in the inner quarter of the image are cleaned.
67 // </synopsis>
68 //
69 // <example>
70 // See the example for <linkto class=SkyModel>SkyModel</linkto>.
71 // </example>
72 //
73 // <motivation>
74 // </motivation>
75 //
76 // <todo asof="97/10/01">
77 // <ul> Allow specification of more control parameters
78 // </todo>
79 
81 public:
82  // Default constructor
84 
85  // Solve for this SkyModel
86  virtual casacore::Bool solve (SkyEquation& me);
87 
88  // Set progress display
89  void setDisplayProgress (const casacore::Bool display )
90  {displayProgress = display;}
91 
92 private:
93  // Progress display flag
95 };
96 
97 
98 } //# NAMESPACE CASA - END
99 
100 #endif
101 
102 
PClarkCleanImageSkyModel()
Default constructor.
void setDisplayProgress(const casacore::Bool display)
Set progress display.
virtual casacore::Bool solve(SkyEquation &me)
Solve for this SkyModel.
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
casacore::Bool displayProgress
Progress display flag.
Image Sky Model: Image-based Model for the Sky Brightness.
Clark Image Sky Model: Image Sky Model implementing the Clark Clean algorithm.