Package adams.data.evaluator.instance

Class DistanceToClosest

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SerializableObject, adams.core.ShallowCopySupporter<Evaluator>, adams.core.SizeOfHandler, Evaluator, Serializable, Comparable
    public class DistanceToClosest
extends AbstractNearestNeighborBasedEvaluator
    Uses the specified nearest neighbor search to locate the closest instance in the training data and returns the distance to it. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -missing-evaluation <float> (property: missingEvaluation)
    The value to use as replacement for missing evaluations.
    default: NaN
 
    -serialization-file <adams.core.io.PlaceholderFile> (property: serializationFile)
    The file to serialize the generated internal model to.
    default: ${CWD}
 
    -override-serialized-file <boolean> (property: overrideSerializedFile)
    If set to true, then any serialized file will be ignored and the setup for 
    serialization will be regenerated.
    default: false
 
    -search <weka.core.neighboursearch.NearestNeighbourSearch> (property: search)
    The nearest neighbor search to use.
    default: weka.core.neighboursearch.LinearNNSearch -A \"weka.core.EuclideanDistance -R first-last\"
 
    -filter <weka.filters.Filter> (property: filter)
    The filter to apply to the data.
    default: weka.filters.AllFilter
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Filter

        protected weka.filters.Filter m_Filter
        the filter to use for filtering.

      • m_ActualFilter

        protected weka.filters.Filter m_ActualFilter
        the actual filter.

      • m_RawTrainingData

        protected transient weka.core.Instances m_RawTrainingData
        the raw training data.

    • Constructor Detail

      • DistanceToClosest

        public DistanceToClosest()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • setFilter

        public void setFilter​(weka.filters.Filter value)
        Sets the filter to use.
        Parameters:
        value - the filter

      • getFilter

        public weka.filters.Filter getFilter()
        Returns the filter to use.
        Returns:
        the filter

      • filterTipText

        public String filterTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • performBuild

        protected boolean performBuild​(weka.core.Instances data)
        Builds the evaluator.
        Specified by:
        performBuild in class AbstractEvaluator
        Parameters:
        data - the instance to check
        Returns:
        true if build successful

      • retrieveSerializationSetup

        public Object[] retrieveSerializationSetup()
        Returns the member variables to serialize to a file.
        Returns:
        the objects to serialize

      • setSerializationSetup

        public void setSerializationSetup​(Object[] value)
        Updates the member variables with the provided objects obtained from deserialization.
        Parameters:
        value - the deserialized objects