Class ObjectFilter

Object

AnchorBean<ObjectFilter>

InitializableBean<ObjectFilter, ImageInitialization>

ImageBean<ObjectFilter>

ObjectFilter

public abstract class ObjectFilter
extends ImageBean<ObjectFilter>

Base class for filtering an ObjectCollection to remove objects according to a criteria.

The filtering criteria is implemented by overriding a method in a sub-class.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ObjectFilter()

Method Summary

Modifier and Type	Method	Description
abstract ObjectCollection	filter(ObjectCollection objectsToFilter, Optional<Dimensions> dimensions)	Filters an ObjectCollection to remove objects.

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ObjectFilter

public ObjectFilter()

Method Details

filter

public abstract ObjectCollection filter(ObjectCollection objectsToFilter,
 Optional<Dimensions> dimensions)
                                 throws OperationFailedException

Filters an ObjectCollection to remove objects.

Parameters:

objectsToFilter - the objects to filter.

dimensions - image-dimensions.

Returns:

a new object-collection containing only the objects that passed the filter.

Throws:

OperationFailedException - if the operation cannot complete successfully.