AddCriteriaNever (anchor-mpp-feature 0.2.1 API)

org.anchoranalysis.mpp.feature.addcriteria.AddCriteriaNever<T>

Type Parameters:: T - the type of edge that would be generated (if any were generated)

All Implemented Interfaces:: AddCriteria<T>, OrderedFeatureList<FeatureInputPairMemo>

public class AddCriteriaNever<T>
extends Object
implements AddCriteria<T>

An implementation of AddCriteria that never adds an edge between marks.

This class always returns an empty Optional for generateEdge, effectively preventing any edges from being created.

Author:: Owen Feehan

Constructor Summary

Constructors

Constructor Description

AddCriteriaNever()

Method Summary

Modifier and Type	Method	Description
`Optional<T>`	`generateEdge(VoxelizedMarkMemo mark1, VoxelizedMarkMemo mark2, EnergyStack energyStack, Optional<FeatureCalculatorMulti<FeatureInputPairMemo>> session, boolean do3D)`	Generates an edge between two marks based on the defined criteria.
`Optional<FeatureList<FeatureInputPairMemo>>`	`orderedListOfFeatures()`	Retrieves an ordered list of features used to determine the `AddCriteria`.

Methods inherited from class java.lang.Object

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

Constructor Details
- AddCriteriaNever
  
  public AddCriteriaNever()
Method Details
- generateEdge
  
  public Optional<T> 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<T>
  
  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
- orderedListOfFeatures
  
  public Optional<FeatureList<FeatureInputPairMemo>> orderedListOfFeatures()
  
  Description copied from interface: OrderedFeatureList
  
  Retrieves an ordered list of features used to determine the AddCriteria.
  
  Specified by:
  
  orderedListOfFeatures in interface OrderedFeatureList<T>
  
  Returns:
  
  an Optional containing a FeatureList of type T if relevant, or Optional.empty() if irrelevant