Package adams.data.io.output

Class GrayscaleImageSegmentationWriter

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

adams.data.io.output.GrayscaleImageSegmentationWriter

All Implemented Interfaces:

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

public class GrayscaleImageSegmentationWriter
extends AbstractImplicitBackgroundPNGAnnotationImageSegmentationWriter

The layers get stored as grayscale values, with 0 being the background.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

m_ImplicitBackground

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

Method Summary

Modifier and Type	Method	Description
protected String	doWrite(PlaceholderFile file, ImageSegmentationContainer annotations)	Writes the image segmentation annotations.
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.

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

defineOptions, getImplicitBackground, implicitBackgroundTipText, setImplicitBackground

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

Constructor Detail

GrayscaleImageSegmentationWriter

public GrayscaleImageSegmentationWriter()

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

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

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