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

Class ParamFromCollection<T extends org.anchoranalysis.feature.input.FeatureInput>

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.feature.bean.operator.FeatureGeneric<T>
org.anchoranalysis.plugin.image.feature.bean.shared.ParamFromCollection<T>
Type Parameters:
T - feature-input-type
public class ParamFromCollection<T extends org.anchoranalysis.feature.input.FeatureInput>
extends org.anchoranalysis.feature.bean.operator.FeatureGeneric<T>
Retrieves a parameter as stored in a Dictionary in SharedObjects.

This differs from FromDictionary which reads the parameter from the energy-stack, whereas this from a specific parameters collection.

Author:
Owen Feehan

  • Constructor Summary

    Constructors 
    Constructor Description
    ParamFromCollection()  

  • Method Summary

    Modifier and Type Method Description
    protected void beforeCalc​(org.anchoranalysis.feature.initialization.FeatureInitialization initialization)  
    double calculate​(org.anchoranalysis.feature.calculate.FeatureCalculationInput<T> input)  
    String getDictionary()
    The name of the Dictionary that will be retrieved from SharedObjects.
    String getKey()
    The name of the key in the dictionary, whose corresponding value will be returned.
    void setDictionary​(String dictionary)
    The name of the Dictionary that will be retrieved from SharedObjects.
    void setKey​(String key)
    The name of the key in the dictionary, whose corresponding value will be returned.

    Methods inherited from class org.anchoranalysis.feature.bean.operator.FeatureGeneric

    inputType

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

    assignTo, 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

  • Method Details

    • beforeCalc

      protected void beforeCalc​(org.anchoranalysis.feature.initialization.FeatureInitialization initialization) throws org.anchoranalysis.core.exception.InitializeException
      Overrides:
      beforeCalc in class org.anchoranalysis.feature.bean.Feature<T extends org.anchoranalysis.feature.input.FeatureInput>
      Throws:
      org.anchoranalysis.core.exception.InitializeException

    • calculate

      public double calculate​(org.anchoranalysis.feature.calculate.FeatureCalculationInput<T> input) throws org.anchoranalysis.feature.calculate.FeatureCalculationException
      Specified by:
      calculate in class org.anchoranalysis.feature.bean.Feature<T extends org.anchoranalysis.feature.input.FeatureInput>
      Throws:
      org.anchoranalysis.feature.calculate.FeatureCalculationException

    • getDictionary

      public String getDictionary()
      The name of the Dictionary that will be retrieved from SharedObjects.

    • setDictionary

      public void setDictionary​(String dictionary)
      The name of the Dictionary that will be retrieved from SharedObjects.

    • getKey

      public String getKey()
      The name of the key in the dictionary, whose corresponding value will be returned.

    • setKey

      public void setKey​(String key)
      The name of the key in the dictionary, whose corresponding value will be returned.