casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HogbomCleanImageSkyModel.h
Go to the documentation of this file.
1 //# HogbomCleanImageSkyModel.h: Definition for HogbomCleanImageSkyModel
2 //# Copyright (C) 1996,1997,1998,1999,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_HOGBOMCLEANIMAGESKYMODEL_H
30 #define SYNTHESIS_HOGBOMCLEANIMAGESKYMODEL_H
31 
33 namespace casacore{
34 
35 template <class T> class RO_LatticeIterator;
36 }
37 
38 namespace casa { //# NAMESPACE CASA - BEGIN
39 
40 //forward
41 class SkyEquation;
42 // <summary>
43 // Hogbom Clean Image Sky Model: Image Sky Model implementing the Hogbom Clean algorithm
44 // </summary>
45 
46 // <use visibility=export>
47 
48 // <reviewed reviewer="" date="" tests="" demos="">
49 
50 // <prerequisite>
51 // <li> <linkto class=ImageSkyModel>ImageSkyModel</linkto> module
52 // </prerequisite>
53 //
54 // <etymology>
55 // HogbomCleanImageSkyModel implements the Hogbom Clean algorithm.
56 // It is derived from <linkto class=SkyModel>SkyModel</linkto> and uses the
57 // fortran code in hclean.f
58 // </etymology>
59 //
60 // <synopsis>
61 // The Hogbom Clean is the standard classic clean.
62 //
63 // The Hogbom Clean is implemented using the
64 // hclean.f code.
65 //
66 // Masking is optionally performed using a mask image: only points
67 // where the mask is non-zero are cleaned. If no mask is specified
68 // all points in the inner quarter of the image are cleaned.
69 // </synopsis>
70 //
71 // <example>
72 // See the example for <linkto class=SkyModel>SkyModel</linkto>.
73 // </example>
74 //
75 // <motivation>
76 // </motivation>
77 //
78 // <todo asof="97/10/01">
79 // <ul> Allow specification of more control parameters
80 // </todo>
81 
83 public:
84 
85  // Solve for this SkyModel
86  virtual casacore::Bool solve (SkyEquation& me);
88  const casacore::Int& ny,
89  casacore::Int& newNx,
90  casacore::Int& newNy,
92  casacore::Int& xbeg,
93  casacore::Int& xend,
94  casacore::Int& ybeg,
95  casacore::Int& yend);
96 
97 private:
98 };
99 
100 
101 } //# NAMESPACE CASA - END
102 
103 #endif
104 
105 
int Int
Definition: aipstype.h:50
virtual casacore::Bool solve(SkyEquation &me)
Solve for this SkyModel.
Hogbom Clean Image Sky Model: Image Sky Model implementing the Hogbom Clean algorithm.
A readonly iterator for Lattices.
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
Image Sky Model: Image-based Model for the Sky Brightness.
casacore::Matrix< casacore::Float > * makeMaskMatrix(const casacore::Int &nx, const casacore::Int &ny, casacore::Int &newNx, casacore::Int &newNy, casacore::RO_LatticeIterator< casacore::Float > &maskIter, casacore::Int &xbeg, casacore::Int &xend, casacore::Int &ybeg, casacore::Int &yend)
#define casacore
&lt;X11/Intrinsic.h&gt; #defines true, false, casacore::Bool, and String.
Definition: X11Intrinsic.h:42