casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CSCleanImageSkyModel.h
Go to the documentation of this file.
1 //# CSCleanImageSkyModel.h: Definition for CSCleanImageSkyModel
2 //# Copyright (C) 1996,1997,1998,1999,2000,2003
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_CSCLEANIMAGESKYMODEL_H
30 #define SYNTHESIS_CSCLEANIMAGESKYMODEL_H
31 
34 namespace casacore{
35 
36 template<class T> class Lattice;
37 }
38 
39 namespace casa { //# NAMESPACE CASA - BEGIN
40 
41 //forward
42 class SkyEquation;
43 
44 // <summary>
45 // CS Image Sky Model: Image Sky Model implementing the CS Clean algorithm
46 // </summary>
47 
48 // <use visibility=export>
49 
50 // <reviewed reviewer="" date="" tests="" demos="">
51 
52 // <prerequisite>
53 // <li> <linkto class=ImageSkyModel>ImageSkyModel</linkto> module
54 // </prerequisite>
55 //
56 // <etymology>
57 // CSCleanImageSkyModel implements the Cotton-Schwab Clean algorithm.
58 // It is derived from <linkto class=SkyModel>SkyModel</linkto>.
59 // </etymology>
60 //
61 // <synopsis>
62 // The CS Clean is an FFT-based clean algorithm. Cleaning is
63 // split into major and minor cycles. In a minor cycle, the
64 // brightest pixels are cleaned using only the strongest sidelobes
65 // (and main lobe) of the PSF. In the major cycle, a fully correct
66 // subtraction of the PSF is done for all points accumulated in the
67 // minor cycle by degridding and degridding.
68 //
69 // The CS Clean is implemented using the <linkto class=ClarkCleanModel</linkto>
70 // class.
71 //
72 // Masking is optionally performed using a mask image: only points
73 // where the mask is non-zero are cleaned. If no mask is specified
74 // all points in the inner quarter of the image are cleaned.
75 // </synopsis>
76 //
77 // <example>
78 // See the example for <linkto class=SkyModel>SkyModel</linkto>.
79 // </example>
80 //
81 // <motivation>
82 // </motivation>
83 //
84 // <todo asof="97/10/01">
85 // <ul> Allow specification of more control parameters
86 // </todo>
87 
89 public:
90 
92 
94 
96 
97  // Solve for this SkyModel
98  virtual casacore::Bool solve (SkyEquation& me);
99 
100 protected:
101  // Return the maximum absolute value per field
103  // Return maximum abs outer sidelobe, more than nCenter pixels from the center
105  // Pointer to the progress display object
107 
108 };
109 
110 
111 } //# NAMESPACE CASA - END
112 
113 #endif
114 
115 
int Int
Definition: aipstype.h:50
casacore::Vector< casacore::Float > outerMinMax(casacore::Lattice< casacore::Float > &lat, const casacore::uInt nCenter)
virtual casacore::Bool addResidual(casacore::Int image, casacore::ImageInterface< casacore::Float > &residual)
Add a residual image.
casacore::ImageInterface< casacore::Float > & residual(casacore::Int model=0)
CS Image Sky Model: Image Sky Model implementing the CS Clean algorithm.
casacore::ImageInterface< casacore::Float > & mask(casacore::Int model=0)
Return masks.
virtual casacore::Int add(casacore::ImageInterface< casacore::Float > &image, const casacore::Int maxNumXfr=100)
Add an image.
virtual casacore::Bool solve(SkyEquation &me)
Solve for this SkyModel: This replaces the image with the residual image.
Abstract base class to monitor progress in lattice operations.
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
casacore::Float maxField(casacore::Block< casacore::Vector< casacore::Float > > &imagemax, casacore::Block< casacore::Vector< casacore::Float > > &imagemin)
float Float
Definition: aipstype.h:54
ClarkCleanProgress * progress_p
virtual casacore::Bool addMask(casacore::Int image, casacore::ImageInterface< casacore::Float > &mask)
Add an mask.
simple 1-D array
Image Sky Model: Image-based Model for the Sky Brightness.
casacore::ImageInterface< casacore::Float > & image(casacore::Int model=0)
Return actual images to be used by SkyEquation.
unsigned int uInt
Definition: aipstype.h:51
#define casacore
&lt;X11/Intrinsic.h&gt; #defines true, false, casacore::Bool, and String.
Definition: X11Intrinsic.h:42