Package org.anchoranalysis.plugin.image.feature.bean.list.pair

Class FeatureListProviderAggregatePair

Object

AnchorBean<FeatureListProvider<FeatureInputPairObjects>>

InitializableBean<FeatureListProvider<FeatureInputPairObjects>,FeatureRelatedInitialization>

FeatureRelatedBean<FeatureListProvider<FeatureInputPairObjects>>

FeatureProviderBean<FeatureListProvider<FeatureInputPairObjects>,FeatureList<FeatureInputPairObjects>>

FeatureListProvider<FeatureInputPairObjects>

FeatureListProviderAggregatePair

All Implemented Interfaces:

Provider<FeatureList<FeatureInputPairObjects>>

Direct Known Subclasses:

ReduceFirstAndSecond, ReduceRatioFirstAndSecond, SubtractReducedFromMerged

public abstract class FeatureListProviderAggregatePair
extends FeatureListProvider<FeatureInputPairObjects>

Calculates features on each part of a pair (first, second, merged etc.) and then reduces the calculation to a single number.

Specifically, each feature is calculated for the first, second, merged parts of the pair, then "reduced" into a single feature-value.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FeatureListProviderAggregatePair()

Method Summary

Modifier and Type	Method	Description
protected abstract Feature<FeatureInputPairObjects>	createAggregateFeature(Feature<FeatureInputPairObjects> first, Feature<FeatureInputPairObjects> second, Feature<FeatureInputPairObjects> merged)	Creates an aggregate feature from individual features for first, second, and merged objects.
protected FeatureFromList<FeatureInputPairObjects>	createReducedFeature(Feature<FeatureInputPairObjects> first, Feature<FeatureInputPairObjects> second)	Creates a reduced feature from features for the first and second objects.
FeatureList<FeatureInputPairObjects>	get()	Gets or creates an object of type T.
FeatureListProvider<FeatureInputSingleObject>	getItem()	For each feature in the list, a corresponding aggregate feature is created in the output list.
String	getPrefix()	The string to prepend.
FeatureFromList<FeatureInputPairObjects>	getReduce()	Method for reducing all pairs into a single value e.g.
void	setItem(FeatureListProvider<FeatureInputSingleObject> item)	For each feature in the list, a corresponding aggregate feature is created in the output list.
void	setPrefix(String prefix)	The string to prepend.
void	setReduce(FeatureFromList<FeatureInputPairObjects> reduce)	Method for reducing all pairs into a single value e.g.

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

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

FeatureListProviderAggregatePair

public FeatureListProviderAggregatePair()

Method Details

get

public FeatureList<FeatureInputPairObjects> get()
                                         throws ProvisionFailedException

Description copied from interface: Provider

Gets or creates an object of type T.

Returns:

the object returned by the provider.

Throws:

ProvisionFailedException - if the object cannot be returned.

createAggregateFeature

protected abstract Feature<FeatureInputPairObjects> createAggregateFeature(Feature<FeatureInputPairObjects> first,
 Feature<FeatureInputPairObjects> second,
 Feature<FeatureInputPairObjects> merged)

Creates an aggregate feature from individual features for first, second, and merged objects.

Parameters:

first - feature for the first object

second - feature for the second object

merged - feature for the merged object

Returns:

an aggregate feature combining the three input features

createReducedFeature

protected FeatureFromList<FeatureInputPairObjects> createReducedFeature(Feature<FeatureInputPairObjects> first,
 Feature<FeatureInputPairObjects> second)

Creates a reduced feature from features for the first and second objects.

Parameters:

first - feature for the first object

second - feature for the second object

Returns:

a FeatureFromList that reduces the two input features

getItem

public FeatureListProvider<FeatureInputSingleObject> getItem()

For each feature in the list, a corresponding aggregate feature is created in the output list.

setItem

public void setItem(FeatureListProvider<FeatureInputSingleObject> item)

For each feature in the list, a corresponding aggregate feature is created in the output list.

getPrefix

public String getPrefix()

The string to prepend.

setPrefix

public void setPrefix(String prefix)

The string to prepend.

getReduce

public FeatureFromList<FeatureInputPairObjects> getReduce()

Method for reducing all pairs into a single value e.g. Mean, Max, Min etc.

setReduce

public void setReduce(FeatureFromList<FeatureInputPairObjects> reduce)

Method for reducing all pairs into a single value e.g. Mean, Max, Min etc.