Package adams.data.jai.transformer

Class IndexedColors

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

All Implemented Interfaces:

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

public class IndexedColors
extends AbstractJAITransformer

Turns an RGB image into one with an indexed color palette.

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

-num-colors <int> (property: numColors)
    The maximum number of colors in the palette.
    default: 256
    minimum: 1
 

-color-quantizer <MEDIANCUT|NEUQUANT|OCTTREE> (property: colorQuantizer)
    The type of color quantizer to use.
    default: MEDIANCUT
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexedColors.ColorQuantizer	The types of color quantizers.

Field Summary

Fields

Modifier and Type	Field	Description
protected IndexedColors.ColorQuantizer	m_ColorQuantizer	the color quantizer.
protected int	m_NumColors	the number of colors.

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

Method Summary

Modifier and Type	Method	Description
String	colorQuantizerTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer[]	doTransform(BufferedImageContainer img)	Performs no transformation at all, just returns the input.
IndexedColors.ColorQuantizer	getColorQuantizer()	Returns the type of color quantizer in use.
int	getNumColors()	Returns the maximum number of colors.
String	globalInfo()	Returns a string describing the object.
String	numColorsTipText()	Returns the tip text for this property.
void	setColorQuantizer(IndexedColors.ColorQuantizer value)	Sets the type of color quantizer to use.
void	setNumColors(int value)	Sets the maximum number of colors.

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, 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_NumColors

protected int m_NumColors

the number of colors.

m_ColorQuantizer

protected IndexedColors.ColorQuantizer m_ColorQuantizer

the color quantizer.

Constructor Detail

IndexedColors

public IndexedColors()

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

setNumColors

public void setNumColors(int value)

Sets the maximum number of colors.

Parameters:

value - the maximum

getNumColors

public int getNumColors()

Returns the maximum number of colors.

Returns:

the maximum

numColorsTipText

public String numColorsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setColorQuantizer

public void setColorQuantizer(IndexedColors.ColorQuantizer value)

Sets the type of color quantizer to use.

Parameters:

value - the type

getColorQuantizer

public IndexedColors.ColorQuantizer getColorQuantizer()

Returns the type of color quantizer in use.

Returns:

the type

colorQuantizerTipText

public String colorQuantizerTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

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