Package org.anchoranalysis.mpp.feature.addcriteria

Class AddCriteriaPair

Object

AnchorBean<AddCriteriaPair>

AddCriteriaPair

All Implemented Interfaces:

AddCriteria<MarkPair<Mark>>, OrderedFeatureList<FeatureInputPairMemo>

Direct Known Subclasses:

AddCriteriaOr, ArbitraryPointCommon, BoundingBoxIntersection

public abstract class AddCriteriaPair
extends AnchorBean<AddCriteriaPair>
implements AddCriteria<MarkPair<Mark>>

Abstract base class for criteria used to determine if a pair of marks should be included.

This class implements AddCriteria for MarkPairs of Marks.

Constructor Summary

Constructors

Constructor	Description
AddCriteriaPair()

Method Summary

Modifier and Type	Method	Description
String	describeBean()	A (maybe longer) description identifying the bean and perhaps its key parameters.
Optional<MarkPair<Mark>>	generateEdge(VoxelizedMarkMemo mark1, VoxelizedMarkMemo mark2, EnergyStack energyStack, Optional<FeatureCalculatorMulti<FeatureInputPairMemo>> session, boolean do3D)	Generates an edge between two marks based on the defined criteria.
abstract boolean	includeMarks(VoxelizedMarkMemo mark1, VoxelizedMarkMemo mark2, Dimensions dimensions, Optional<FeatureCalculatorMulti<FeatureInputPairMemo>> session, boolean do3D)	Determines whether to include a pair of marks based on specific criteria.

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, 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

Methods inherited from interface org.anchoranalysis.mpp.feature.addcriteria.OrderedFeatureList

orderedListOfFeatures

Constructor Details

AddCriteriaPair

public AddCriteriaPair()

Method Details

generateEdge

public Optional<MarkPair<Mark>> generateEdge(VoxelizedMarkMemo mark1,
 VoxelizedMarkMemo mark2,
 EnergyStack energyStack,
 Optional<FeatureCalculatorMulti<FeatureInputPairMemo>> session,
 boolean do3D)
                                      throws CreateException

Description copied from interface: AddCriteria

Generates an edge between two marks based on the defined criteria.

Specified by:

generateEdge in interface AddCriteria<MarkPair<Mark>>

Parameters:

mark1 - the first VoxelizedMarkMemo

mark2 - the second VoxelizedMarkMemo

energyStack - the EnergyStack containing image data and parameters

session - an optional FeatureCalculatorMulti for feature calculations

do3D - whether to perform 3D calculations

Returns:

an Optional containing the generated edge of type T if criteria are met, otherwise empty

Throws:

CreateException - if there's an error during edge generation

includeMarks

public abstract boolean includeMarks(VoxelizedMarkMemo mark1,
 VoxelizedMarkMemo mark2,
 Dimensions dimensions,
 Optional<FeatureCalculatorMulti<FeatureInputPairMemo>> session,
 boolean do3D)
                              throws IncludeMarksFailureException

Determines whether to include a pair of marks based on specific criteria.

Parameters:

mark1 - the first VoxelizedMarkMemo

mark2 - the second VoxelizedMarkMemo

dimensions - the Dimensions of the image

session - an optional FeatureCalculatorMulti for feature calculations

do3D - whether to perform 3D calculations

Returns:

true if the marks should be included, false otherwise

Throws:

IncludeMarksFailureException - if there's an error during the inclusion decision process

describeBean

public String describeBean()

Description copied from class: AnchorBean

A (maybe longer) description identifying the bean and perhaps its key parameters.

By default, it returns the same as AnchorBean.getBeanName() but beans can optionally override it

Overrides:

describeBean in class AnchorBean<AddCriteriaPair>

Returns:

either the short-name of the bean, or a longer description