Package adams.data.compare

Class SpectrumCosineSimilarity

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class SpectrumCosineSimilarity
extends adams.data.compare.AbstractObjectCompare<Spectrum,​Boolean>
    Compares the spectral data of two spectra using cosine similarity.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected double m_Maximum
      the maximum accepted correlation coefficient.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the classes that it can handle.
      void defineOptions()
      Adds options to the internal list of options.
      protected Boolean doCompareObjects​(Spectrum o1, Spectrum o2)
      Performs the actual comparison of the two objects.
      Class generates()
      Returns the type of output that it generates.
      double getMaximum()
      Returns the maximum for the cosine similarity.
      String globalInfo()
      Returns a string describing the object.
      String maximumTipText()
      Returns the tip text for this property.
      void setMaximum​(double value)
      Sets the maximum for the cosine similarity.

      • Methods inherited from class adams.data.compare.AbstractObjectCompare

        check, compareObjects, getQuickInfo

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Maximum

        protected double m_Maximum
        the maximum accepted correlation coefficient.

    • Constructor Detail

      • SpectrumCosineSimilarity

        public SpectrumCosineSimilarity()

    • 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

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setMaximum

        public void setMaximum​(double value)
        Sets the maximum for the cosine similarity.
        Parameters:
        value - the maximum

      • getMaximum

        public double getMaximum()
        Returns the maximum for the cosine similarity.
        Returns:
        the maximum

      • maximumTipText

        public String maximumTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the classes that it can handle.
        Specified by:
        accepts in class adams.data.compare.AbstractObjectCompare<Spectrum,​Boolean>
        Returns:
        the array of classes

      • generates

        public Class generates()
        Returns the type of output that it generates.
        Specified by:
        generates in class adams.data.compare.AbstractObjectCompare<Spectrum,​Boolean>
        Returns:
        the class of the output

      • doCompareObjects

        protected Boolean doCompareObjects​(Spectrum o1,
                                   Spectrum o2)
        Performs the actual comparison of the two objects.
        Specified by:
        doCompareObjects in class adams.data.compare.AbstractObjectCompare<Spectrum,​Boolean>
        Parameters:
        o1 - the first object
        o2 - the second object
        Returns:
        the result of the comparison