Package adams.data.io.output

Class GrayOrIndexedImageWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractImageWriter<BufferedImageContainer>

adams.data.io.output.GrayOrIndexedImageWriter

All Implemented Interfaces:

ClassCrossReference, CrossReference, Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ImageWriter<BufferedImageContainer>, ColorProviderHandler, Serializable

public class GrayOrIndexedImageWriter
extends AbstractImageWriter<BufferedImageContainer>
implements ClassCrossReference, ColorProviderHandler

Changes the unique colors to the ones specified by the color provider.
Useful for generating human-viewable images from image segmentation annotations.
Uses adams.data.io.output.ApacheCommonsImageWriter for performing the actual writing after the conversion.

See also:
adams.data.io.output.ApacheCommonsImageWriter

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

-color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider to use for coloring in the grayscale/indexed image.
    default: adams.gui.visualization.core.CustomColorProvider -color #ffff00 -color #0000ff -color #ff0000
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ColorProvider	m_ColorProvider	the color provider for generating the colors.

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

Method Summary

Modifier and Type	Method	Description
String	colorProviderTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doWrite(PlaceholderFile file, BufferedImageContainer cont)	Performs the actual writing of the image file.
Class[]	getClassCrossReferences()	Returns the cross-referenced classes.
ColorProvider	getColorProvider()	Returns the color provider to use.
ImageReader	getCorrespondingReader()	Returns, if available, the corresponding reader.
protected ColorProvider	getDefaultColorProvider()	Returns the default color provider.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
String	globalInfo()	Returns a string describing the object.
void	setColorProvider(ColorProvider value)	Sets the color provider to use.

Methods inherited from class adams.data.io.output.AbstractImageWriter

check, getDefaultFormatExtension, getWriters, isAvailable, write

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_ColorProvider

protected ColorProvider m_ColorProvider

the color provider for generating the colors.

Constructor Detail

GrayOrIndexedImageWriter

public GrayOrIndexedImageWriter()

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

getClassCrossReferences

public Class[] getClassCrossReferences()

Returns the cross-referenced classes.

Specified by:

getClassCrossReferences in interface ClassCrossReference

Returns:

the classes

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultColorProvider

protected ColorProvider getDefaultColorProvider()

Returns the default color provider.

Returns:

the default

setColorProvider

public void setColorProvider(ColorProvider value)

Sets the color provider to use.

Specified by:

setColorProvider in interface ColorProviderHandler

Parameters:

value - the color provider

getColorProvider

public ColorProvider getColorProvider()

Returns the color provider to use.

Specified by:

getColorProvider in interface ColorProviderHandler

Returns:

the color provider

colorProviderTipText

public String colorProviderTipText()

Returns the tip text for this property.

Specified by:

colorProviderTipText in interface ColorProviderHandler

Returns:

tip text for this property suitable for displaying in the gui

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Specified by:

getFormatDescription in class AbstractImageWriter<BufferedImageContainer>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface FileFormatHandler

Specified by:

getFormatExtensions in class AbstractImageWriter<BufferedImageContainer>

Returns:

the extension (without the dot!)

getCorrespondingReader

public ImageReader getCorrespondingReader()

Returns, if available, the corresponding reader.

Specified by:

getCorrespondingReader in interface ImageWriter<BufferedImageContainer>

Specified by:

getCorrespondingReader in class AbstractImageWriter<BufferedImageContainer>

Returns:

the reader, null if none available

doWrite

protected String doWrite(PlaceholderFile file,
                         BufferedImageContainer cont)

Performs the actual writing of the image file.

Specified by:

doWrite in class AbstractImageWriter<BufferedImageContainer>

Parameters:

file - the file to write to

cont - the image container to write

Returns:

null if successfully written, otherwise error message