Package org.anchoranalysis.image.feature.bean.physical

Class FeatureConvertUnits<T extends FeatureInputWithResolution>

Object

org.anchoranalysis.bean.AnchorBean<B>

org.anchoranalysis.bean.initializable.InitializableBean<Feature<T>,FeatureInitialization>

org.anchoranalysis.feature.bean.Feature<T>

org.anchoranalysis.feature.bean.operator.FeatureUnary<T,T>

org.anchoranalysis.feature.bean.operator.FeatureUnaryGeneric<T>

org.anchoranalysis.image.feature.bean.physical.WithResolutionBase<T>

org.anchoranalysis.image.feature.bean.physical.FeatureConvertUnits<T>

Type Parameters:

T - the type of feature input, which must include resolution information

Direct Known Subclasses:

ConvertFromPhysicalVolume, ConvertToPhysicalAreaXY, ConvertToPhysicalDistance, ConvertToPhysicalVolume

public abstract class FeatureConvertUnits<T extends FeatureInputWithResolution>
extends WithResolutionBase<T>

An abstract base class for features that convert units between physical and voxel space.

This class provides a framework for converting feature values between different unit systems, typically between voxel-based measurements and physical measurements (e.g., micrometers).

Constructor Summary

Constructors

Modifier	Constructor	Description
	FeatureConvertUnits()
protected	FeatureConvertUnits(Feature<T> feature, SpatialUnits.UnitSuffix unitType)	Constructs a FeatureConvertUnits with a specified feature and unit type.

Method Summary

Modifier and Type	Method	Description
protected double	calculateWithResolution(double value, Resolution resolution)	Calculates the feature value with resolution information.
protected abstract double	convertToPhysical(double value, UnitConverter unitConverter)	Converts the input value to physical units.
String	getUnitType()	The type of unit to convert to, represented as a string (e.g., "um" for micrometers).
void	setUnitType(String unitType)	The type of unit to convert to, represented as a string (e.g., "um" for micrometers).

Methods inherited from class org.anchoranalysis.image.feature.bean.physical.WithResolutionBase

calculate, isAcceptMissingResolution, setAcceptMissingResolution

Methods inherited from class org.anchoranalysis.feature.bean.operator.FeatureUnary

getItem, inputType, setItem

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

FeatureConvertUnits

protected FeatureConvertUnits(Feature<T> feature, SpatialUnits.UnitSuffix unitType)

Constructs a FeatureConvertUnits with a specified feature and unit type.

Parameters:

feature - the feature to be converted

unitType - the type of unit to convert to

FeatureConvertUnits

public FeatureConvertUnits()

Method Details

calculateWithResolution

protected double calculateWithResolution(double value, Resolution resolution) throws FeatureCalculationException

Calculates the feature value with resolution information.

Specified by:

calculateWithResolution in class WithResolutionBase<T extends FeatureInputWithResolution>

Parameters:

value - the input value to be converted

resolution - the resolution information for the conversion

Returns:

the converted value

Throws:

FeatureCalculationException - if an error occurs during the calculation

convertToPhysical

protected abstract double convertToPhysical(double value, UnitConverter unitConverter) throws FeatureCalculationException

Converts the input value to physical units.

Parameters:

value - the input value to be converted

unitConverter - the unit converter to use for the conversion

Returns:

the converted value in physical units

Throws:

FeatureCalculationException - if an error occurs during the conversion

getUnitType

public String getUnitType()

The type of unit to convert to, represented as a string (e.g., "um" for micrometers).

setUnitType

public void setUnitType(String unitType)

The type of unit to convert to, represented as a string (e.g., "um" for micrometers).