A class interfacing images to MatrixNACleaner. More...

#include <ImageNACleaner.h>

Public Member Functions
	ImageNACleaner ()
	Default. More...

	ImageNACleaner (casacore::ImageInterface< casacore::Float > &psf, casacore::ImageInterface< casacore::Float > &dirty)
	Create a cleaner with a psf and dirty image. More...

	ImageNACleaner (const ImageNACleaner &other)
	assignmemnt constructor More...

ImageNACleaner &	operator= (const ImageNACleaner &other)
	assignment operator More...

	~ImageNACleaner ()
	The destructor. More...

void	setDirty (casacore::ImageInterface< casacore::Float > &dirty)
	Update the dirty image only. More...

void	setPsf (casacore::ImageInterface< casacore::Float > &psf)
	Change the psf image. More...

void	setcontrol (const casacore::Int niter, const casacore::Float gain, const casacore::Quantity &aThreshold, const casacore::Int masksupp=3, const casacore::Int memtype=2, const casacore::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 More...

casacore::Int	iteration () const
	return how many iterations we did do More...

void	startingIteration (const casacore::Int starting=0)
	what iteration number to start on More...

casacore::Int	clean (casacore::ImageInterface< casacore::Float > &model, const casacore::Int niter, const casacore::Float gain, const casacore::Quantity &threshold, const casacore::Int masksupp=3, const casacore::Int memType=2, const casacore::Float numsigma=5.0)
	Clean an image. More...

void	setMask (casacore::ImageInterface< casacore::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. More...

casacore::Float	maxResidual ()
	Max residual after last clean. More...

Private Member Functions
casacore::Bool	setupMatCleaner (const casacore::Int niter, const casacore::Float gain, const casacore::Quantity &threshold, const casacore::Int supp=3, const casacore::Int memType=2, const casacore::Float numsigma=5.0)
	Helper function to setup some param. More...

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

casacore::AipsError: if psf has more dimensions than the model.

Definition at line 84 of file ImageNACleaner.h.

Constructor & Destructor Documentation

casa::ImageNACleaner::ImageNACleaner ( )

Default.

casa::ImageNACleaner::ImageNACleaner	(	casacore::ImageInterface< casacore::Float > &	psf,
		casacore::ImageInterface< casacore::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

casacore::Int casa::ImageNACleaner::clean	(	casacore::ImageInterface< casacore::Float > &	model,
		const casacore::Int	niter,
		const casacore::Float	gain,
		const casacore::Quantity &	threshold,
		const casacore::Int	masksupp = `3`,
		const casacore::Int	memType = `2`,
		const casacore::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

casacore::Int casa::ImageNACleaner::iteration ( ) const

return how many iterations we did do

casacore::Float casa::ImageNACleaner::maxResidual ( )

inline

Max residual after last clean.

Definition at line 144 of file ImageNACleaner.h.

References maxResidual_p.

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

assignment operator

void casa::ImageNACleaner::setcontrol	(	const casacore::Int	niter,
		const casacore::Float	gain,
		const casacore::Quantity &	aThreshold,
		const casacore::Int	masksupp = `3`,
		const casacore::Int	memtype = `2`,
		const casacore::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 ( casacore::ImageInterface< casacore::Float > & dirty )

Update the dirty image only.

void casa::ImageNACleaner::setMask ( casacore::ImageInterface< casacore::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 ( casacore::ImageInterface< casacore::Float > & psf )

Change the psf image.

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

private

Helper function to setup some param.

void casa::ImageNACleaner::startingIteration ( const casacore::Int starting = 0 )

what iteration number to start on

Member Data Documentation

casacore::Int casa::ImageNACleaner::chanAxis_p

private

Definition at line 158 of file ImageNACleaner.h.

casacore::CountedPtr<casacore::ImageInterface<casacore::Float> > casa::ImageNACleaner::dirty_p

private

Definition at line 152 of file ImageNACleaner.h.

casacore::CountedPtr<casacore::ImageInterface<casacore::Float> > casa::ImageNACleaner::mask_p

private

Definition at line 153 of file ImageNACleaner.h.

MatrixNACleaner casa::ImageNACleaner::matClean_p

private

Definition at line 150 of file ImageNACleaner.h.

casacore::Float casa::ImageNACleaner::maxResidual_p

private

Definition at line 162 of file ImageNACleaner.h.

Referenced by maxResidual().

casacore::Int casa::ImageNACleaner::nImChan_p

private

Definition at line 155 of file ImageNACleaner.h.

casacore::Int casa::ImageNACleaner::nImPol_p

private

Definition at line 157 of file ImageNACleaner.h.

casacore::Int casa::ImageNACleaner::nMaskChan_p

private

Definition at line 160 of file ImageNACleaner.h.

casacore::Int casa::ImageNACleaner::nMaskPol_p

private

Definition at line 161 of file ImageNACleaner.h.

casacore::Int casa::ImageNACleaner::nPsfChan_p

private

Definition at line 154 of file ImageNACleaner.h.

casacore::Int casa::ImageNACleaner::nPsfPol_p

private

Definition at line 156 of file ImageNACleaner.h.

casacore::Int casa::ImageNACleaner::polAxis_p

private

Definition at line 159 of file ImageNACleaner.h.

casacore::CountedPtr<casacore::ImageInterface<casacore::Float> > casa::ImageNACleaner::psf_p

private

Definition at line 151 of file ImageNACleaner.h.

The documentation for this class was generated from the following file:

casa/code/synthesis/MeasurementEquations/ImageNACleaner.h

Private Attributes
MatrixNACleaner	matClean_p

casacore::CountedPtr < casacore::ImageInterface < casacore::Float > >	psf_p

casacore::CountedPtr < casacore::ImageInterface < casacore::Float > >	dirty_p

casacore::CountedPtr < casacore::ImageInterface < casacore::Float > >	mask_p

casacore::Int	nPsfChan_p

casacore::Int	nImChan_p

casacore::Int	nPsfPol_p

casacore::Int	nImPol_p

casacore::Int	chanAxis_p

casacore::Int	polAxis_p

casacore::Int	nMaskChan_p

casacore::Int	nMaskPol_p

casacore::Float	maxResidual_p

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation