casa6

//# ClarkCleanModel.h: this defines ClarkCleanModel

//# Copyright (C) 1996,1997,1998,1999,2000,2003

//# Associated Universities, Inc. Washington DC, USA.

//#

//# This library is free software; you can redistribute it and/or modify it

//# under the terms of the GNU Library General Public License as published by

//# the Free Software Foundation; either version 2 of the License, or (at your

//# option) any later version.

//#

//# This library is distributed in the hope that it will be useful, but WITHOUT

//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public

//# License for more details.

//#

//# You should have received a copy of the GNU Library General Public License

//# along with this library; if not, write to the Free Software Foundation,

//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.

//#

//# Correspondence concerning AIPS++ should be addressed as follows:

//#        Internet email: aips2-request@nrao.edu.

//#        Postal address: AIPS++ Project Office

//#                        National Radio Astronomy Observatory

//#                        520 Edgemont Road

//#                        Charlottesville, VA 22903-2475 USA

//#

//#

//# $Id$

​

#ifndef SYNTHESIS_CLARKCLEANMODEL_H

#define SYNTHESIS_CLARKCLEANMODEL_H

​

#include <casa/aips.h>

#include <casa/Arrays/Matrix.h>

#include <casa/Arrays/Vector.h>

#include <casa/Arrays/Array.h>

#include <synthesis/MeasurementEquations/ArrayModel.h>

#include <synthesis/MeasurementEquations/Iterate.h>

//#include <synthesis/MeasurementEquations/ResidualEquation.h>

#include <synthesis/MeasurementEquations/ConvolutionEquation.h>

#include <casa/Logging/LogIO.h>

​

namespace casa { //# NAMESPACE CASA - BEGIN

​

class ClarkCleanProgress;

​

// <summary>

// A Class for performing the Clark Clean Algorithm on Arrays

// </summary>

​

// <use visibility=export>

​

// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">

// </reviewed>

​

// <prerequisite> 

// <li> ResidualEquation/ConvolutionEquation 

// <li> LinearModel/LinearEquation Paradigm 

// </prerequisite>

//

// <etymology>

// This class is called ClarkCleanModel because thats the algorithm it uses

// deconvolve the model. 

// </etymology>

//

// <synopsis>

// This class is used to perform the Clark Clean Algorithm on an

// Array. Only the deconvolved model of the sky are directly stored by this

// class. The point spread function (psf) and convolved (dirty) image are

// stored in a companion class which is must be derived from

// ResidualEquation. 

// 

// The cleaning works like this. The user constructs a ClarkCleanModel by

// specifying an initial model of the sky. This can by be

// one,two,three... dimensional depending on the dimension of the psf (see

// below). The user then constructs a class which implements the forward

// equation between the model and the dirty image. Typically this will be

// the ConvolutionEquation class, although any class which has a

// ResidualEquation interface will be work (but perhaps very slowly, as the

// ConvolutionEquation class has member functions optimised for cleaning)

//

// The user then calls the solve() function (with the appropriate equation

// class as an arguement), and this class will perform the Clark clean.

// The various clean parameters are set (prior to calling solve) using the

// functions derived from the Iterate class, in particular setGain(),

// setNumberIterations() & setThreshold() (to set a flux limit). 

// 

// The solve() function does not return either the deconvolved model or the

// residuals. The solved model can be obtained using the getModel() function

// (derived from ArrayModel()) and the residual can be obtained using the

// residual() member function of the Convolution/Residual Equation Class.

//