Class ObjectFilterRelation

Object
AnchorBean<ObjectFilter>
InitializableBean<ObjectFilter, ImageInitialization>
ImageBean<ObjectFilter>
ObjectFilter
ObjectFilterPredicate
ObjectFilterRelation
Direct Known Subclasses:
RelationWithMatches, ThresholdedFeature, ThresholdedVolume
public abstract class ObjectFilterRelation extends ObjectFilterPredicate
An independent object-filter that uses a relation in its predicate.
Author:
Owen Feehan

  • Constructor Summary

    Constructors
    Constructor
    Description
    ObjectFilterRelation()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    end()
    Performs any necessary cleanup after filtering is complete.
    RelationBean
    getRelation()
    The relation to be used in the filter predicate.
    protected boolean
    match(ObjectMask object, Optional<Dimensions> dimensions)
    A predicate condition for an object to be kept in the collection.
    protected abstract boolean
    match(ObjectMask object, Optional<Dimensions> dim, DoubleBiPredicate relation)
    Performs the matching operation using the resolved relation.
    protected boolean
    precondition(ObjectCollection objectsToFilter)
    A precondition, which if evaluates to false, cancels the filter i.e.
    void
    setRelation(RelationBean relation)
    The relation to be used in the filter predicate.
    protected void
    start(Optional<Dimensions> dimensions, ObjectCollection objectsToFilter)
    Performs any necessary initialization before filtering begins.

    Methods inherited from class org.anchoranalysis.plugin.image.bean.object.filter.ObjectFilterPredicate

    filter

    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

    • ObjectFilterRelation

      public ObjectFilterRelation()

  • Method Details

    • precondition

      protected boolean precondition(ObjectCollection objectsToFilter)
      Description copied from class: ObjectFilterPredicate
      A precondition, which if evaluates to false, cancels the filter i.e. nothing is removed.
      Specified by:
      precondition in class ObjectFilterPredicate
      Parameters:
      objectsToFilter - the ObjectCollection to be filtered
      Returns:
      true if the filter should be applied, false otherwise

    • start

      protected void start(Optional<Dimensions> dimensions, ObjectCollection objectsToFilter) throws OperationFailedException
      Description copied from class: ObjectFilterPredicate
      Performs any necessary initialization before filtering begins.
      Overrides:
      start in class ObjectFilterPredicate
      Parameters:
      dimensions - optional Dimensions of the objects
      objectsToFilter - the ObjectCollection to be filtered
      Throws:
      OperationFailedException - if the initialization fails

    • match

      protected boolean match(ObjectMask object, Optional<Dimensions> dimensions) throws OperationFailedException
      Description copied from class: ObjectFilterPredicate
      A predicate condition for an object to be kept in the collection.
      Specified by:
      match in class ObjectFilterPredicate
      Parameters:
      object - the ObjectMask to be evaluated
      dimensions - optional Dimensions of the object
      Returns:
      true if the object should be kept, false otherwise
      Throws:
      OperationFailedException - if the matching operation fails

    • match

      protected abstract boolean match(ObjectMask object, Optional<Dimensions> dim, DoubleBiPredicate relation) throws OperationFailedException
      Performs the matching operation using the resolved relation.
      Parameters:
      object - the ObjectMask to be evaluated
      dim - optional Dimensions of the object
      relation - the resolved DoubleBiPredicate relation
      Returns:
      true if the object matches the criteria, false otherwise
      Throws:
      OperationFailedException - if the matching operation fails

    • end

      protected void end() throws OperationFailedException
      Description copied from class: ObjectFilterPredicate
      Performs any necessary cleanup after filtering is complete.
      Specified by:
      end in class ObjectFilterPredicate
      Throws:
      OperationFailedException - if the cleanup operation fails

    • getRelation

      public RelationBean getRelation()
      The relation to be used in the filter predicate.

    • setRelation

      public void setRelation(RelationBean relation)
      The relation to be used in the filter predicate.