Package org.anchoranalysis.feature.input

Class FeatureInputEnergy

Object

FeatureInputDimensions

FeatureInputEnergy

All Implemented Interfaces:

FeatureInput, FeatureInputDictionary, FeatureInputWithResolution

Direct Known Subclasses:

FeatureInputAllMemo, FeatureInputObjectCollection, FeatureInputPairMemo, FeatureInputPairObjects, FeatureInputSingleMemo, FeatureInputSingleObject, FeatureInputStack

public abstract class FeatureInputEnergy
extends FeatureInputDimensions
implements FeatureInputDictionary

A FeatureInputDimensions that has an optional EnergyStack associated with it.

Author:

Owen Feehan

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FeatureInputEnergy()	Creates without an associated energy-stack.
	FeatureInputEnergy(Optional<EnergyStack> energyStack)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
Dimensions	dimensions()	The dimensions of the associated image.
Optional<Dimensions>	dimensionsOptional()	The image-dimensions associated with the energy-stack, if it exists.
Dimensions	dimensionsRequired()	The image-dimensions associated with the energy-stack, or an exception if no energy-stack exists.
boolean	equals(Object o)
Optional<Dictionary>	getDictionaryOptional()	The associated dictionary, if it exists.
Optional<EnergyStack>	getEnergyStackOptional()	The associated energy-stack.
EnergyStack	getEnergyStackRequired()	The associated energy-stack or throws an exception if it isn't present.
Optional<Resolution>	getResolutionOptional()	The resolution of the associated image, if it is available.
Optional<UnitConverter>	getUnitConverterOptional()	Converts voxelized measurements to/from physical units.
int	hashCode()
void	setEnergyStack(Optional<EnergyStack> energyStack)	Assigns an optional EnergyStack to be associated with the input.
void	setEnergyStack(EnergyStack energyStack)	Assigns an EnergyStack to be associated with the input.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.anchoranalysis.feature.input.FeatureInputDictionary

getDictionaryRequired

Methods inherited from interface org.anchoranalysis.feature.input.FeatureInputWithResolution

getResolutionRequired

Constructor Details

FeatureInputEnergy

protected FeatureInputEnergy()

Creates without an associated energy-stack.

FeatureInputEnergy

public FeatureInputEnergy(Optional<EnergyStack> energyStack)

Method Details

getUnitConverterOptional

public Optional<UnitConverter> getUnitConverterOptional()

Converts voxelized measurements to/from physical units.

Returns:

a converter that will perform conversions using current resolution, if it exists.

getResolutionOptional

public Optional<Resolution> getResolutionOptional()

Description copied from interface: FeatureInputWithResolution

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

Specified by:

getResolutionOptional in interface FeatureInputWithResolution

Overrides:

getResolutionOptional in class FeatureInputDimensions

Returns:

the resolution, if it is available.

getDictionaryOptional

public Optional<Dictionary> getDictionaryOptional()

Description copied from interface: FeatureInputDictionary

The associated dictionary, if it exists.

Specified by:

getDictionaryOptional in interface FeatureInputDictionary

Returns:

the dictionary, if it exists.

dimensions

public Dimensions dimensions()
                      throws FeatureCalculationException

Description copied from class: FeatureInputDimensions

The dimensions of the associated image.

Specified by:

dimensions in class FeatureInputDimensions

Returns:

the dimensions.

Throws:

FeatureCalculationException - if the dimensions cannot be calculated.

dimensionsRequired

public Dimensions dimensionsRequired()
                              throws FeatureCalculationException

The image-dimensions associated with the energy-stack, or an exception if no energy-stack exists.

Returns:

the image-dimensions.

Throws:

FeatureCalculationException - if the dimensions are not known.

dimensionsOptional

public Optional<Dimensions> dimensionsOptional()

The image-dimensions associated with the energy-stack, if it exists.

Returns:

the image-dimensions, if it exists.

getEnergyStackRequired

public EnergyStack getEnergyStackRequired()
                                   throws FeatureCalculationException

The associated energy-stack or throws an exception if it isn't present.

Returns:

the associated energy-stack.

Throws:

FeatureCalculationException - if the energy-stack isn't present

getEnergyStackOptional

public Optional<EnergyStack> getEnergyStackOptional()

The associated energy-stack.

Returns:

the energy-stack, if present.

setEnergyStack

public void setEnergyStack(EnergyStack energyStack)

Assigns an EnergyStack to be associated with the input.

Any existing energy-stack is replaced.

Parameters:

energyStack - the energy-stack to assign.

setEnergyStack

public void setEnergyStack(Optional<EnergyStack> energyStack)

Assigns an optional EnergyStack to be associated with the input.

Any existing energy-stack state is replaced.

Parameters:

energyStack - the optional energy-stack to assign.

equals

public boolean equals(Object o)

Overrides:

equals in class FeatureInputDimensions

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class FeatureInputDimensions

hashCode

public int hashCode()

Overrides:

hashCode in class FeatureInputDimensions