AbstractCustomPNGAnnotationImageSegmentationReader (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.input.AbstractImageSegmentationAnnotationReader
      - adams.data.io.input.AbstractPNGAnnotationImageSegmentationReader
        
        adams.data.io.input.AbstractCustomPNGAnnotationImageSegmentationReader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ImageSegmentationAnnotationReader, ImageSegmentationAnnotationReaderWithLayerNames, Serializable

Direct Known Subclasses:

BlueChannelImageSegmentationReader, GrayscaleImageSegmentationReader
```
public abstract class AbstractCustomPNGAnnotationImageSegmentationReader
extends AbstractPNGAnnotationImageSegmentationReader
```
Ancestor for readers that read the annotations from a single PNG file and allow the reader to be specified.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected ImageReader m_Reader
the image reader for the PNG.
- Fields inherited from class adams.data.io.input.AbstractPNGAnnotationImageSegmentationReader
  m_LayerNames, m_Lenient, m_SkipFirstLayer
- 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

AbstractCustomPNGAnnotationImageSegmentationReader()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected ImageReader`	`getDefaultReader()`	Returns the default image reader.
`ImageReader`	`getReader()`	Returns the imag reader to use.
`String`	`readerTipText()`	Returns the tip text for this property.
`protected BufferedImage`	`readPNG(PlaceholderFile file)`	Reads the PNG file associated with the specified JPG file.
`void`	`setReader(ImageReader value)`	Sets the image reader to use.

Methods inherited from class adams.data.io.input.AbstractPNGAnnotationImageSegmentationReader
check, doRead, doReadLayers, getDefaultFormatExtension, getFormatExtensions, getLayerNames, getLenient, getSkipFirstLayer, layerNamesTipText, lenientTipText, locatePNG, newContainer, setLayerNames, setLenient, setSkipFirstLayer, skipFirstLayerTipText

Methods inherited from class adams.data.io.input.AbstractImageSegmentationAnnotationReader
getCorrespondingWriter, read

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.input.ImageSegmentationAnnotationReader
getCorrespondingWriter, read

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

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

- Field Detail
  - m_Reader
```
protected ImageReader m_Reader
```
    the image reader for the PNG.
- Constructor Detail
  - AbstractCustomPNGAnnotationImageSegmentationReader
```
public AbstractCustomPNGAnnotationImageSegmentationReader()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractPNGAnnotationImageSegmentationReader
  - getDefaultReader
```
protected ImageReader getDefaultReader()
```
    Returns the default image reader.
    
    Returns:
    
    the default
  - setReader
```
public void setReader(ImageReader value)
```
    Sets the image reader to use.
    
    Parameters:
    
    value - the image reader
  - getReader
```
public ImageReader getReader()
```
    Returns the imag reader to use.
    
    Returns:
    
    the image reader
  - readerTipText
```
public String readerTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the gui
  - readPNG
```
protected BufferedImage readPNG(PlaceholderFile file)
```
    Reads the PNG file associated with the specified JPG file.
    
    Parameters:
    
    file - the JPG file to load the PNG file for
    
    Returns:
    
    the image