Abstract base class to monitor progress in lattice operations. More...

#include <LatticeCleanProgress.h>

Public Member Functions
	LatticeCleanProgress (PGPlotter *pgplotter=0)
virtual	~LatticeCleanProgress ()
Bool	info (const Bool lastcall, const Int iteration, const Int numberIterations, const Vector< Float > &maxima, const Block< IPosition > &posMaximum, const Float strengthOptimum, const Int optimumScale, const IPosition &positionOptimum, const Float &totalFlux, const Vector< Float > &totalFluxScale, const Bool resetBase=False)
	Print and plot the information.
Private Member Functions
void	initialize (const uInt nScales, const Float &maxResidual, const uInt numIterations)
	initizalize the arrays and such
void	resizeDataStorage ()
	As the iterations trickle in, we will from time to time need to make the Matrices larger.
void	basicSetUp (Bool plotMatrices=False)
	this will redraw the plot with a new scale; if plotMatrices = False, just draw the boxes, else, replot all past data.
void	plotOne (const Int iteration, const Vector< Float > &resid, const Vector< Float > &flux)
	Note: you MUST call basicSetUp before calling this.
Private Attributes
PGPlotter *	itsPgplotter
Vector< Float >	iterationNumber
Matrix< Float >	maxResiduals
Matrix< Float >	posResiduals
Matrix< Float >	negResiduals
Matrix< Float >	totalFluxesPer
Vector< Float >	totalFluxes
uInt	currentIndex
uInt	currentTotalIterations
Float	currentFluxScale
Float	currentMinFluxScale
Float	currentMaxResidual
Float	currentMinResidual
Float	logMinRes
Float	logMaxRes
Float	deltaY
Float	xMin
Float	xMax
Float	fluxScaleJump
Float	residScaleJump
Float	forbidden
Vector< Float >	baseFluxes

Detailed Description

Abstract base class to monitor progress in lattice operations.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Synopsis

This is an abstract base class for classes to monitor the progress of an operation on a Lattice. The default implementation offered by this class does nothing. However, a derived class could show the progress using for example a ProgressMeter . A derived class should override the virtual functions from this class.

The user of the LatticeCleanProgress object should first call function init with the total number of steps that are to be done. Thereafter, after each step has been executed, function nstepsDone should be called after each step. Finally, function done should be called.

Example

Motivation

Since operations on Lattices can take a while, it can be useful to show the progress. However, making module Lattices dependent on the class ProgressMeter sounded bad. This abstract class serves as a bridge between the Lattice module and the ProgressMeter class (or any other class showing the progress).

Definition at line 91 of file LatticeCleanProgress.h.

Constructor & Destructor Documentation

casa::LatticeCleanProgress::LatticeCleanProgress ( PGPlotter * pgplotter = 0 )

virtual casa::LatticeCleanProgress::~LatticeCleanProgress ( ) [virtual]

Member Function Documentation

void casa::LatticeCleanProgress::basicSetUp ( Bool plotMatrices = False ) [private]

this will redraw the plot with a new scale; if plotMatrices = False, just draw the boxes, else, replot all past data.

Bool casa::LatticeCleanProgress::info	(	const Bool	lastcall,
		const Int	iteration,
		const Int	numberIterations,
		const Vector< Float > &	maxima,
		const Block< IPosition > &	posMaximum,
		const Float	strengthOptimum,
		const Int	optimumScale,
		const IPosition &	positionOptimum,
		const Float &	totalFlux,
		const Vector< Float > &	totalFluxScale,
		const Bool	resetBase = `False`
	)