Package org.anchoranalysis.feature.input

Interface FeatureInputWithResolution

All Superinterfaces:

FeatureInput

All Known Subinterfaces:

FeatureInputDictionary

All Known Implementing Classes:

FeatureInputAllMemo, FeatureInputDimensions, FeatureInputEnergy, FeatureInputHistogram, FeatureInputImageMetadata, FeatureInputMark, FeatureInputMarkCollection, FeatureInputObjectCollection, FeatureInputPairMemo, FeatureInputPairObjects, FeatureInputSingleMemo, FeatureInputSingleObject, FeatureInputStack

public interface FeatureInputWithResolution
extends FeatureInput

A FeatureInput that exposes the Resolution of an image or scene.

Author:

Owen Feehan

Method Summary

Modifier and Type	Method	Description
Optional<Resolution>	getResolutionOptional()	The resolution of the associated image, if it is available.
default Resolution	getResolutionRequired()	The resolution of the associated image, or an exception if it is not available.

Method Details

getResolutionOptional

Optional<Resolution> getResolutionOptional()

The resolution of the associated image, if it is available.

Returns:

the resolution, if it is available.

getResolutionRequired

default Resolution getResolutionRequired()
                                  throws FeatureCalculationException

The resolution of the associated image, or an exception if it is not available.

Returns:

the resolution.

Throws:

FeatureCalculationException - if the resolution is not available.