casa6

//# AspMatrixCleaner.h: Minor Cycle for Asp deconvolution

//# Copyright (C) 1996,1997,1998,1999,2000,2001,2002,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: AspMatrixCleaner.h Genie H. 2020-04-06 <mhsieh@nrao.edu $

​

#ifndef SYNTHESIS_ASPMATRIXCLEANER_H

#define SYNTHESIS_ASPMATRIXCLEANER_H

​

//# Includes

#include <scimath/Mathematics/FFTServer.h>

#include <synthesis/MeasurementEquations/MatrixCleaner.h>

#include <deque>

#include <coordinates/Coordinates/CoordinateSystem.h>

#include <coordinates/Coordinates/SpectralCoordinate.h>

​

namespace casa { //# NAMESPACE CASA - BEGIN

​

class AspMatrixCleaner : public MatrixCleaner

{

public:

  // Create a cleaner : default constructor

  AspMatrixCleaner();

​

  // The destructor does nothing special.

  ~AspMatrixCleaner();

​

  casacore::Bool setaspcontrol(const casacore::Int niter,

      const casacore::Float gain, const casacore::Quantity& aThreshold,

      const casacore::Quantity& fThreshold);

​

​

  // Clean an image.

  //return value gives you a hint of what's happening

  //  1 = converged

  //  0 = not converged but behaving normally

  // -1 = not converged and stopped on cleaning consecutive smallest scale

  // -2 = not converged and either large scale hit negative or diverging

  // -3 = clean is diverging rather than converging

  casacore::Int aspclean(casacore::Matrix<casacore::Float> & model, casacore::Bool doPlotProgress=false);

​