casa::Iterate Class Reference

Base class for Iteration. More...

#include <Iterate.h>

Inheritance diagram for casa::Iterate:

Public Member Functions
	Iterate ()
	Constructor. More...
virtual	~Iterate ()
void	setFree ()
	Is this a free variable? More...
void	setNotFree ()
casacore::Bool	free ()
void	setNumberIterations (const casacore::Int n)
void	setGain (const casacore::Float g)
void	setTolerance (const casacore::Float t)
void	setThreshold (const casacore::Float t)
void	setMode (const casacore::String m)
casacore::Int	numberIterations ()
casacore::Float	gain ()
casacore::Float	tolerance ()
virtual casacore::Float	threshold ()
const casacore::String	mode ()

Private Attributes
casacore::Int	numberIterations_
casacore::Double	gain_
casacore::Double	tolerance_
casacore::Double	threshold_
casacore::Bool	free_
casacore::String	mode_

Detailed Description

Base class for Iteration.

Definition at line 40 of file Iterate.h.

Constructor & Destructor Documentation

casa::Iterate::Iterate ( )

inline

Constructor.

Definition at line 43 of file Iterate.h.

virtual casa::Iterate::~Iterate ( )

inlinevirtual

Definition at line 46 of file Iterate.h.

Member Function Documentation

casacore::Bool casa::Iterate::free ( )

inline

Definition at line 53 of file Iterate.h.

References free_.

casacore::Float casa::Iterate::gain ( )

inline

Definition at line 63 of file Iterate.h.

References gain_.

const casacore::String casa::Iterate::mode ( )

inline

Definition at line 66 of file Iterate.h.

casacore::Int casa::Iterate::numberIterations ( )

inline

Definition at line 62 of file Iterate.h.

References numberIterations_.

Referenced by casa::ClarkCleanLatModel::getNumberIterations().

void casa::Iterate::setFree ( )

inline

Is this a free variable?

Definition at line 49 of file Iterate.h.

References free_.

void casa::Iterate::setGain ( const casacore::Float  g )

inline

Definition at line 57 of file Iterate.h.

References gain_.

void casa::Iterate::setMode ( const casacore::String  m )

inline

Definition at line 60 of file Iterate.h.

References mode_.

void casa::Iterate::setNotFree ( )

inline

Definition at line 51 of file Iterate.h.

References free_.

void casa::Iterate::setNumberIterations ( const casacore::Int  n )

inline

Definition at line 56 of file Iterate.h.

References numberIterations_.

void casa::Iterate::setThreshold ( const casacore::Float  t )

inline

Definition at line 59 of file Iterate.h.

References threshold_.

void casa::Iterate::setTolerance ( const casacore::Float  t )

inline

Definition at line 58 of file Iterate.h.

References tolerance_.

virtual casacore::Float casa::Iterate::threshold ( )

inlinevirtual

Reimplemented in casa::ClarkCleanModel.

Definition at line 65 of file Iterate.h.

References threshold_.

casacore::Float casa::Iterate::tolerance ( )

inline

Definition at line 64 of file Iterate.h.

References tolerance_.

Member Data Documentation

casacore::Bool casa::Iterate::free_

private

Definition at line 73 of file Iterate.h.

Referenced by free(), setFree(), and setNotFree().

casacore::Double casa::Iterate::gain_

private

Definition at line 70 of file Iterate.h.

Referenced by gain(), and setGain().

casacore::String casa::Iterate::mode_

private

Definition at line 74 of file Iterate.h.

Referenced by setMode().

casacore::Int casa::Iterate::numberIterations_

private

Definition at line 66 of file Iterate.h.

Referenced by numberIterations(), and setNumberIterations().

casacore::Double casa::Iterate::threshold_

private

Definition at line 72 of file Iterate.h.

Referenced by setThreshold(), and threshold().

casacore::Double casa::Iterate::tolerance_

private

Definition at line 71 of file Iterate.h.

Referenced by setTolerance(), and tolerance().

---

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

• casa/code/synthesis/MeasurementEquations/Iterate.h