Package adams.data.jai.transformer

Class Brightness

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.jai.transformer.AbstractJAITransformer

adams.data.jai.transformer.Brightness

All Implemented Interfaces:

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

public class Brightness
extends AbstractJAITransformer

Brightens or darkens an image using the specified factor and offset.
factor: <0=darken image, >0=brighten image.

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

-factor <float> (property: factor)
    The factor to use for brightening/darkening.
    default: 1.0
    minimum: 1.0E-4
 

-offset <float> (property: offset)
    The offset to use for brightening/darkening.
    default: 0.0
 

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 float	m_Factor	the factor to use.
protected float	m_Offset	the offset 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
Brightness()

Method Summary

Modifier and Type	Method	Description
protected void	checkImage(BufferedImageContainer img)	Optional checks of the image.
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	factorTipText()	Returns the tip text for this property.
float	getFactor()	Returns the factor.
float	getOffset()	Returns the offset.
String	globalInfo()	Returns a string describing the object.
String	offsetTipText()	Returns the tip text for this property.
void	setFactor(float value)	Sets the factor.
void	setOffset(float value)	Sets the offset.

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

forCommandLine, forName, getTransformations

Methods inherited from class adams.data.image.AbstractImageTransformer

cleanUp, compareTo, destroy, equals, getFlowContext, getQuickInfo, 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_Factor

protected float m_Factor

the factor to use.

m_Offset

protected float m_Offset

the offset to use.

Constructor Detail

Brightness

public Brightness()

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

setFactor

public void setFactor(float value)

Sets the factor.

Parameters:

value - the factor

getFactor

public float getFactor()

Returns the factor.

Returns:

the factor

factorTipText

public String factorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setOffset

public void setOffset(float value)

Sets the offset.

Parameters:

value - the offset

getOffset

public float getOffset()

Returns the offset.

Returns:

the offset

offsetTipText

public String offsetTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

checkImage

protected void checkImage(BufferedImageContainer img)

Optional checks of the image.

Overrides:

checkImage in class AbstractImageTransformer<BufferedImageContainer>

Parameters:

img - the image to check

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