AbstractImplicitBackgroundPNGAnnotationImageSegmentationWriter (adams-pom 24.11.0-SNAPSHOT API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BlueChannelImageSegmentationWriter, GrayscaleImageSegmentationWriter
```
public abstract class AbstractImplicitBackgroundPNGAnnotationImageSegmentationWriter
extends AbstractPNGAnnotationImageSegmentationWriter
```
Ancestor for image segmentation annotation writers that store the annotations in a single PNG file and can use an implicit background.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected boolean m_ImplicitBackground
whether to use an implicit background (ie first layer = 1).
- 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

AbstractImplicitBackgroundPNGAnnotationImageSegmentationWriter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`boolean`	`getImplicitBackground()`	Returns whether to use an implicit background, ie layers with start at index 1 rather than 0.
`String`	`implicitBackgroundTipText()`	Returns the tip text for this property.
`void`	`setImplicitBackground(boolean value)`	Sets whether to use an implicit background, ie layers with start at index 1 rather than 0.

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
doWrite, getCorrespondingReader, getSkipBaseImage, setSkipBaseImage, skipBaseImageTipText, write, writeBaseImage

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.io.FileFormatHandler
getFormatDescription

Methods inherited from interface adams.data.io.output.ImageSegmentationAnnotationWriter
getCorrespondingReader, write

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- Field Detail
  - m_ImplicitBackground
```
protected boolean m_ImplicitBackground
```
    whether to use an implicit background (ie first layer = 1).
- Constructor Detail
  - AbstractImplicitBackgroundPNGAnnotationImageSegmentationWriter
```
public AbstractImplicitBackgroundPNGAnnotationImageSegmentationWriter()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractPNGAnnotationImageSegmentationWriter
  - setImplicitBackground
```
public void setImplicitBackground(boolean value)
```
    Sets whether to use an implicit background, ie layers with start at index 1 rather than 0.
    
    Parameters:
    
    value - true if to use implicit background
  - getImplicitBackground
```
public boolean getImplicitBackground()
```
    Returns whether to use an implicit background, ie layers with start at index 1 rather than 0.
    
    Returns:
    
    true if to use implicit background
  - implicitBackgroundTipText
```
public String implicitBackgroundTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.