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

Class ToDimensions

Object

AnchorBean<ScaleCalculator>

InitializableBean<ScaleCalculator,ImageInitialization>

ImageBean<ScaleCalculator>

ScaleCalculator

ToDimensions

public class ToDimensions
extends ScaleCalculator

Calculates a scaling-factor to make the source image have identical dimensions as dimensionsTarget.

If preserveAspectRatio is true, then the aspect ratio is preserved, and both dimensions may not be identical to dimensionsTarget, but at least one will be, and the other will not be exceed that of dimensionsTarget.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ToDimensions()
ToDimensions(int sizeX, int sizeY)	Create with specific lengths for X and Y dimensions.
ToDimensions(int sizeX, int sizeY, boolean preserveAspectRatio)	Create with specific lengths for X and Y dimensions and preserveAspectRatio.
ToDimensions(DimensionsProvider dimensions)	Create with specific dimensions.
ToDimensions(DimensionsProvider dimensions, boolean preserveAspectRatio)	Create with specific dimensions and preserveAspectRatio.

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.
DimensionsProvider	getDimensions()	The dimensions the source image/entity is desired to be scaled to.
DimensionsProvider	getDimensionsSourceFallback()	Source dimensions used as a fallback, if they are not passed as parameter to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).
boolean	isPreserveAspectRatio()	If true, the ratio between x and y is kept constant when scaling.
void	setDimensions(DimensionsProvider dimensions)	The dimensions the source image/entity is desired to be scaled to.
void	setDimensionsSourceFallback(DimensionsProvider dimensionsSourceFallback)	Source dimensions used as a fallback, if they are not passed as parameter to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).
void	setPreserveAspectRatio(boolean preserveAspectRatio)	If true, the ratio between x and y is kept constant when scaling.

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

ToDimensions

public ToDimensions(int sizeX,
 int sizeY)

Create with specific lengths for X and Y dimensions.

Parameters:

sizeX - the size of the X-dimension.

sizeY - the size of the X-dimension.

ToDimensions

public ToDimensions(DimensionsProvider dimensions)

Create with specific dimensions.

Parameters:

dimensions - the dimensions the source image/entity is desired to be scaled to.

ToDimensions

public ToDimensions(int sizeX,
 int sizeY,
 boolean preserveAspectRatio)

Create with specific lengths for X and Y dimensions and preserveAspectRatio.

Parameters:

sizeX - the size of the X-dimension.

sizeY - the size of the X-dimension.

preserveAspectRatio - if true, the ratio between x and y is kept constant when scaling.

ToDimensions

public ToDimensions(DimensionsProvider dimensions,
 boolean preserveAspectRatio)

Create with specific dimensions and preserveAspectRatio.

Parameters:

dimensions - the dimensions the source image/entity is desired to be scaled to.

preserveAspectRatio - if true, the ratio between x and y is kept constant when scaling.

ToDimensions

public ToDimensions()

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.

getDimensions

public DimensionsProvider getDimensions()

The dimensions the source image/entity is desired to be scaled to.

setDimensions

public void setDimensions(DimensionsProvider dimensions)

The dimensions the source image/entity is desired to be scaled to.

getDimensionsSourceFallback

public DimensionsProvider getDimensionsSourceFallback()

Source dimensions used as a fallback, if they are not passed as parameter to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).

setDimensionsSourceFallback

public void setDimensionsSourceFallback(DimensionsProvider dimensionsSourceFallback)

Source dimensions used as a fallback, if they are not passed as parameter to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).

isPreserveAspectRatio

public boolean isPreserveAspectRatio()

If true, the ratio between x and y is kept constant when scaling.

The larger dimension is will be scaled to be the same as dimensionsTarget and the the smaller dimension is guaranteed to be equal to or lesser than its equivalent in dimensionsTarget.

setPreserveAspectRatio

public void setPreserveAspectRatio(boolean preserveAspectRatio)

If true, the ratio between x and y is kept constant when scaling.

The larger dimension is will be scaled to be the same as dimensionsTarget and the the smaller dimension is guaranteed to be equal to or lesser than its equivalent in dimensionsTarget.