Package org.anchoranalysis.image.feature.calculator

Class SingleTableCalculator

Object

SingleTableCalculator

All Implemented Interfaces:

FeatureCalculatorMulti<FeatureInputSingleObject>, FeatureTableCalculator<FeatureInputSingleObject>

public class SingleTableCalculator
extends Object
implements FeatureTableCalculator<FeatureInputSingleObject>

A feature table calculator for single objects.

This class implements the FeatureTableCalculator interface for FeatureInputSingleObject, providing methods to calculate features for single objects and manage the feature calculation process.

Constructor Summary

Constructors

Constructor	Description
SingleTableCalculator(NamedFeatureStore<FeatureInputSingleObject> namedFeatureStore)	Creates a new SingleTableCalculator instance.

Method Summary

Modifier and Type	Method	Description
ResultsVector	calculate(FeatureInputSingleObject input)	Calculate the results of the features with a particular input.
ResultsVector	calculate(FeatureInputSingleObject input, FeatureList<FeatureInputSingleObject> featuresSubset)	Calculates the results of a subset of the features with a particular input.
ResultsVector	calculateSuppressErrors(FeatureInputSingleObject input, ErrorReporter errorReporter)	Calculates the results for an input recording the error to an ErrorReporter if anything goes wrong, but throwing no exception.
FeatureNameList	createFeatureNames()	Creates a list of names for each feature (columns of the table).
FeatureTableCalculator<FeatureInputSingleObject>	duplicateForNewThread()	Makes a copy of the feature-store for a new thread.
int	sizeFeatures()	The number of features that is calculated on each call to FeatureCalculatorMulti.calculate(T), and therefore the size of the returned ResultsVector.
void	start(ImageInitialization initialization, Optional<EnergyStack> energyStack, Logger logger)	Initializes a feature store that has the same structure as that previously created by createFeatures() from the same object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.feature.calculate.bound.FeatureCalculatorMulti

calculate

Constructor Details

SingleTableCalculator

public SingleTableCalculator(NamedFeatureStore<FeatureInputSingleObject> namedFeatureStore)

Creates a new SingleTableCalculator instance.

Parameters:

namedFeatureStore - The named feature store containing features for single objects.

Method Details

start

public void start(ImageInitialization initialization,
 Optional<EnergyStack> energyStack,
 Logger logger)
           throws InitializeException

Description copied from interface: FeatureTableCalculator

Initializes a feature store that has the same structure as that previously created by createFeatures() from the same object.

Specified by:

start in interface FeatureTableCalculator<FeatureInputSingleObject>

Parameters:

initialization - the image initialization context

energyStack - an optional energy stack for feature calculation

logger - a logger for reporting initialization progress or errors

Throws:

InitializeException - if initialization fails

duplicateForNewThread

public FeatureTableCalculator<FeatureInputSingleObject> duplicateForNewThread()

Description copied from interface: FeatureTableCalculator

Makes a copy of the feature-store for a new thread.

Deep-copies the features. Shallow-copies everything else.

Specified by:

duplicateForNewThread in interface FeatureTableCalculator<FeatureInputSingleObject>

Returns:

the copied feature-store

calculate

public ResultsVector calculate(FeatureInputSingleObject input)
                        throws NamedFeatureCalculateException

Description copied from interface: FeatureCalculatorMulti

Calculate the results of the features with a particular input.

Specified by:

calculate in interface FeatureCalculatorMulti<FeatureInputSingleObject>

Parameters:

input - the input to calculate.

Returns:

the results of the calculation.

Throws:

NamedFeatureCalculateException - if any feature cannot be successfully calculated.

calculate

public ResultsVector calculate(FeatureInputSingleObject input,
 FeatureList<FeatureInputSingleObject> featuresSubset)
                        throws NamedFeatureCalculateException

Description copied from interface: FeatureCalculatorMulti

Calculates the results of a subset of the features with a particular input.

Specified by:

calculate in interface FeatureCalculatorMulti<FeatureInputSingleObject>

Parameters:

input - the input to calculate.

featuresSubset - the subset of features (from those bound to the current instance) to calculate with.

Returns:

the results of the calculation.

Throws:

NamedFeatureCalculateException - if any feature cannot be successfully calculated.

calculateSuppressErrors

public ResultsVector calculateSuppressErrors(FeatureInputSingleObject input,
 ErrorReporter errorReporter)

Description copied from interface: FeatureCalculatorMulti

Calculates the results for an input recording the error to an ErrorReporter if anything goes wrong, but throwing no exception.

Specified by:

calculateSuppressErrors in interface FeatureCalculatorMulti<FeatureInputSingleObject>

Parameters:

input - the input to calculate.

errorReporter - where errors are recorded.

Returns:

the results of the calculation.

sizeFeatures

public int sizeFeatures()

Description copied from interface: FeatureCalculatorMulti

The number of features that is calculated on each call to FeatureCalculatorMulti.calculate(T), and therefore the size of the returned ResultsVector.

Specified by:

sizeFeatures in interface FeatureCalculatorMulti<FeatureInputSingleObject>

Returns:

the number of features.

createFeatureNames

public FeatureNameList createFeatureNames()

Description copied from interface: FeatureTableCalculator

Creates a list of names for each feature (columns of the table).

Specified by:

createFeatureNames in interface FeatureTableCalculator<FeatureInputSingleObject>

Returns:

the list of feature names