casa::MatrixNACleaner Class Reference

A simple deconvolver that masks by memory of previous peaks. More...

#include <MatrixNACleaner.h>

Public Member Functions
	MatrixNACleaner ()
	Create a cleaner : default constructor.
	MatrixNACleaner (const Matrix< Float > &psf, const Matrix< Float > &dirty, const Int memtype=2, const Float numSigma=5.0)
	Create a cleaner for a specific dirty image and PSF.
	MatrixNACleaner (const MatrixNACleaner &other)
	The copy constructor uses reference semantics.
MatrixNACleaner &	operator= (const MatrixNACleaner &other)
	The assignment operator also uses reference semantics.
	~MatrixNACleaner ()
	The destructor does nothing special.
void	setDirty (const Matrix< Float > &dirty)
	Set the dirty image without calculating convolutions.
void	setPsf (const Matrix< Float > &psf)
	change the psf don't forget to redo the setscales or run makePsfScales, followed by makeDirtyScales
void	setcontrol (const Int niter, const Float gain, const Quantity &aThresho, const Int masksupport=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
Int	iteration () const
	return how many iterations we did do
Float	totalFlux () const
	Total flux accumulated so far.
Int	clean (Matrix< Float > &model)
	Clean an image.
void	setMask (Matrix< Float > &mask)
	Set the mask mask - input mask lattice.
void	setPixFlag (const Matrix< Bool > &bitpix)
void	unsetMask ()
	remove the mask; useful when keeping object and sending a new dirty image to clean one can set another mask then
void	getMask (Matrix< Float > &mask)
Matrix< Float >	getResidual ()
	Look at what WE think the residuals look like.
Float	threshold () const
	Method to return threshold.
Float	maxResidual ()
Protected Member Functions
Bool	validatePsf (const Matrix< Float > &psf)
	Helper function to optimize adding static void addTo(Matrix<Float>& to, const Matrix<Float> & add);.
Bool	findMaxAbsMask (const Matrix< Float > &lattice, Matrix< Float > &mask, Float &maxAbs, IPosition &posMax, const Int support=5)
	Find the Peak of the lattice, applying a mask.
Static Protected Member Functions
static void	makeBoxesSameSize (IPosition &blc1, IPosition &trc1, IPosition &blc2, IPosition &trc2)
	Helper function to reduce the box sizes until the have the same size keeping the centers intact.
Protected Attributes
Float	itsGain
Int	itsMaxNiter
Quantum< Double >	itsThreshold
Private Member Functions
Float	amnesiac (const Float &val)
Float	weak (const Float &v)
Float	medium (const Float &v)
Float	strong (const Float &v)
Private Attributes
std::shared_ptr< Matrix< Float > >	itsMask
std::shared_ptr< Matrix< Float > >	itsDirty
std::shared_ptr< Matrix< Float > >	itsPsf
std::shared_ptr< Matrix< Float > >	itsResidual
std::shared_ptr< Matrix< Bool > >	itsBitPix
Float	itsMaximumResidual
Int	itsIteration
Int	itsStartingIter
Float	itsTotalFlux
Int	itsSupport
IPosition	psfShape_p
IPosition	itsPositionPeakPsf
Float	itsRms
Int	typeOfMemory_p
Float	numSigma_p
std::function< Float(const Float &)>	f_p

Detailed Description

A simple deconvolver that masks by memory of previous peaks.

Synopsis

Evolution of a simple cleaner

A class for doing multi-dimensional cleaning

Intended use:

Public interface

Review Status

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

Prerequisite

The mathematical concept of deconvolution

Etymology

The MatrixNACleaner Uses the matrix class and cleaner is for deconvolver by CLEAN NA stands for Non Amnesiac...i.e remember where past peaks were to search in these region preferentially ...i.e no need to mask

Synopsis

This class will perform various types of Clean deconvolution on Lattices.

Example

Motivation

Thrown Exceptions

AipsError: if psf has more dimensions than the model.

Definition at line 88 of file MatrixNACleaner.h.

Constructor & Destructor Documentation

casa::MatrixNACleaner::MatrixNACleaner ( )

Create a cleaner : default constructor.

casa::MatrixNACleaner::MatrixNACleaner	(	const Matrix< Float > &	psf,
		const Matrix< Float > &	dirty,
		const Int	memtype = `2`,
		const Float	numSigma = `5.0`
	)

Create a cleaner for a specific dirty image and PSF.

casa::MatrixNACleaner::MatrixNACleaner ( const MatrixNACleaner & other )

The copy constructor uses reference semantics.

casa::MatrixNACleaner::~MatrixNACleaner ( )

The destructor does nothing special.

Member Function Documentation

Float casa::MatrixNACleaner::amnesiac ( const Float & val ) [private]

Int casa::MatrixNACleaner::clean ( Matrix< Float > & model )

Clean an image.

Bool casa::MatrixNACleaner::findMaxAbsMask	(	const Matrix< Float > &	lattice,
		Matrix< Float > &	mask,
		Float &	maxAbs,
		IPosition &	posMax,
		const Int	support = `5`
	)			`[protected]`

Find the Peak of the lattice, applying a mask.

void casa::MatrixNACleaner::getMask ( Matrix< Float > & mask )

Matrix<Float> casa::MatrixNACleaner::getResidual ( ) [inline]

Look at what WE think the residuals look like.

Definition at line 164 of file MatrixNACleaner.h.

References itsResidual.

Int casa::MatrixNACleaner::iteration ( ) const [inline]

return how many iterations we did do

Definition at line 134 of file MatrixNACleaner.h.

References itsIteration.

static void casa::MatrixNACleaner::makeBoxesSameSize	(	IPosition &	blc1,
		IPosition &	trc1,
		IPosition &	blc2,
		IPosition &	trc2
	)			`[static, protected]`

Helper function to reduce the box sizes until the have the same size keeping the centers intact.

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

Definition at line 170 of file MatrixNACleaner.h.

References itsMaximumResidual.

Float casa::MatrixNACleaner::medium ( const Float & v ) [private]

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

The assignment operator also uses reference semantics.

void casa::MatrixNACleaner::setcontrol	(	const Int	niter,
		const Float	gain,
		const Quantity &	aThresho,
		const Int	masksupport = `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

void casa::MatrixNACleaner::setDirty ( const Matrix< Float > & dirty )

Set the dirty image without calculating convolutions.

\. can be done by calling makeDirtyScales or setscales if one want to redo the psfscales too.

void casa::MatrixNACleaner::setMask ( Matrix< Float > & mask )

Set the mask mask - input mask lattice.

void casa::MatrixNACleaner::setPixFlag ( const Matrix< Bool > & bitpix )