Package org.anchoranalysis.plugin.image.bean.scale

Class MinimumXYResolution

Object

AnchorBean<ScaleCalculator>

InitializableBean<ScaleCalculator,ImageInitialization>

ImageBean<ScaleCalculator>

ScaleCalculator

MinimumXYResolution

public class MinimumXYResolution
extends ScaleCalculator

Calculates a scale factor to ensure a minimum XY resolution is achieved.

Constructor Summary

Constructors

Constructor	Description
MinimumXYResolution()

Method Summary

Modifier and Type	Method	Description
ScaleFactor	calculate(Optional<Dimensions> dimensionsToBeScaled, Optional<ImageSizeSuggestion> suggestedSize)	Calculates a scaling-factor for a source image/entity of particular dimensions.
double	getMinResolution()	The minimum resolution to achieve in meters.
void	setMinResolution(double minResolution)	The minimum resolution to achieve in meters.

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

MinimumXYResolution

public MinimumXYResolution()

Method Details

calculate

public ScaleFactor calculate(Optional<Dimensions> dimensionsToBeScaled,
 Optional<ImageSizeSuggestion> suggestedSize)
                      throws OperationFailedException

Description copied from class: ScaleCalculator

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

Specified by:

calculate in class ScaleCalculator

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.

getMinResolution

public double getMinResolution()

The minimum resolution to achieve in meters.

setMinResolution

public void setMinResolution(double minResolution)

The minimum resolution to achieve in meters.