Package adams.data.image.transformer

Class ImageFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.AbstractImageTransformer<BufferedImageContainer>

adams.data.image.transformer.AbstractBufferedImageTransformer

adams.data.image.transformer.ImageFilter

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ImageTransformer<BufferedImageContainer>, FlowContextHandler, Serializable, Comparable

public class ImageFilter
extends AbstractBufferedImageTransformer

Applies an ImageFilter to the buffered image.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-filter <adams.data.imagefilter.AbstractImageFilterProvider> (property: filter)
    The provider of the image filter to apply to the image.
    default: adams.data.imagefilter.GrayFilterProvider
 

-copy <boolean> (property: copy)
    If enabled, a copy of the image is created first before applying the filter.
    default: false
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Copy	whether to create a copy of the image first.
protected AbstractImageFilterProvider	m_Filter	the filter to apply.

Fields inherited from class adams.data.image.AbstractImageTransformer

m_FlowContext

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

Method Summary

Modifier and Type	Method	Description
String	copyTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer[]	doTransform(BufferedImageContainer img)	Generates the subimages.
String	filterTipText()	Returns the tip text for this property.
boolean	getCopy()	Returns whether a copy is created first before applying the filter.
AbstractImageFilterProvider	getFilter()	Returns the filter.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setCopy(boolean value)	Sets whether to create a copy of the image first.
void	setFilter(AbstractImageFilterProvider value)	Sets the filter.

Methods inherited from class adams.data.image.transformer.AbstractBufferedImageTransformer

forCommandLine, forName, getTransformations

Methods inherited from class adams.data.image.AbstractImageTransformer

checkImage, cleanUp, compareTo, destroy, equals, getFlowContext, initialize, setFlowContext, shallowCopy, shallowCopy, transform

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Filter

protected AbstractImageFilterProvider m_Filter

the filter to apply.

m_Copy

protected boolean m_Copy

whether to create a copy of the image first.

Constructor Detail

ImageFilter

public ImageFilter()

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 AbstractOptionHandler

setFilter

public void setFilter(AbstractImageFilterProvider value)

Sets the filter.

Parameters:

value - the filter

getFilter

public AbstractImageFilterProvider getFilter()

Returns the filter.

Returns:

the filter

filterTipText

public String filterTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setCopy

public void setCopy(boolean value)

Sets whether to create a copy of the image first.

Parameters:

value - true if to create copy

getCopy

public boolean getCopy()

Returns whether a copy is created first before applying the filter.

Returns:

true if a copy is created first

copyTipText

public String copyTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractImageTransformer<BufferedImageContainer>

Returns:

null if no info available, otherwise short string

doTransform

protected BufferedImageContainer[] doTransform(BufferedImageContainer img)

Generates the subimages.

Specified by:

doTransform in class AbstractImageTransformer<BufferedImageContainer>

Parameters:

img - the image to process (can be modified, since it is a copy)

Returns:

the subimages