org.anchoranalysis.image.feature.input.FeatureInputSingleObject

All Implemented Interfaces:: FeatureInput, FeatureInputDictionary, FeatureInputWithResolution

public class FeatureInputSingleObject
extends FeatureInputEnergy

An input representing a single object-mask (with maybe an energy-stack associated).

Equals and hash-code must be sensibly defined as these inputs can be used as keys in a cache. The equals implementation assumes equals of ObjectMask is shallow and computationally inexpensive.

Author:: Owen Feehan

Constructor Summary

Constructors
Constructor	Description
`FeatureInputSingleObject(org.anchoranalysis.image.voxel.object.ObjectMask object)`	Constructs a FeatureInputSingleObject with an ObjectMask.
`FeatureInputSingleObject(org.anchoranalysis.image.voxel.object.ObjectMask object, Optional<EnergyStack> energyStack)`	Constructs a FeatureInputSingleObject with an ObjectMask and an optional EnergyStack.
`FeatureInputSingleObject(org.anchoranalysis.image.voxel.object.ObjectMask object, EnergyStack energyStack)`	Constructs a FeatureInputSingleObject with an ObjectMask and an EnergyStack.

Method Summary

Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`org.anchoranalysis.image.voxel.object.ObjectMask`	`getObject()`	The object mask associated with this input.
`int`	`hashCode()`
`String`	`toString()`	Returns a string representation of the object.

Methods inherited from class org.anchoranalysis.feature.input.FeatureInputEnergy

dimensions, dimensionsOptional, dimensionsRequired, getDictionaryOptional, getEnergyStackOptional, getEnergyStackRequired, getResolutionOptional, getUnitConverterOptional, setEnergyStack, setEnergyStack

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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
- FeatureInputSingleObject
  
  public FeatureInputSingleObject(org.anchoranalysis.image.voxel.object.ObjectMask object)
  
  Constructs a FeatureInputSingleObject with an ObjectMask.
  
  Parameters:
  
  object - the ObjectMask to be associated with this input
- FeatureInputSingleObject
  
  public FeatureInputSingleObject(org.anchoranalysis.image.voxel.object.ObjectMask object, EnergyStack energyStack)
  
  Constructs a FeatureInputSingleObject with an ObjectMask and an EnergyStack.
  
  Parameters:
  
  object - the ObjectMask to be associated with this input
  
  energyStack - the EnergyStack to be associated with this input
- FeatureInputSingleObject
  
  public FeatureInputSingleObject(org.anchoranalysis.image.voxel.object.ObjectMask object, Optional<EnergyStack> energyStack)
  
  Constructs a FeatureInputSingleObject with an ObjectMask and an optional EnergyStack.
  
  Parameters:
  
  object - the ObjectMask to be associated with this input
  
  energyStack - an optional EnergyStack to be associated with this input
Method Details
- toString
  
  public String toString()
  
  Returns a string representation of the object.
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  a string representation of the associated ObjectMask
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class FeatureInputEnergy
- canEqual
  
  protected boolean canEqual(Object other)
  
  Overrides:
  
  canEqual in class FeatureInputEnergy
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class FeatureInputEnergy
- getObject
  
  public org.anchoranalysis.image.voxel.object.ObjectMask getObject()
  
  The object mask associated with this input.

Class FeatureInputSingleObject