casa::ImageNACleaner Class Reference

A class interfacing images to MatrixNACleaner. More...

#include <ImageNACleaner.h>

Public Member Functions
	ImageNACleaner ()
	Default.
	ImageNACleaner (ImageInterface< Float > &psf, ImageInterface< Float > &dirty)
	Create a cleaner with a psf and dirty image.
	ImageNACleaner (const ImageNACleaner &other)
	assignmemnt constructor
ImageNACleaner &	operator= (const ImageNACleaner &other)
	assignment operator
	~ImageNACleaner ()
	The destructor.
void	setDirty (ImageInterface< Float > &dirty)
	Update the dirty image only.
void	setPsf (ImageInterface< Float > &psf)
	Change the psf image.
void	setcontrol (const Int niter, const Float gain, const Quantity &aThreshold, const Int masksupp=3, const Int memtype=2, const Float numSigma=5.0)
	niter - number of iterations gain - loop gain used in cleaning (a fraction of the maximum subtracted at every iteration) aThreshold - absolute threshold to stop iterations masksupport is +-number of pixel around a peak to remember memtype is memory function to use 0- no memory standard clean, 1 weak memory, 2 medium, 3 strong numsigma: keep memory of position if peak is above this value
Int	iteration () const
	return how many iterations we did do
void	startingIteration (const Int starting=0)
	what iteration number to start on
Int	clean (ImageInterface< Float > &model, const Int niter, const Float gain, const Quantity &threshold, const Int masksupp=3, const Int memType=2, const Float numsigma=5.0)
	Clean an image.
void	setMask (ImageInterface< Float > &mask)
	Set the mask mask - input mask lattice This is where the algorithm searched...the value of the mask shows the weight importance code is exactly the same as before this parameter has been introduced.
Float	maxResidual ()
	Max residual after last clean.
Private Member Functions
Bool	setupMatCleaner (const Int niter, const Float gain, const Quantity &threshold, const Int supp=3, const Int memType=2, const Float numsigma=5.0)
	Helper function to setup some param.
Private Attributes
MatrixNACleaner	matClean_p
CountedPtr< ImageInterface < Float > >	psf_p
CountedPtr< ImageInterface < Float > >	dirty_p
CountedPtr< ImageInterface < Float > >	mask_p
Int	nPsfChan_p
Int	nImChan_p
Int	nPsfPol_p
Int	nImPol_p
Int	chanAxis_p
Int	polAxis_p
Int	nMaskChan_p
Int	nMaskPol_p
Float	maxResidual_p

Detailed Description

A class interfacing images to MatrixNACleaner.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd
Test programs:: tLatticeCleaner

Prerequisite

ImageInterface
MatrixNACleaner

Etymology

The ImageCleaner class will use Non Amnesiac on Images.

Synopsis

This class will perform some kind of Clean deconvolution on Lattices.

Example

Motivation

Thrown Exceptions

AipsError: if psf has more dimensions than the model.

Definition at line 80 of file ImageNACleaner.h.

Constructor & Destructor Documentation

casa::ImageNACleaner::ImageNACleaner ( )

Default.

casa::ImageNACleaner::ImageNACleaner	(	ImageInterface< Float > &	psf,
		ImageInterface< Float > &	dirty
	)

Create a cleaner with a psf and dirty image.

casa::ImageNACleaner::ImageNACleaner ( const ImageNACleaner & other )

assignmemnt constructor

casa::ImageNACleaner::~ImageNACleaner ( )

The destructor.

Member Function Documentation

Int casa::ImageNACleaner::clean	(	ImageInterface< Float > &	model,
		const Int	niter,
		const Float	gain,
		const Quantity &	threshold,
		const Int	masksupp = `3`,
		const Int	memType = `2`,
		const Float	numsigma = `5.0`
	)

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

Int casa::ImageNACleaner::iteration ( ) const

return how many iterations we did do

Float casa::ImageNACleaner::maxResidual ( ) [inline]

Max residual after last clean.

Definition at line 140 of file ImageNACleaner.h.

References maxResidual_p.

ImageNACleaner& casa::ImageNACleaner::operator= ( const ImageNACleaner & other )

assignment operator

void casa::ImageNACleaner::setcontrol	(	const Int	niter,
		const Float	gain,
		const Quantity &	aThreshold,
		const Int	masksupp = `3`,
		const Int	memtype = `2`,
		const Float	numSigma = `5.0`
	)

niter - number of iterations gain - loop gain used in cleaning (a fraction of the maximum subtracted at every iteration) aThreshold - absolute threshold to stop iterations masksupport is +-number of pixel around a peak to remember memtype is memory function to use 0- no memory standard clean, 1 weak memory, 2 medium, 3 strong numsigma: keep memory of position if peak is above this value

void casa::ImageNACleaner::setDirty ( ImageInterface< Float > & dirty )

Update the dirty image only.

void casa::ImageNACleaner::setMask ( ImageInterface< Float > & mask )

Set the mask mask - input mask lattice This is where the algorithm searched...the value of the mask shows the weight importance code is exactly the same as before this parameter has been introduced.

void casa::ImageNACleaner::setPsf ( ImageInterface< Float > & psf )

Change the psf image.

Bool casa::ImageNACleaner::setupMatCleaner	(	const Int	niter,
		const Float	gain,
		const Quantity &	threshold,
		const Int	supp = `3`,
		const Int	memType = `2`,
		const Float	numsigma = `5.0`
	)			`[private]`