casa::SIIterBot_state Class Reference

#include <SIIterBot.h>

Inheritance diagram for casa::SIIterBot_state:

Public Member Functions
	SIIterBot_state (std::shared_ptr< SIIterBot_callback >)
	~SIIterBot_state ()
void	acceptCallbacks (SIIterBot_adaptor *siba)
void	denyCallbacks (SIIterBot_adaptor *siba)
virtual bool	interactiveInputRequired ()
virtual void	waitForInteractiveInput ()
virtual int	cleanComplete (casacore::Bool lastcyclecheck=casacore::False)
	virtual bool majorCycleRequired(casacore::Float currentPeakResidual); More...
virtual casacore::Record	getMinorCycleControls ()
virtual void	mergeCycleInitializationRecord (casacore::Record &)
virtual void	mergeCycleExecutionRecord (casacore::Record &)
void	changeNiter (casacore::Int niter)
	void mergeSubIterBot(SISubIterBot& subIterBot); More...
void	changeCycleNiter (casacore::Int cycleniter)
void	changeInteractiveNiter (casacore::Int interactiveniter)
void	changeThreshold (casacore::Float threshold)
void	changeCycleThreshold (casacore::Float cyclethreshold)
void	changeInteractiveThreshold (casacore::Float cyclethreshold)
void	changeLoopGain (casacore::Float loopgain)
void	changeCycleFactor (casacore::Float cyclefactor)
void	changeMinPsfFraction (casacore::Float minpsffraction)
void	changeMaxPsfFraction (casacore::Float maxpsffraction)
void	changeInteractiveMode (const bool &interactiveEnabled)
void	changePauseFlag (const bool &pauseEnabled)
void	changeStopFlag (const bool &stopEnabled)
void	changeNsigma (casacore::Float nsigma)
void	setControlsFromRecord (casacore::Record &recordIn)
casacore::Float	readThreshold (casacore::Record recordIn, casacore::String id)
virtual casacore::Record	getDetailsRecord ()
void	incrementMajorCycleCount ()
	casacore::Record getSubIterBotRecord(); More...
void	resetMinorCycleInitInfo ()
casacore::Int	getMajorCycleCount ()
void	updateCycleThreshold ()
void	addSummaryMajor ()
	casacore::Int getRemainingNiter(); casacore::Int getCompletedNiter(); More...
void	pushDetails ()
void	pushSummary ()
bool	incrementController ()
bool	decrementController ()
int	getNumberOfControllers ()
std::string	getDescription ()
void	setDescription (const std::string &value)
DBus::Variant	getSummary ()
void	interactionComplete ()
START *virtual casacore::Record	getSummaryRecord ()
	Functions for runtime parameter modification. More...

Protected Member Functions
virtual void	mergeMinorCycleSummary (const casacore::Array< casacore::Double > &summary)
void	printOut (casacore::String prefix, casacore::Bool verbose)

Protected Attributes
std::string	itsDescription
casacore::Float	itsMinPsfFraction
casacore::Float	itsMaxPsfFraction
casacore::Float	itsMaxPsfSidelobe
casacore::Float	itsPeakResidual
casacore::Float	itsPrevPeakResidual
casacore::Float	itsInitPeakResidual
casacore::Float	itsMinPeakResidual
casacore::Float	itsMinorCyclePeakResidual
casacore::Float	itsPeakResidualNoMask
casacore::Float	itsPrevPeakResidualNoMask
casacore::Float	itsMinPeakResidualNoMask
casacore::Float	itsNsigma
casacore::Float	itsNsigmaThreshold
casacore::Float	itsMadRMS
casacore::Float	itsMaskSum
casacore::Int	itsPrevMajorCycleCount
int	itsControllerCount
std::recursive_mutex	recordMutex
std::recursive_mutex	descriptionMutex
casacore::Int	itsNiter
	protects itsDescription More...
casacore::Int	itsCycleNiter
casacore::Int	itsInteractiveNiter
casacore::Float	itsThreshold
casacore::Float	itsCycleThreshold
casacore::Float	itsInteractiveThreshold
casacore::Bool	itsIsCycleThresholdAuto
casacore::Bool	itsIsThresholdAuto
casacore::Float	itsCycleFactor
casacore::Float	itsLoopGain
casacore::Bool	itsStopFlag
casacore::Bool	itsPauseFlag
casacore::Bool	itsInteractiveMode
casacore::Bool	itsUpdatedModelFlag
casacore::Int	itsIterDone
casacore::Int	itsInteractiveIterDone
casacore::Int	itsMaxCycleIterDone
casacore::Int	itsMajorDone
casacore::Int	itsStopCode
bool	interactionPending
bool	updateNeeded
std::condition_variable	interactionCond
std::mutex	interactionMutex
casacore::Int	itsNSummaryFields
casacore::Array< casacore::Double >	itsSummaryMinor
casacore::Array< casacore::Int >	itsSummaryMajor
std::shared_ptr < SIIterBot_callback >	callback

