ImageSegmentationAnnotationReader (adams-pom 25.11.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, FileFormatHandler, OptionHandler

All Known Subinterfaces:

ImageSegmentationAnnotationReaderWithLayerNames

All Known Implementing Classes:

AbstractCustomPNGAnnotationImageSegmentationReader, AbstractImageSegmentationAnnotationReader, AbstractPNGAnnotationImageSegmentationReader, BlueChannelImageSegmentationReader, GrayscaleImageSegmentationReader, IndexedPNGImageSegmentationReader, IndividualImageSegmentationLayerReader
```
public interface ImageSegmentationAnnotationReader
extends OptionHandler, FileFormatHandler
```
Interface for readers 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
`PlaceholderDirectory`	`getAlternativeAnnotationDir()`	Returns the alternative directory for the annotations.
`ImageSegmentationAnnotationWriter`	`getCorrespondingWriter()`	Returns, if available, the corresponding writer.
`boolean`	`getUseAlternativeAnnotationDir()`	Returns whether to use an alternative directory for the annotations.
`ImageSegmentationContainer`	`read(PlaceholderFile file)`	Reads the image segmentation annotations.
`void`	`setAlternativeAnnotationDir(PlaceholderDirectory value)`	Sets the alternative directory for the annotations.
`void`	`setUseAlternativeAnnotationDir(boolean value)`	Sets whether to use an alternative directory for the 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
  - getCorrespondingWriter
```
ImageSegmentationAnnotationWriter getCorrespondingWriter()
```
    Returns, if available, the corresponding writer.
    
    Returns:
    
    the writer, null if none available
  - setUseAlternativeAnnotationDir
```
void setUseAlternativeAnnotationDir(boolean value)
```
    Sets whether to use an alternative directory for the annotations.
    
    Parameters:
    
    value - true if to use alternative dir
  - getUseAlternativeAnnotationDir
```
boolean getUseAlternativeAnnotationDir()
```
    Returns whether to use an alternative directory for the annotations.
    
    Returns:
    
    true if to use alternative dir
  - setAlternativeAnnotationDir
```
void setAlternativeAnnotationDir(PlaceholderDirectory value)
```
    Sets the alternative directory for the annotations.
    
    Parameters:
    
    value - the alternative dir
  - getAlternativeAnnotationDir
```
PlaceholderDirectory getAlternativeAnnotationDir()
```
    Returns the alternative directory for the annotations.
    
    Returns:
    
    the alternative dir
  - read
```
ImageSegmentationContainer read(PlaceholderFile file)
```
    Reads the image segmentation annotations.
    
    Parameters:
    
    file - the file to read from
    
    Returns:
    
    the annotations