public abstract class FeatureInputEnergy extends FeatureInputDimensions implements FeatureInputDictionary
FeatureInputDimensions
that has an optional EnergyStack
associated with it.Modifier | Constructor and Description |
---|---|
protected |
FeatureInputEnergy()
Creates without an associated energy-stack.
|
|
FeatureInputEnergy(Optional<EnergyStack> energyStack) |
Modifier and Type | Method and 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(EnergyStack energyStack)
Assigns an
EnergyStack to be associated with the input. |
void |
setEnergyStack(Optional<EnergyStack> energyStack)
Assigns an optional
EnergyStack to be associated with the input. |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getDictionaryRequired
getResolutionRequired
protected FeatureInputEnergy()
public FeatureInputEnergy(Optional<EnergyStack> energyStack)
public Optional<UnitConverter> getUnitConverterOptional()
public Optional<Resolution> getResolutionOptional()
FeatureInputWithResolution
getResolutionOptional
in interface FeatureInputWithResolution
getResolutionOptional
in class FeatureInputDimensions
public Optional<Dictionary> getDictionaryOptional()
FeatureInputDictionary
getDictionaryOptional
in interface FeatureInputDictionary
public Dimensions dimensions() throws FeatureCalculationException
FeatureInputDimensions
dimensions
in class FeatureInputDimensions
FeatureCalculationException
- if the dimensions cannot be calculated.public Dimensions dimensionsRequired() throws FeatureCalculationException
FeatureCalculationException
- if the dimensions are not known.public Optional<Dimensions> dimensionsOptional()
public EnergyStack getEnergyStackRequired() throws FeatureCalculationException
FeatureCalculationException
- if the energy-stack isn't presentpublic Optional<EnergyStack> getEnergyStackOptional()
public void setEnergyStack(EnergyStack energyStack)
EnergyStack
to be associated with the input.
Any existing energy-stack is replaced.
energyStack
- the energy-stack to assign.public void setEnergyStack(Optional<EnergyStack> energyStack)
EnergyStack
to be associated with the input.
Any existing energy-stack state is replaced.
energyStack
- the optional energy-stack to assign.public boolean equals(Object o)
equals
in class FeatureInputDimensions
protected boolean canEqual(Object other)
canEqual
in class FeatureInputDimensions
public int hashCode()
hashCode
in class FeatureInputDimensions
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.