Private Member Functions
	SIIterBot_state (const SIIterBot_state &)
	make SIIterBot_state uncopyable... More...
SIIterBot_state &	operator= (const SIIterBot_state &)

Detailed Description

Definition at line 82 of file SIIterBot.h.

Constructor & Destructor Documentation

casa::SIIterBot_state::SIIterBot_state ( const SIIterBot_state &  )

private

make SIIterBot_state uncopyable...

casa::SIIterBot_state::SIIterBot_state

(

std::shared_ptr< SIIterBot_callback >

)

casa::SIIterBot_state::~SIIterBot_state

(

)

Member Function Documentation

void casa::SIIterBot_state::acceptCallbacks ( SIIterBot_adaptor *  siba )

inline

Definition at line 96 of file SIIterBot.h.

References callback.

void casa::SIIterBot_state::addSummaryMajor

(

)

casacore::Int getRemainingNiter(); casacore::Int getCompletedNiter();

void casa::SIIterBot_state::changeCycleFactor

(

casacore::Float

cyclefactor

)

void casa::SIIterBot_state::changeCycleNiter

(

casacore::Int

cycleniter

)

void casa::SIIterBot_state::changeCycleThreshold

(

casacore::Float

cyclethreshold

)

void casa::SIIterBot_state::changeInteractiveMode

(

const bool &

interactiveEnabled

)

void casa::SIIterBot_state::changeInteractiveNiter

(

casacore::Int

interactiveniter

)

void casa::SIIterBot_state::changeInteractiveThreshold

(

casacore::Float

cyclethreshold

)

void casa::SIIterBot_state::changeLoopGain

(

casacore::Float

loopgain

)

void casa::SIIterBot_state::changeMaxPsfFraction

(

casacore::Float

maxpsffraction

)

void casa::SIIterBot_state::changeMinPsfFraction

(

casacore::Float

minpsffraction

)

void casa::SIIterBot_state::changeNiter

(

casacore::Int

niter

)

void mergeSubIterBot(SISubIterBot& subIterBot);

void casa::SIIterBot_state::changeNsigma

(

casacore::Float

nsigma

)

void casa::SIIterBot_state::changePauseFlag

(

const bool &

pauseEnabled

)

void casa::SIIterBot_state::changeStopFlag

(

const bool &

stopEnabled

)

void casa::SIIterBot_state::changeThreshold

(

casacore::Float

threshold

)

virtual int casa::SIIterBot_state::cleanComplete ( casacore::Bool  lastcyclecheck = casacore::False )

virtual

virtual bool majorCycleRequired(casacore::Float currentPeakResidual);

bool casa::SIIterBot_state::decrementController

(

)

void casa::SIIterBot_state::denyCallbacks ( SIIterBot_adaptor *  siba )

inline

Definition at line 97 of file SIIterBot.h.

References callback.

std::string casa::SIIterBot_state::getDescription

(

)

virtual casacore::Record casa::SIIterBot_state::getDetailsRecord ( )

virtual

Reimplemented in casa::DistSIIterBot_state.

casacore::Int casa::SIIterBot_state::getMajorCycleCount

(

)

virtual casacore::Record casa::SIIterBot_state::getMinorCycleControls ( )

virtual

Reimplemented in casa::DistSIIterBot_state.

int casa::SIIterBot_state::getNumberOfControllers

(

)

DBus::Variant casa::SIIterBot_state::getSummary

(

)

START* virtual casacore::Record casa::SIIterBot_state::getSummaryRecord ( )

virtual

Functions for runtime parameter modification.

Reimplemented in casa::DistSIIterBot_state.

bool casa::SIIterBot_state::incrementController

(

)

void casa::SIIterBot_state::incrementMajorCycleCount

(

)

casacore::Record getSubIterBotRecord();

void casa::SIIterBot_state::interactionComplete

(

)

virtual bool casa::SIIterBot_state::interactiveInputRequired ( )

virtual

Reimplemented in casa::DistSIIterBot_state.

virtual void casa::SIIterBot_state::mergeCycleExecutionRecord ( casacore::Record &  )

virtual

Reimplemented in casa::DistSIIterBot_state.

virtual void casa::SIIterBot_state::mergeCycleInitializationRecord ( casacore::Record &  )

virtual

Reimplemented in casa::DistSIIterBot_state.

virtual void casa::SIIterBot_state::mergeMinorCycleSummary ( const casacore::Array< casacore::Double > &  summary )

protectedvirtual

Reimplemented in casa::DistSIIterBot_state.

SIIterBot_state& casa::SIIterBot_state::operator= ( const SIIterBot_state &  )

private

void casa::SIIterBot_state::printOut ( casacore::String  prefix, casacore::Bool  verbose  )

