Package adams.flow.transformer.negativeregions

Class MaxDimensions

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.MaxDimensions

All Implemented Interfaces:

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

public class MaxDimensions
extends AbstractMetaNegativeRegionsGenerator

Enforces the specified maximum dimensions.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MaxHeight	the maximum height.
protected int	m_MaxWidth	the maximum width.

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
MaxDimensions()

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	getMaxHeight()	Returns the maximum height a negative region can have.
int	getMaxWidth()	Returns the maximum width a negative region can have.
String	globalInfo()	Returns a string describing the object.
String	maxHeightTipText()	Returns the tip text for this property.
String	maxWidthTipText()	Returns the tip text for this property.
void	setMaxHeight(int value)	Sets the maximum height a negative region can have.
void	setMaxWidth(int value)	Sets the maximum width a negative region can have.

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_MaxWidth

protected int m_MaxWidth

the maximum width.

m_MaxHeight

protected int m_MaxHeight

the maximum height.

Constructor Detail

MaxDimensions

public MaxDimensions()

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

setMaxWidth

public void setMaxWidth(int value)

Sets the maximum width a negative region can have.

Parameters:

value - the maximum width, ignored if <1

getMaxWidth

public int getMaxWidth()

Returns the maximum width a negative region can have.

Returns:

the maximum width, ignored if <1

maxWidthTipText

public String maxWidthTipText()

Returns the tip text for this property.

Returns:

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

setMaxHeight

public void setMaxHeight(int value)

Sets the maximum height a negative region can have.

Parameters:

value - the maximum height, ignored if <1

getMaxHeight

public int getMaxHeight()

Returns the maximum height a negative region can have.

Returns:

the maximum height, ignored if <1

maxHeightTipText

public String maxHeightTipText()

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