Package adams.data.image.transformer

Class Grayscale

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

All Implemented Interfaces:

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

public class Grayscale
extends AbstractBufferedImageTransformer

Generates a grayscale images using the specified luminance parameters.

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

-luminance <adams.data.image.luminance.AbstractLuminanceParameters> (property: luminance)
    Supplies the luminance parameters for the grayscale conversion.
    default: adams.data.image.luminance.BT601
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractLuminanceParameters	m_Luminance	the luminance parameters 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
Grayscale()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer[]	doTransform(BufferedImageContainer img)	Performs the actual transforming of the image.
AbstractLuminanceParameters	getLuminance()	Returns the luminance scheme.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	luminanceTipText()	Returns the tip text for this property.
void	setLuminance(AbstractLuminanceParameters value)	Sets the luminance scheme.

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_Luminance

protected AbstractLuminanceParameters m_Luminance

the luminance parameters to use.

Constructor Detail

Grayscale

public Grayscale()

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

setLuminance

public void setLuminance(AbstractLuminanceParameters value)

Sets the luminance scheme.

Parameters:

value - the scheme

getLuminance

public AbstractLuminanceParameters getLuminance()

Returns the luminance scheme.

Returns:

the scheme

luminanceTipText

public String luminanceTipText()

Returns the tip text for this property.

Returns:

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

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 the actual transforming of the image.

Specified by:

doTransform in class AbstractImageTransformer<BufferedImageContainer>

Parameters:

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

Returns:

the generated image(s)