GradientMagnitude (Anchor - merged Javadoc across key repositories. This documentation is a work-in-progress. 1.0.0-SNAPSHOT API)

AnchorBean<Feature<FeatureInputSingleObject>>

InitializableBean<Feature<FeatureInputSingleObject>,FeatureInitialization>

Feature<FeatureInputSingleObject>

FeatureSingleObject

IntensityGradientBase

GradientMagnitude

public class GradientMagnitude extends IntensityGradientBase

Calculates the mean of the intensity-gradient defined by multiple Energy channels in a particular direction

An Energy channel is present for X, Y and optionally Z intensity-gradients.

A constant is subtracted from the Energy channel (all positive) to center around 0

Author:: Owen Feehan

Constructor Summary

Constructors

Constructor

Description

GradientMagnitude()
Method Summary

Modifier and Type

Method

Description

double

calculate(FeatureCalculationInput<FeatureInputSingleObject> input)

Calculates a value for some input.

Methods inherited from class org.anchoranalysis.plugin.image.feature.bean.object.single.intensity.gradient.IntensityGradientBase
getEnergyIndexX, getEnergyIndexY, getEnergyIndexZ, getSubtractConstant, gradientCalculation, setEnergyIndexX, setEnergyIndexY, setEnergyIndexZ, setSubtractConstant

Methods inherited from class org.anchoranalysis.image.feature.bean.object.single.FeatureSingleObject
inputType

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
- GradientMagnitude
  
  public GradientMagnitude()
Method Details
- calculate
  
  public double calculate(FeatureCalculationInput<FeatureInputSingleObject> input) throws FeatureCalculationException
  
  Description copied from class: Feature
  
  Calculates a value for some input.
  
  Specified by:
  
  calculate in class Feature<FeatureInputSingleObject>
  
  Parameters:
  
  input - the input to the calculation.
  
  Returns:
  
  the result of the calculation.
  
  Throws:
  
  FeatureCalculationException - if the calculation cannot successfully complete.