Package org.anchoranalysis.annotation.io.bean.comparer

Class ComparableSource

Object
org.anchoranalysis.bean.AnchorBean<ComparableSource>
org.anchoranalysis.annotation.io.bean.comparer.ComparableSource
public abstract class ComparableSource
extends org.anchoranalysis.bean.AnchorBean<ComparableSource>
A set of elements, loaded from the file-system, to be compared to another set.

The source may or not be a ObjectCollection, but it is converted into a ObjectCollection to be compared to another set (as a common basis for comparison between different source types).

Author:
Owen Feehan

  • Constructor Summary

    Constructors 
    Constructor Description
    ComparableSource()  

  • Method Summary

    Modifier and Type Method Description
    abstract Findable<org.anchoranalysis.image.voxel.object.ObjectCollection> loadAsObjects​(Path reference, org.anchoranalysis.image.core.dimensions.Dimensions dimensions, boolean debugMode, org.anchoranalysis.core.time.OperationContext context)
    Loads the source of elements from the file-system and converts to a ObjectCollection.

    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

  • Method Details

    • loadAsObjects

      public abstract Findable<org.anchoranalysis.image.voxel.object.ObjectCollection> loadAsObjects​(Path reference, org.anchoranalysis.image.core.dimensions.Dimensions dimensions, boolean debugMode, org.anchoranalysis.core.time.OperationContext context) throws org.anchoranalysis.io.input.InputReadFailedException
      Loads the source of elements from the file-system and converts to a ObjectCollection.

      The location of elements on the file-system may be derived from a reference path.

      Parameters:
      reference - the source file-path used to help identify where elements are located on the file-system.
      dimensions - how large the scene is, in which elements are being compared. This is usually the same as the image-size.
      debugMode - true if debug-mode is activated, which can influence paths on the file-system.
      context - records the execution time of certain operations.
      Returns:
      the elements converted into a ObjectCollection and wrapped into a Findable element that indicates if they were successfully found on the file-system.
      Throws:
      org.anchoranalysis.io.input.InputReadFailedException - if the objects cannot be successfully loaded.