HuginBase::TimeConsumingPanoramaAlgorithm Class Reference

#include <PanoramaAlgorithm.h>

Inheritance diagram for HuginBase::TimeConsumingPanoramaAlgorithm:

Public Member Functions
virtual	~TimeConsumingPanoramaAlgorithm ()
virtual bool	wasCancelled () const
Public Member Functions inherited from HuginBase::PanoramaAlgorithm
virtual	~PanoramaAlgorithm ()
virtual bool	modifiesPanoramaData () const =0
	returns true if the algorithm changes the PanoramaData.
virtual bool	hasRunSuccessfully ()
virtual void	run ()
	runs the algorithm.
virtual bool	runAlgorithm ()=0
	implementation of the algorithm.

Protected Member Functions
	TimeConsumingPanoramaAlgorithm (PanoramaData &panorama, AppBase::ProgressDisplay *progressDisplay=NULL)
	[Warning! it keeps the reference to the panorama data!]
virtual AppBase::ProgressDisplay *	getProgressDisplay () const
virtual bool	hasProgressDisplay () const
virtual void	cancelAlgorithm ()
	Call this when the algorithm is cancelled.
virtual void	algorithmCancelled ()
	Called when the algorithm got cancelled; override with cleaning up process etc.
Protected Member Functions inherited from HuginBase::PanoramaAlgorithm
	PanoramaAlgorithm (PanoramaData &panorama)

Private Attributes
AppBase::ProgressDisplay *	m_progressDisplay
bool	m_wasCancelled

Additional Inherited Members
Protected Attributes inherited from HuginBase::PanoramaAlgorithm
PanoramaData &	o_panorama
bool	o_successful

Detailed Description

Definition at line 118 of file PanoramaAlgorithm.h.

Constructor & Destructor Documentation

TimeConsumingPanoramaAlgorithm()

HuginBase::TimeConsumingPanoramaAlgorithm::TimeConsumingPanoramaAlgorithm ( PanoramaData &  panorama, AppBase::ProgressDisplay *  progressDisplay = NULL  )

inlineprotected

[Warning! it keeps the reference to the panorama data!]

Definition at line 123 of file PanoramaAlgorithm.h.

~TimeConsumingPanoramaAlgorithm()

virtual HuginBase::TimeConsumingPanoramaAlgorithm::~TimeConsumingPanoramaAlgorithm ( )

inlinevirtual

Definition at line 130 of file PanoramaAlgorithm.h.

Member Function Documentation

algorithmCancelled()

virtual void HuginBase::TimeConsumingPanoramaAlgorithm::algorithmCancelled ( )

inlineprotectedvirtual

Called when the algorithm got cancelled; override with cleaning up process etc.

the default implementation does nothing.

Definition at line 177 of file PanoramaAlgorithm.h.

cancelAlgorithm()

virtual void HuginBase::TimeConsumingPanoramaAlgorithm::cancelAlgorithm ( )

inlineprotectedvirtual

Call this when the algorithm is cancelled.

This method sets wasCancelled() to return true, and calls algorithmCancelled()

Definition at line 167 of file PanoramaAlgorithm.h.

Referenced by HuginBase::PhotometricOptimizer::runAlgorithm(), HuginBase::SmartPhotometricOptimizer::runAlgorithm(), and HuginBase::PointSampler::runAlgorithm().

getProgressDisplay()

virtual AppBase::ProgressDisplay * HuginBase::TimeConsumingPanoramaAlgorithm::getProgressDisplay ( ) const

inlineprotectedvirtual

Definition at line 148 of file PanoramaAlgorithm.h.

Referenced by HuginBase::CalculateOptimalROI::autocrop(), HuginBase::CalculateOptimalROI::calcOptimalROI(), HuginBase::PhotometricOptimizer::runAlgorithm(), HuginBase::SmartPhotometricOptimizer::runAlgorithm(), HuginBase::PointSampler::runAlgorithm(), and HuginBase::NonaFileOutputStitcher::runStitcher().

hasProgressDisplay()

virtual bool HuginBase::TimeConsumingPanoramaAlgorithm::hasProgressDisplay ( ) const

inlineprotectedvirtual

Definition at line 152 of file PanoramaAlgorithm.h.

References threshold().

wasCancelled()

virtual bool HuginBase::TimeConsumingPanoramaAlgorithm::wasCancelled ( ) const

inlinevirtual

Definition at line 160 of file PanoramaAlgorithm.h.

Referenced by HuginBase::PhotometricOptimizer::runAlgorithm(), HuginBase::SmartPhotometricOptimizer::runAlgorithm(), and HuginBase::PointSampler::runAlgorithm().

Member Data Documentation

m_progressDisplay

AppBase::ProgressDisplay* HuginBase::TimeConsumingPanoramaAlgorithm::m_progressDisplay

private

Definition at line 183 of file PanoramaAlgorithm.h.

m_wasCancelled

bool HuginBase::TimeConsumingPanoramaAlgorithm::m_wasCancelled

private

Definition at line 184 of file PanoramaAlgorithm.h.

---

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

• hugin_base/algorithms/PanoramaAlgorithm.h