Package adams.data.sampledata

Class SignalToNoiseRatio

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.report.AbstractReportFilter>, adams.core.SizeOfHandler, Serializable, Comparable
    public class SignalToNoiseRatio
extends adams.data.report.AbstractReportFilter<Spectrum>
    Author:
    dale
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_Window
      smoothing window for savitsky golay

      • 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
      void defineOptions()
      Adds options to the internal list of options.
      int getWindowSize()
      Returns the window size for determining the 'smoothed' abundances.
      String globalInfo()  
      protected double Noise_bySmoothing​(Spectrum data)
      Return the RMSE noise value, as a distance from the smoothed spectrum
      protected Spectrum processData​(Spectrum data)  
      void setWindowSize​(int value)
      Sets the window size for determining the 'smoothed' abundances.
      protected double SNR_byParabolicRegression​(Spectrum data)
      Return the SNR measured from quadratic approximation
      protected double SNR_bySmoothing​(Spectrum data)
      Return the SNR measured from smoothed spectrum
      String windowSizeTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.data.report.AbstractReportFilter

        checkData, cleanUp, compareTo, equals, filter, forCommandLine, forName, getFilters, reset, shallowCopy, shallowCopy

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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_Window

        protected int m_Window
        smoothing window for savitsky golay

    • Constructor Detail

      • SignalToNoiseRatio

        public SignalToNoiseRatio()

    • Method Detail

      • 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

      • setWindowSize

        public void setWindowSize​(int value)
        Sets the window size for determining the 'smoothed' abundances.
        Parameters:
        value - the window size

      • getWindowSize

        public int getWindowSize()
        Returns the window size for determining the 'smoothed' abundances.
        Returns:
        the window size

      • windowSizeTipText

        public String windowSizeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • processData

        protected Spectrum processData​(Spectrum data)
        Specified by:
        processData in class adams.data.report.AbstractReportFilter<Spectrum>

      • Noise_bySmoothing

        protected double Noise_bySmoothing​(Spectrum data)
        Return the RMSE noise value, as a distance from the smoothed spectrum
        Parameters:
        data - spectrum
        Returns:
        RMSE noise

      • SNR_bySmoothing

        protected double SNR_bySmoothing​(Spectrum data)
        Return the SNR measured from smoothed spectrum
        Parameters:
        data - spectrum
        Returns:
        SNR

      • SNR_byParabolicRegression

        protected double SNR_byParabolicRegression​(Spectrum data)
        Return the SNR measured from quadratic approximation
        Parameters:
        data - spectrum
        Returns:
        SNR

      • globalInfo

        public String globalInfo()
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler