Loading...
Searching...
No Matches
LatticeCleanProgress.h
Go to the documentation of this file.
//# LatticeCleanProgress.h: Abstract base class to monitor progress in lattice operations
//# Copyright (C) 1997,1998,1999,2000
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef LATTICES_LATTICECLEANPROGRESS_H
#define LATTICES_LATTICECLEANPROGRESS_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Quanta/Quantum.h>
#include <casacore/lattices/Lattices/Lattice.h>
#include <casacore/lattices/Lattices/TempLattice.h>
#include <casacore/casa/Arrays/IPosition.h>
#include <casacore/casa/Containers/Block.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/Arrays/Matrix.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class PGPlotter;
// <summary>
// Abstract base class to monitor progress in lattice operations
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <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 <linkto class=ProgressMeter>ProgressMeter</linkto>. A derived
// class should override the virtual functions from this class.
//
// The user of the LatticeCleanProgress object should first call
// function <src>init</src> with the total number of steps
// that are to be done. Thereafter, after each step has been
// executed, function <src>nstepsDone</src> should be called
// after each step. Finally, function <src>done</src> should
// be called.
// </synopsis>
// <example>
// <srcblock>
// </srcblock>
// </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).
// </motivation>
//
//# <todo asof="1997/08/01">
//# <li>
//# </todo>
class LatticeCleanProgress {
public:
LatticeCleanProgress(PGPlotter* pgplotter=0);
virtual ~LatticeCleanProgress();
// Print and plot the information.
// Currently, not all information is utilized.
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);
protected:
private:
// initizalize the arrays and such
void initialize(const uInt nScales,
const Float& maxResidual,
const uInt numIterations);
// As the iterations trickle in, we will from time to time
// need to make the Matrices larger. Increase to 2*n+1
void resizeDataStorage();
// this will redraw the plot with a new scale;
// if plotMatrices = False, just draw the boxes,
// else, replot all past data.
//
void basicSetUp(Bool plotMatrices = False);
// Note: you MUST call basicSetUp before calling this.
void plotOne(const Int iteration,
const Vector<Float>& resid, const Vector<Float>& flux);
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;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::Block
Definition Block.h:140
casacore::IPosition
Definition IPosition.h:117
casacore::LatticeCleanProgress::xMin
Float xMin
Definition LatticeCleanProgress.h:149
casacore::LatticeCleanProgress::resizeDataStorage
void resizeDataStorage()
As the iterations trickle in, we will from time to time need to make the Matrices larger.
casacore::LatticeCleanProgress::info
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.
casacore::LatticeCleanProgress::totalFluxesPer
Matrix< Float > totalFluxesPer
Definition LatticeCleanProgress.h:137
casacore::LatticeCleanProgress::maxResiduals
Matrix< Float > maxResiduals
Definition LatticeCleanProgress.h:134
casacore::LatticeCleanProgress::plotOne
void plotOne(const Int iteration, const Vector< Float > &resid, const Vector< Float > &flux)
Note: you MUST call basicSetUp before calling this.
casacore::LatticeCleanProgress::currentTotalIterations
uInt currentTotalIterations
Definition LatticeCleanProgress.h:140
casacore::LatticeCleanProgress::itsPgplotter
PGPlotter * itsPgplotter
Definition LatticeCleanProgress.h:131
casacore::LatticeCleanProgress::deltaY
Float deltaY
Definition LatticeCleanProgress.h:148
casacore::LatticeCleanProgress::posResiduals
Matrix< Float > posResiduals
Definition LatticeCleanProgress.h:135
casacore::LatticeCleanProgress::currentMaxResidual
Float currentMaxResidual
Definition LatticeCleanProgress.h:143
casacore::LatticeCleanProgress::fluxScaleJump
Float fluxScaleJump
Definition LatticeCleanProgress.h:152
casacore::LatticeCleanProgress::forbidden
Float forbidden
Definition LatticeCleanProgress.h:155
casacore::LatticeCleanProgress::logMinRes
Float logMinRes
Definition LatticeCleanProgress.h:146
casacore::LatticeCleanProgress::xMax
Float xMax
Definition LatticeCleanProgress.h:150
casacore::LatticeCleanProgress::currentMinFluxScale
Float currentMinFluxScale
Definition LatticeCleanProgress.h:142
casacore::LatticeCleanProgress::totalFluxes
Vector< Float > totalFluxes
Definition LatticeCleanProgress.h:138
casacore::LatticeCleanProgress::currentFluxScale
Float currentFluxScale
Definition LatticeCleanProgress.h:141
casacore::LatticeCleanProgress::currentMinResidual
Float currentMinResidual
Definition LatticeCleanProgress.h:144
casacore::LatticeCleanProgress::residScaleJump
Float residScaleJump
Definition LatticeCleanProgress.h:153
casacore::LatticeCleanProgress::LatticeCleanProgress
LatticeCleanProgress(PGPlotter *pgplotter=0)
casacore::LatticeCleanProgress::negResiduals
Matrix< Float > negResiduals
Definition LatticeCleanProgress.h:136
casacore::LatticeCleanProgress::iterationNumber
Vector< Float > iterationNumber
Definition LatticeCleanProgress.h:133
casacore::LatticeCleanProgress::~LatticeCleanProgress
virtual ~LatticeCleanProgress()
casacore::LatticeCleanProgress::basicSetUp
void basicSetUp(Bool plotMatrices=False)
this will redraw the plot with a new scale; if plotMatrices = False, just draw the boxes,...
casacore::LatticeCleanProgress::currentIndex
uInt currentIndex
Definition LatticeCleanProgress.h:139
casacore::LatticeCleanProgress::baseFluxes
Vector< Float > baseFluxes
Definition LatticeCleanProgress.h:157
casacore::LatticeCleanProgress::logMaxRes
Float logMaxRes
Definition LatticeCleanProgress.h:147
casacore::LatticeCleanProgress::initialize
void initialize(const uInt nScales, const Float &maxResidual, const uInt numIterations)
initizalize the arrays and such
casacore::Matrix
Definition Matrix.h:87
casacore::PGPlotter
Definition PGPlotter.h:93
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::False
const Bool False
Definition aipstype.h:42
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Float
float Float
Definition aipstype.h:52
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40