protected

void casa::SIIterBot_state::pushDetails

(

)

void casa::SIIterBot_state::pushSummary

(

)

casacore::Float casa::SIIterBot_state::readThreshold	(	casacore::Record	recordIn,
		casacore::String	id
	)

void casa::SIIterBot_state::resetMinorCycleInitInfo

(

)

void casa::SIIterBot_state::setControlsFromRecord

(

casacore::Record &

recordIn

)

void casa::SIIterBot_state::setDescription

(

const std::string &

value

)

void casa::SIIterBot_state::updateCycleThreshold

(

)

virtual void casa::SIIterBot_state::waitForInteractiveInput ( )

virtual

Reimplemented in casa::DistSIIterBot_state.

Member Data Documentation

std::shared_ptr<SIIterBot_callback> casa::SIIterBot_state::callback

protected

Definition at line 308 of file SIIterBot.h.

Referenced by acceptCallbacks(), and denyCallbacks().

std::recursive_mutex casa::SIIterBot_state::descriptionMutex

protected

Definition at line 265 of file SIIterBot.h.

std::condition_variable casa::SIIterBot_state::interactionCond

protected

Definition at line 299 of file SIIterBot.h.

std::mutex casa::SIIterBot_state::interactionMutex

protected

Definition at line 300 of file SIIterBot.h.

bool casa::SIIterBot_state::interactionPending

protected

Definition at line 297 of file SIIterBot.h.

int casa::SIIterBot_state::itsControllerCount

protected

Definition at line 258 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsCycleFactor

protected

Definition at line 279 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsCycleNiter

protected

Definition at line 269 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsCycleThreshold

protected

Definition at line 273 of file SIIterBot.h.

std::string casa::SIIterBot_state::itsDescription

protected

Definition at line 233 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsInitPeakResidual

protected

Definition at line 240 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsInteractiveIterDone

protected

Definition at line 288 of file SIIterBot.h.

casacore::Bool casa::SIIterBot_state::itsInteractiveMode

protected

Definition at line 284 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsInteractiveNiter

protected

Definition at line 270 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsInteractiveThreshold

protected

Definition at line 274 of file SIIterBot.h.

casacore::Bool casa::SIIterBot_state::itsIsCycleThresholdAuto

protected

Definition at line 276 of file SIIterBot.h.

casacore::Bool casa::SIIterBot_state::itsIsThresholdAuto

protected

Definition at line 277 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsIterDone

protected

Definition at line 287 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsLoopGain

protected

Definition at line 280 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMadRMS

protected

Definition at line 251 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsMajorDone

protected

Definition at line 290 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMaskSum

protected

Definition at line 253 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsMaxCycleIterDone

protected

Definition at line 289 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMaxPsfFraction

protected

Definition at line 236 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMaxPsfSidelobe

protected

Definition at line 237 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMinorCyclePeakResidual

protected

Definition at line 242 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMinPeakResidual

protected

Definition at line 241 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMinPeakResidualNoMask

protected

Definition at line 246 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsMinPsfFraction

protected

Definition at line 235 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsNiter

protected

protects itsDescription

Definition at line 268 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsNsigma

protected

Definition at line 248 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsNsigmaThreshold

protected

Definition at line 249 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsNSummaryFields

protected

Definition at line 304 of file SIIterBot.h.

casacore::Bool casa::SIIterBot_state::itsPauseFlag

protected

Definition at line 283 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsPeakResidual

protected

Definition at line 238 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsPeakResidualNoMask

protected

Definition at line 244 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsPrevMajorCycleCount

protected

Definition at line 255 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsPrevPeakResidual

protected

Definition at line 239 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsPrevPeakResidualNoMask

protected

Definition at line 245 of file SIIterBot.h.

casacore::Int casa::SIIterBot_state::itsStopCode

protected

Definition at line 291 of file SIIterBot.h.

casacore::Bool casa::SIIterBot_state::itsStopFlag

protected

Definition at line 282 of file SIIterBot.h.

casacore::Array<casacore::Int> casa::SIIterBot_state::itsSummaryMajor

protected

Definition at line 306 of file SIIterBot.h.

casacore::Array<casacore::Double> casa::SIIterBot_state::itsSummaryMinor

protected

Definition at line 305 of file SIIterBot.h.

casacore::Float casa::SIIterBot_state::itsThreshold

protected

Definition at line 272 of file SIIterBot.h.

casacore::Bool casa::SIIterBot_state::itsUpdatedModelFlag

protected

Definition at line 285 of file SIIterBot.h.

std::recursive_mutex casa::SIIterBot_state::recordMutex

protected

Definition at line 264 of file SIIterBot.h.

bool casa::SIIterBot_state::updateNeeded

protected

Definition at line 298 of file SIIterBot.h.

---

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

• casa/code/synthesis/ImagerObjects/SIIterBot.h