Package adams.data.image.transformer

Class Binary

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

All Implemented Interfaces:

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

public class Binary
extends AbstractBufferedImageTransformer

Turns an image into a binary image, using a grayscale threshold to determine which pixels are black (below) and which are white (equal to or above).

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

-threshold <int> (property: threshold)
    The threshold that determines whether a grayscale pixel will become black 
    (below) or white (equal to or above).
    default: 128
    minimum: 0
    maximum: 255
 

Version:

$Revision: 7706 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Threshold	the (grayscale) threshold to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer[]	doTransform(BufferedImageContainer img)	Performs no transformation at all, just returns the input.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
int	getThreshold()	Returns the threshold.
String	globalInfo()	Returns a string describing the object.
void	setThreshold(int value)	Sets the threshold.
String	thresholdTipText()	Returns the tip text for this property.

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_Threshold

protected int m_Threshold

the (grayscale) threshold to use.

Constructor Detail

Binary

public Binary()

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

setThreshold

public void setThreshold(int value)

Sets the threshold.

Parameters:

value - the threshold

getThreshold

public int getThreshold()

Returns the threshold.

Returns:

the threshold

thresholdTipText

public String thresholdTipText()

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)

Performs no transformation at all, just returns the input.

Specified by:

doTransform in class AbstractImageTransformer<BufferedImageContainer>

Parameters:

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

Returns:

the copy of the image