Package org.anchoranalysis.plugin.image.feature.bean.dimensions

Class ForSpecificAxis<T extends org.anchoranalysis.feature.input.FeatureInputEnergy>

Object
org.anchoranalysis.bean.AnchorBean<B>
org.anchoranalysis.bean.initializable.InitializableBean<org.anchoranalysis.feature.bean.Feature<T>,​org.anchoranalysis.feature.initialization.FeatureInitialization>
org.anchoranalysis.feature.bean.Feature<T>
org.anchoranalysis.plugin.image.feature.bean.dimensions.FromDimensionsBase<T>
org.anchoranalysis.plugin.image.feature.bean.dimensions.ForSpecificAxis<T>
Type Parameters:
T - feature-input-type
Direct Known Subclasses:
Extent, VoxelPhysicalSize
public abstract class ForSpecificAxis<T extends org.anchoranalysis.feature.input.FeatureInputEnergy>
extends FromDimensionsBase<T>
Dimensions-calculation for one specific axis only.

  • Constructor Summary

    Constructors 
    Constructor Description
    ForSpecificAxis()  

  • Method Summary

    Modifier and Type Method Description
    protected abstract double calculateForAxis​(org.anchoranalysis.image.core.dimensions.Dimensions dimensions, org.anchoranalysis.spatial.axis.Axis axis)
    Calculates a feature value for a specific axis of the given dimensions.
    protected double calculateFromDimensions​(org.anchoranalysis.image.core.dimensions.Dimensions dim)
    Calculates a feature value from the given dimensions.
    String describeParameters()  
    String getAxis()
    The axis to perform the calculation on.
    void setAxis​(String axis)
    The axis to perform the calculation on.

    Methods inherited from class org.anchoranalysis.plugin.image.feature.bean.dimensions.FromDimensionsBase

    calculate, inputType

    Methods inherited from class org.anchoranalysis.feature.bean.Feature

    assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, 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

  • Method Details

    • calculateFromDimensions

      protected double calculateFromDimensions​(org.anchoranalysis.image.core.dimensions.Dimensions dim) throws org.anchoranalysis.feature.calculate.FeatureCalculationException
      Description copied from class: FromDimensionsBase
      Calculates a feature value from the given dimensions.
      Specified by:
      calculateFromDimensions in class FromDimensionsBase<T extends org.anchoranalysis.feature.input.FeatureInputEnergy>
      Parameters:
      dim - the Dimensions to calculate from
      Returns:
      the calculated feature value
      Throws:
      org.anchoranalysis.feature.calculate.FeatureCalculationException - if the calculation fails

    • calculateForAxis

      protected abstract double calculateForAxis​(org.anchoranalysis.image.core.dimensions.Dimensions dimensions, org.anchoranalysis.spatial.axis.Axis axis) throws org.anchoranalysis.feature.calculate.FeatureCalculationException
      Calculates a feature value for a specific axis of the given dimensions.
      Parameters:
      dimensions - the Dimensions to calculate from
      axis - the Axis to perform the calculation on
      Returns:
      the calculated feature value
      Throws:
      org.anchoranalysis.feature.calculate.FeatureCalculationException - if the calculation fails

    • describeParameters

      public String describeParameters()
      Overrides:
      describeParameters in class org.anchoranalysis.feature.bean.Feature<T extends org.anchoranalysis.feature.input.FeatureInputEnergy>

    • getAxis

      public String getAxis()
      The axis to perform the calculation on. Valid values are "x", "y", or "z".

    • setAxis

      public void setAxis​(String axis)
      The axis to perform the calculation on. Valid values are "x", "y", or "z".