Package org.anchoranalysis.image.bean.spatial

Class ScaleCalculator

Object

org.anchoranalysis.bean.AnchorBean<B>

org.anchoranalysis.bean.initializable.InitializableBean<T,ImageInitialization>

org.anchoranalysis.image.bean.ImageBean<ScaleCalculator>

org.anchoranalysis.image.bean.spatial.ScaleCalculator

public abstract class ScaleCalculator
extends ImageBean<ScaleCalculator>

Calculating a scaling-factor from dimensions.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ScaleCalculator()

Method Summary

Modifier and Type	Method	Description
abstract org.anchoranalysis.spatial.scale.ScaleFactor	calculate(Optional<Dimensions> dimensionsToBeScaled, Optional<ImageSizeSuggestion> suggestedSize)	Calculates a scaling-factor for a source image/entity of particular dimensions.

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

ScaleCalculator

public ScaleCalculator()

Method Details

calculate

public abstract org.anchoranalysis.spatial.scale.ScaleFactor calculate(Optional<Dimensions> dimensionsToBeScaled, Optional<ImageSizeSuggestion> suggestedSize) throws OperationFailedException

Calculates a scaling-factor for a source image/entity of particular dimensions.

Parameters:

dimensionsToBeScaled - dimensions of the source image/entity that will be scaled, if they are known.

suggestedSize - a string suggesting dimensions to resize to or a scaling-factor.

Returns:

the scaling-factor to use.

Throws:

OperationFailedException - if a scale-factor cannot be successfully calculated.