Package adams.flow.transformer.negativeregions

Class LargestRegions

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.negativeregions.AbstractNegativeRegionsGenerator

adams.flow.transformer.negativeregions.AbstractMetaNegativeRegionsGenerator

adams.flow.transformer.negativeregions.LargestRegions

All Implemented Interfaces:

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

public class LargestRegions
extends AbstractMetaNegativeRegionsGenerator

Returns only the top X largest regions from the base generator.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MaxRegions	the maximum number of regions to return.

Fields inherited from class adams.flow.transformer.negativeregions.AbstractMetaNegativeRegionsGenerator

m_ActualAlgorithm, m_Algorithm

Fields inherited from class adams.flow.transformer.negativeregions.AbstractNegativeRegionsGenerator

m_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
LargestRegions()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected LocatedObjects	doGenerateRegions(AbstractImageContainer cont)	Generates the negative regions.
int	getMaxRegions()	Returns the maximum number of regions to generate.
String	globalInfo()	Returns a string describing the object.
String	maxRegionsTipText()	Returns the tip text for this property.
void	setMaxRegions(int value)	Sets the maximum number of regions to generate.

Methods inherited from class adams.flow.transformer.negativeregions.AbstractMetaNegativeRegionsGenerator

algorithmTipText, getActualAlgorithm, getAlgorithm, getDefaultAlgorithm, getQuickInfo, reset, setAlgorithm

Methods inherited from class adams.flow.transformer.negativeregions.AbstractNegativeRegionsGenerator

check, generateRegions, isStopped, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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_MaxRegions

protected int m_MaxRegions

the maximum number of regions to return.

Constructor Detail

LargestRegions

public LargestRegions()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractMetaNegativeRegionsGenerator

setMaxRegions

public void setMaxRegions(int value)

Sets the maximum number of regions to generate.

Parameters:

value - the maximum, <1 returns all

getMaxRegions

public int getMaxRegions()

Returns the maximum number of regions to generate.

Returns:

the maximum, <1 returns all

maxRegionsTipText

public String maxRegionsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doGenerateRegions

protected LocatedObjects doGenerateRegions(AbstractImageContainer cont)

Generates the negative regions.

Specified by:

doGenerateRegions in class AbstractNegativeRegionsGenerator

Parameters:

cont - the image container to generate the regions for

Returns:

the generated regions