casa::MultiTermMatrixCleaner Class Reference

#include <MultiTermMatrixCleaner.h>

Inheritance diagram for casa::MultiTermMatrixCleaner:

Public Member Functions
	MultiTermMatrixCleaner ()
	Create a cleaner.
	~MultiTermMatrixCleaner ()
	The copy constructor uses reference semantics MultiTermMatrixCleaner(const MultiTermMatrixCleaner & other);.
Bool	setntaylorterms (const int &nterms)
	Input : number of Taylor terms Reshapes PtrBlocks to hold the correct number of PSFs and Residual images.
Bool	setscales (const Vector< Float > &scales)
	Input : scales.
Bool	initialise (Int nx, Int ny)
	Initialize all the memory being used.
Int	computeHessianPeak ()
	Calculate Hessian elements and check for invertibility Does not have to be called externally, but can be.
Bool	setpsf (int order, Matrix< Float > &psf)
	Input : psfs and dirty images.
Bool	setresidual (int order, Matrix< Float > &dirty)
	Input : psfs and dirty images.
Bool	setmodel (int order, Matrix< Float > &model)
	Input : model images.
Bool	setmask (Matrix< Float > &mask)
	Input : mask.
Int	mtclean (Int maxniter, Float stopfraction, Float inputgain, Float userthreshold)
	Run the minor cycle.
Bool	getmodel (int order, Matrix< Float > &model)
	Output : Model images.
Bool	getresidual (int order, Matrix< Float > &residual)
	Output : psfs and dirty images.
Bool	computeprincipalsolution ()
	Compute principal solution - in-place on the residual images in vecDirty.
Bool	getinvhessian (Matrix< Double > &invhessian)
	Output : Hessian matrix.
Float	getpeakresidual ()
	Output : Peak residual computed from matR_p (residual convolved with PSF).
Private Member Functions
Int	verifyScaleSizes ()
	Initial setup functions.
Int	allocateMemory ()
Int	setupScaleFunctions ()
Int	setupUserMask ()
	Setup per major cycle.
Int	computeFluxLimit (Float &fluxlimit, Float threshold)
Int	computeRHS ()
Int	solveMatrixEqn (Int ntaylor, Int scale, IPosition blc, IPosition trc)
	Solver functions : minor-cycle iterations.
Int	chooseComponent (Int ntaylor, Int scale, Int criterion, IPosition blc, IPosition trc)
Int	updateModelAndRHS (Float loopgain)
Int	updateRHS (Int ntaylor, Int scale, Float loopgain, Vector< Float > coeffs, IPosition blc, IPosition trc, IPosition blcPsf, IPosition trcPsf)
Int	checkConvergence (Int updatetype, Float &fluxlimit, Float &loopgain)
Bool	buildImagePatches ()
Int	writeMatrixToDisk (String imagename, Matrix< Float > &themat)
	Helper functions.
Int	IND2 (Int taylor, Int scale)
Int	IND4 (Int taylor1, Int taylor2, Int scale1, Int scale2)
Private Attributes
LogIO	os
Int	ntaylor_p
	using MatrixCleaner::makeScaleMasks;
Int	psfntaylor_p
Int	nscales_p
Int	nx_p
Int	ny_p
Int	totalIters_p
Float	globalmaxval_p
Int	maxscaleindex_p
IPosition	globalmaxpos_p
Int	itercount_p
Int	maxniter_p
Float	stopfraction_p
Float	inputgain_p
Float	userthreshold_p
Float	prev_max_p
Float	min_max_p
Float	rmaxval_p
IPosition	psfsupport_p
IPosition	psfpeak_p
IPosition	blc_p
IPosition	trc_p
IPosition	blcPsf_p
IPosition	trcPsf_p
Vector< Float >	scaleSizes_p
Vector< Float >	scaleBias_p
Vector< Float >	totalScaleFlux_p
Vector< Float >	totalTaylorFlux_p
Vector< Float >	maxScaleVal_p
Vector< IPosition >	maxScalePos_p
IPosition	gip
Int	nx
Int	ny
Bool	donePSF_p
Bool	donePSP_p
Bool	doneCONV_p
Matrix< Complex >	dirtyFT_p
Block< Matrix< Float > >	vecScaleMasks_p
Matrix< Complex >	cWork_p
Block< Matrix< Float > >	vecWork_p
Block< Matrix< Float > >	vecScales_p
	h(s) [nx,ny,nscales]
Block< Matrix< Complex > >	vecScalesFT_p
Block< Matrix< Complex > >	vecPsfFT_p
	B_k [nx,ny,ntaylor] Block<Matrix<Float> > vecPsf_p;.
Block< Matrix< Float > >	vecDirty_p
	I_D : Residual/Dirty Images [nx,ny,ntaylor].
Block< Matrix< Float > >	vecModel_p
	I_M : Model Images [nx,ny,ntaylor].
Block< Matrix< Float > >	cubeA_p
	Block <Matrix<Float> > vecScaleModel_p;.
Block< Matrix< Float > >	matR_p
	R_{sk} = I_D * B_{sk} [nx,ny,ntaylor,nscales].
Block< Matrix< Float > >	matCoeffs_p
	a_{sk} = Solution vectors.
