AbstractImageSegmentationContainerFilter (adams-pom 24.10.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.imagesegmentation.filter.AbstractImageSegmentationContainerFilter

All Implemented Interfaces:

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

Direct Known Subclasses:

Draw, MergeLayers, MultiFilter, PassThrough, RemoveOverlaps
```
public abstract class AbstractImageSegmentationContainerFilter
extends AbstractOptionHandler
```
Ancestor for filters for image segmentation containers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- 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

AbstractImageSegmentationContainerFilter()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`check(ImageSegmentationContainer cont)`	Hook method for checking the container before filtering.
`protected abstract ImageSegmentationContainer`	`doFilter(ImageSegmentationContainer cont)`	Performs the filtering of the container.
`ImageSegmentationContainer`	`filter(ImageSegmentationContainer cont)`	Performs the filtering of the container.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, 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.logging.LoggingLevelHandler
getLoggingLevel

- Constructor Detail
  - AbstractImageSegmentationContainerFilter
```
public AbstractImageSegmentationContainerFilter()
```
- Method Detail
  - check
```
protected String check(ImageSegmentationContainer cont)
```
    Hook method for checking the container before filtering.
    
    Parameters:
    
    cont - the container to check
    
    Returns:
    
    null if checks passed, otherwise error message
  - doFilter
```
protected abstract ImageSegmentationContainer doFilter(ImageSegmentationContainer cont)
```
    Performs the filtering of the container.
    
    Parameters:
    
    cont - the container to filter
    
    Returns:
    
    the filtered container
  - filter
```
public ImageSegmentationContainer filter(ImageSegmentationContainer cont)
```
    Performs the filtering of the container.
    
    Parameters:
    
    cont - the container to filter
    
    Returns:
    
    the filtered container