Package adams.data.io.output

Class IndexedPNGImageSegmentationWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractImageSegmentationAnnotationWriter

adams.data.io.output.AbstractPNGAnnotationImageSegmentationWriter

adams.data.io.output.IndexedPNGImageSegmentationWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ImageSegmentationAnnotationWriter, ImageSegmentationAnnotationWriterWithLayerNames, ColorProviderHandler, Serializable

public class IndexedPNGImageSegmentationWriter
extends AbstractPNGAnnotationImageSegmentationWriter
implements ColorProviderHandler

Each layer gets stored with a separate color in the palette.

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	for supplying the palette colors.

Fields inherited from class adams.data.io.output.AbstractPNGAnnotationImageSegmentationWriter

m_LayerNames

Fields inherited from class adams.data.io.output.AbstractImageSegmentationAnnotationWriter

m_SkipBaseImage

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

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, ImageSegmentationContainer annotations)	Writes the image segmentation annotations.
ColorProvider	getColorProvider()	Returns the color provider to use for the palette.
ImageSegmentationAnnotationReader	getCorrespondingReader()	Returns, if available, the corresponding reader.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String	globalInfo()	Returns a string describing the object.
void	setColorProvider(ColorProvider value)	Sets the color provider to use for the palette.

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

check, getAnnotationFile, getDefaultFormatExtension, getFormatExtensions, getLayerNames, getLayerNames, layerNamesTipText, setLayerNames

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

getSkipBaseImage, setSkipBaseImage, skipBaseImageTipText, write, writeBaseImage

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.data.io.output.ImageSegmentationAnnotationWriter

write

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

for supplying the palette colors.

Constructor Detail

IndexedPNGImageSegmentationWriter

public IndexedPNGImageSegmentationWriter()

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 AbstractPNGAnnotationImageSegmentationWriter

setColorProvider

public void setColorProvider(ColorProvider value)

Sets the color provider to use for the palette.

Specified by:

setColorProvider in interface ColorProviderHandler

Parameters:

value - the provider

getColorProvider

public ColorProvider getColorProvider()

Returns the color provider to use for the palette.

Specified by:

getColorProvider in interface ColorProviderHandler

Returns:

the 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 or for listing the options.

getCorrespondingReader

public ImageSegmentationAnnotationReader getCorrespondingReader()

Returns, if available, the corresponding reader.

Specified by:

getCorrespondingReader in interface ImageSegmentationAnnotationWriter

Specified by:

getCorrespondingReader in class AbstractImageSegmentationAnnotationWriter

Returns:

the reader, null if none available

getFormatDescription

public String getFormatDescription()

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

Specified by:

getFormatDescription in interface FileFormatHandler

Returns:

a description suitable for displaying in the file chooser

doWrite

protected String doWrite(PlaceholderFile file,
                         ImageSegmentationContainer annotations)

Writes the image segmentation annotations.

Specified by:

doWrite in class AbstractImageSegmentationAnnotationWriter

Parameters:

file - the file to write to

annotations - the annotations to write

Returns:

null if successfully written, otherwise error message