Double	memoryMB_p
	Memory to be allocated per Matrix.
Block< Matrix< Double > >	matA_p
	Solve [A][Coeffs] = [I_D * B] Shape of A : [ntaylor,ntaylor].
Block< Matrix< Double > >	invMatA_p
FFTServer< Float, Complex >	fftcomplex
	FFTserver.
Bool	adbg

Detailed Description

Definition at line 36 of file MultiTermMatrixCleaner.h.

Constructor & Destructor Documentation

casa::MultiTermMatrixCleaner::MultiTermMatrixCleaner ( )

Create a cleaner.

casa::MultiTermMatrixCleaner::~MultiTermMatrixCleaner ( )

The copy constructor uses reference semantics MultiTermMatrixCleaner(const MultiTermMatrixCleaner & other);.

The assignment operator also uses reference semantics MultiTermMatrixCleaner & operator=(const MultiTermMatrixCleaner & other);

The destructor resizes arrays to empty before destruction.

Member Function Documentation

Int casa::MultiTermMatrixCleaner::allocateMemory ( ) [private]

Bool casa::MultiTermMatrixCleaner::buildImagePatches ( ) [private]

Int casa::MultiTermMatrixCleaner::checkConvergence	(	Int	updatetype,
		Float &	fluxlimit,
		Float &	loopgain
	)			`[private]`

Int casa::MultiTermMatrixCleaner::chooseComponent	(	Int	ntaylor,
		Int	scale,
		Int	criterion,
		IPosition	blc,
		IPosition	trc
	)			`[private]`

Int casa::MultiTermMatrixCleaner::computeFluxLimit	(	Float &	fluxlimit,
		Float	threshold
	)			`[private]`

Int casa::MultiTermMatrixCleaner::computeHessianPeak ( )

Calculate Hessian elements and check for invertibility Does not have to be called externally, but can be.

Either way, it executes only once.

Bool casa::MultiTermMatrixCleaner::computeprincipalsolution ( )

Compute principal solution - in-place on the residual images in vecDirty.

Int casa::MultiTermMatrixCleaner::computeRHS ( ) [private]

Bool casa::MultiTermMatrixCleaner::getinvhessian ( Matrix< Double > & invhessian )

Output : Hessian matrix.

Bool casa::MultiTermMatrixCleaner::getmodel	(	int	order,
		Matrix< Float > &	model
	)

Output : Model images.

Float casa::MultiTermMatrixCleaner::getpeakresidual ( ) [inline]

Output : Peak residual computed from matR_p (residual convolved with PSF).

Definition at line 93 of file MultiTermMatrixCleaner.h.

References rmaxval_p.

Bool casa::MultiTermMatrixCleaner::getresidual	(	int	order,
		Matrix< Float > &	residual
	)

Output : psfs and dirty images.

Int casa::MultiTermMatrixCleaner::IND2	(	Int	taylor,
		Int	scale
	)			`[private]`

Int casa::MultiTermMatrixCleaner::IND4	(	Int	taylor1,
		Int	taylor2,
		Int	scale1,
		Int	scale2
	)			`[private]`

Bool casa::MultiTermMatrixCleaner::initialise	(	Int	nx,
		Int	ny
	)

Initialize all the memory being used.

Int casa::MultiTermMatrixCleaner::mtclean	(	Int	maxniter,
		Float	stopfraction,
		Float	inputgain,
		Float	userthreshold
	)

Run the minor cycle.

Bool casa::MultiTermMatrixCleaner::setmask ( Matrix< Float > & mask )

Input : mask.

Bool casa::MultiTermMatrixCleaner::setmodel	(	int	order,
		Matrix< Float > &	model
	)

Input : model images.

Bool casa::MultiTermMatrixCleaner::setntaylorterms ( const int & nterms )

Input : number of Taylor terms Reshapes PtrBlocks to hold the correct number of PSFs and Residual images.

Bool casa::MultiTermMatrixCleaner::setpsf	(	int	order,
		Matrix< Float > &	psf
	)

Input : psfs and dirty images.

Bool casa::MultiTermMatrixCleaner::setresidual	(	int	order,
		Matrix< Float > &	dirty
	)

Input : psfs and dirty images.

Bool casa::MultiTermMatrixCleaner::setscales ( const Vector< Float > & scales )

Input : scales.

Reimplemented from casa::MatrixCleaner.

Int casa::MultiTermMatrixCleaner::setupScaleFunctions ( ) [private]

Int casa::MultiTermMatrixCleaner::setupUserMask ( ) [private]

Setup per major cycle.

Int casa::MultiTermMatrixCleaner::solveMatrixEqn	(	Int	ntaylor,
		Int	scale,
		IPosition	blc,
		IPosition	trc
	)			`[private]`

Solver functions : minor-cycle iterations.

Need to be efficient.

Int casa::MultiTermMatrixCleaner::updateModelAndRHS ( Float loopgain ) [private]

Int casa::MultiTermMatrixCleaner::updateRHS	(	Int	ntaylor,
		Int	scale,
		Float	loopgain,
		Vector< Float >	coeffs,
		IPosition	blc,
		IPosition	trc,
		IPosition	blcPsf,
		IPosition	trcPsf
	)			`[private]`