Package org.anchoranalysis.image.feature.bean

Class FeatureImageMetadata

Object

AnchorBean<Feature<FeatureInputImageMetadata>>

InitializableBean<Feature<FeatureInputImageMetadata>,FeatureInitialization>

Feature<FeatureInputImageMetadata>

FeatureImageMetadata

Direct Known Subclasses:

BitDepthPerChannel, NumberChannels, NumberFrames, NumberResolutionLevels, NumberSeries

public abstract class FeatureImageMetadata
extends Feature<FeatureInputImageMetadata>

A base class for a feature that accepts a FeatureInputImageMetadata as input.

Constructor Summary

Constructors

Constructor	Description
FeatureImageMetadata()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputImageMetadata> input)	Calculates a value for some input.
abstract double	calculate(ImageMetadata metadata)	Calculates the feature-value for a given ImageMetadata.
Class<? extends FeatureInput>	inputType()	The class corresponding to feature input-type.

Methods inherited from class org.anchoranalysis.feature.bean.Feature

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, describeParameters, descriptionLong, duplicateChangeName, getCustomName, getFriendlyName, onInitialization, setCustomName, toString

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

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

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise

Methods inherited from class java.lang.Object

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

Constructor Details

FeatureImageMetadata

public FeatureImageMetadata()

Method Details

calculate

public double calculate(FeatureCalculationInput<FeatureInputImageMetadata> input)
                 throws FeatureCalculationException

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<FeatureInputImageMetadata>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

calculate

public abstract double calculate(ImageMetadata metadata)
                          throws FeatureCalculationException

Calculates the feature-value for a given ImageMetadata.

Parameters:

metadata - the metadata.

Returns:

the calculated feature-value.

Throws:

FeatureCalculationException - if the feature-value cannot be calculated.

inputType

public Class<? extends FeatureInput> inputType()

Description copied from class: Feature

The class corresponding to feature input-type.

i.e. corresponding to the T template parameter.

Specified by:

inputType in class Feature<FeatureInputImageMetadata>

Returns:

the class.