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

Class ComparableSource

Object

AnchorBean<ComparableSource>

ComparableSource

Direct Known Subclasses:

MaskAsObject, Objects

public abstract class ComparableSource
extends 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<ObjectCollection>	loadAsObjects(Path reference, Dimensions dimensions, boolean debugMode, 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

ComparableSource

public ComparableSource()

Method Details

loadAsObjects

public abstract Findable<ObjectCollection> loadAsObjects(Path reference,
 Dimensions dimensions,
 boolean debugMode,
 OperationContext context)
                                                  throws 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:

InputReadFailedException - if the objects cannot be successfully loaded.