Package adams.flow.transformer.negativeregions

Class AbstractNegativeRegionsGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.negativeregions.AbstractNegativeRegionsGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, Serializable

Direct Known Subclasses:

AbstractMetaNegativeRegionsGenerator, Null, RandomRegions, SimpleBlockFill

public abstract class AbstractNegativeRegionsGenerator
extends AbstractOptionHandler
implements QuickInfoSupporter, StoppableWithFeedback

Ancestor for algorithms for generating negative regions.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Stopped	whether the generator was stopped.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractNegativeRegionsGenerator()

Method Summary

Modifier and Type	Method	Description
protected String	check(AbstractImageContainer cont)	Hook methods for checks before processing.
protected abstract LocatedObjects	doGenerateRegions(AbstractImageContainer cont)	Generates the negative regions.
LocatedObjects	generateRegions(AbstractImageContainer cont)	Generates the negative regions.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
boolean	isStopped()	Whether the execution has been stopped.
void	stopExecution()	Stops the execution.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Stopped

protected boolean m_Stopped

whether the generator was stopped.

Constructor Detail

AbstractNegativeRegionsGenerator

public AbstractNegativeRegionsGenerator()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation just returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check(AbstractImageContainer cont)

Hook methods for checks before processing.

Parameters:

cont - the image container to check

Returns:

null if successful, otherwise error message

doGenerateRegions

protected abstract LocatedObjects doGenerateRegions(AbstractImageContainer cont)

Generates the negative regions.

Parameters:

cont - the image container to generate the regions for

Returns:

the generated regions

generateRegions

public LocatedObjects generateRegions(AbstractImageContainer cont)

Generates the negative regions.

Parameters:

cont - the image container to generate the regions for

Returns:

the generated regions

stopExecution

public void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface Stoppable

isStopped

public boolean isStopped()

Whether the execution has been stopped.

Specified by:

isStopped in interface StoppableWithFeedback

Returns:

true if stopped