Package adams.data.io.output

Class IndividualImageSegmentationLayerWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractImageSegmentationAnnotationWriter

adams.data.io.output.IndividualImageSegmentationLayerWriter

All Implemented Interfaces:

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

public class IndividualImageSegmentationLayerWriter
extends AbstractImageSegmentationAnnotationWriter

Uses a JPG as base image and indexed PNG files for the individual layers (0 = background, 1 = annotation).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_SkipEmptyLayers	whether to skip images with only background.

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

Method Summary

Modifier and Type	Method	Description
protected int	countColors(BufferedImage image)	Counts the distinct colors in the image.
void	defineOptions()	Adds options to the internal list of options.
protected String	doWrite(PlaceholderFile file, ImageSegmentationContainer annotations)	Writes the image segmentation annotations.
ImageSegmentationAnnotationReader	getCorrespondingReader()	Returns, if available, the corresponding reader.
String	getDefaultFormatExtension()	Returns the default extension of the format.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
boolean	getSkipEmptyLayers()	Returns whether to skip writing empty layers (ie only background).
String	globalInfo()	Returns a string describing the object.
void	setSkipEmptyLayers(boolean value)	Sets whether to skip writing empty layers (ie only background).
String	skipEmptyLayersTipText()	Returns the tip text for this property.
protected String	writeFile(BufferedImage image, PlaceholderFile file)	Writes the file to disk.

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

check, 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.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_SkipEmptyLayers

protected boolean m_SkipEmptyLayers

whether to skip images with only background.

Constructor Detail

IndividualImageSegmentationLayerWriter

public IndividualImageSegmentationLayerWriter()

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 AbstractImageSegmentationAnnotationWriter

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

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Returns:

the extension (without the dot!)

getDefaultFormatExtension

public String getDefaultFormatExtension()

Returns the default extension of the format.

Returns:

the default extension (without the dot!)

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

setSkipEmptyLayers

public void setSkipEmptyLayers(boolean value)

Sets whether to skip writing empty layers (ie only background).

Parameters:

value - true if to skip

getSkipEmptyLayers

public boolean getSkipEmptyLayers()

Returns whether to skip writing empty layers (ie only background).

Returns:

true if to skip

skipEmptyLayersTipText

public String skipEmptyLayersTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

writeFile

protected String writeFile(BufferedImage image,
                           PlaceholderFile file)

Writes the file to disk.

Parameters:

image - the image to write

file - the file to write to

Returns:

null if successful, otherwise error message

countColors

protected int countColors(BufferedImage image)

Counts the distinct colors in the image.

Parameters:

image - the image to process

Returns:

the count

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