ImageSegmentationAnnotationWriter (adams-pom 24.11.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, FileFormatHandler, OptionHandler

All Known Subinterfaces:

ImageSegmentationAnnotationWriterWithLayerNames

All Known Implementing Classes:

AbstractImageSegmentationAnnotationWriter, AbstractImplicitBackgroundPNGAnnotationImageSegmentationWriter, AbstractPNGAnnotationImageSegmentationWriter, BlueChannelImageSegmentationWriter, GrayscaleImageSegmentationWriter, IndexedPNGImageSegmentationWriter, IndividualImageSegmentationLayerWriter
```
public interface ImageSegmentationAnnotationWriter
extends OptionHandler, FileFormatHandler
```
Interface for writers for image segmentation annotations.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ImageSegmentationAnnotationReader`	`getCorrespondingReader()`	Returns, if available, the corresponding reader.
`String`	`write(PlaceholderFile file, ImageSegmentationContainer annotations)`	Writes the image segmentation annotations.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.io.FileFormatHandler
getDefaultFormatExtension, getFormatDescription, getFormatExtensions

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

- Method Detail
  - getCorrespondingReader
```
ImageSegmentationAnnotationReader getCorrespondingReader()
```
    Returns, if available, the corresponding reader.
    
    Returns:
    
    the reader, null if none available
  - write
```
String write(PlaceholderFile file,
             ImageSegmentationContainer annotations)
```
    Writes the image segmentation annotations.
    
    Parameters:
    
    file - the file to write to
    
    annotations - the annotations to write
    
    Returns:
    
    null if successfully written, otherwise error message