Package adams.data.spectrumfilter

Class Covariance

  • 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.ShallowCopySupporter<adams.data.filter.Filter>, adams.core.SizeOfHandler, adams.data.filter.Filter<Spectrum>, adams.db.DatabaseConnectionHandler, adams.db.DatabaseConnectionProvider, adams.db.DatabaseConnectionUser, Serializable, Comparable
    public class Covariance
extends adams.data.filter.AbstractDatabaseConnectionFilter<Spectrum>
    Plot covariance against Reference.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -conditions <adams.db.AbstractConditions [options]> (property: conditions)
    The conditions for retrieving the spectra from the database.
    default: knir.db.SpectrumConditions
 
    -field <adams.data.report.Field> (property: field)
    Field to use for covariance.
    default: blah
 
    -scale (property: scale)
    Scale?
 
    -absolute (property: absolute)
    Use absolute values of coefficients?
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

        adams.data.filter.AbstractFilter.FilterJob<T extends adams.data.container.DataContainer>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_Absolute
      display absolute values.
      protected AbstractSpectrumConditions m_Conditions
      the spectrum retrieval conditions.
      protected adams.data.report.Field m_Field
      reference field.
      protected adams.data.filter.Filter<Spectrum> m_filter
      filter to apply to retrieved spectra.
      protected boolean m_Scale
      display absolute values.

      • Fields inherited from class adams.data.filter.AbstractDatabaseConnectionFilter

        m_DatabaseConnection

      • Fields inherited from class adams.data.filter.AbstractFilter

        m_DontUpdateID

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      Covariance()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String absoluteTipText()
      Returns the tip text for this property.
      String conditionsTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      String fieldTipText()
      Returns the tip text for this property.
      String filterTipText()
      Returns the tip text for this property.
      boolean getAbsolute()
      Get absolute?
      adams.db.AbstractConditions getConditions()
      Returns the conditions container to use for retrieving the spectra.
      protected adams.db.AbstractDatabaseConnection getDefaultDatabaseConnection()
      Returns the default database connection.
      adams.data.report.Field getField()
      get Field.
      adams.data.filter.Filter<Spectrum> getFilter()
      Get filter.
      boolean getScale()
      Get scale?
      String globalInfo()
      Returns a string describing the object.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      String scaleTipText()
      Returns the tip text for this property.
      void setAbsolute​(boolean abs)
      Set absolute?
      void setConditions​(adams.db.AbstractConditions value)
      Sets the conditions container to use for retrieving the spectra.
      void setField​(adams.data.report.Field f)
      Set Field.
      void setFilter​(adams.data.filter.Filter<Spectrum> filter)
      Set filter.
      void setScale​(boolean value)
      Set scale?
      protected void updateDatabaseConnection()
      Updates the database connection in dependent schemes.

      • Methods inherited from class adams.data.filter.AbstractDatabaseConnectionFilter

        getDatabaseConnection, initialize, setDatabaseConnection

      • Methods inherited from class adams.data.filter.AbstractFilter

        checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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, setLoggingLevel

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

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Field

        protected adams.data.report.Field m_Field
        reference field.

      • m_Scale

        protected boolean m_Scale
        display absolute values.

      • m_Absolute

        protected boolean m_Absolute
        display absolute values.

      • m_filter

        protected adams.data.filter.Filter<Spectrum> m_filter
        filter to apply to retrieved spectra.

    • Constructor Detail

      • Covariance

        public Covariance()

    • 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.data.filter.AbstractFilter<Spectrum>

      • getDefaultDatabaseConnection

        protected adams.db.AbstractDatabaseConnection getDefaultDatabaseConnection()
        Returns the default database connection.
        Specified by:
        getDefaultDatabaseConnection in class adams.data.filter.AbstractDatabaseConnectionFilter<Spectrum>
        Returns:
        the default database connection

      • setFilter

        public void setFilter​(adams.data.filter.Filter<Spectrum> filter)
        Set filter.
        Parameters:
        filter - the filter to use

      • getFilter

        public adams.data.filter.Filter<Spectrum> getFilter()
        Get filter.
        Returns:
        the filter in use

      • filterTipText

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

      • setScale

        public void setScale​(boolean value)
        Set scale?
        Parameters:
        value - scale?

      • getScale

        public boolean getScale()
        Get scale?
        Returns:
        scale?

      • scaleTipText

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

      • setAbsolute

        public void setAbsolute​(boolean abs)
        Set absolute?
        Parameters:
        abs - absolute?

      • getAbsolute

        public boolean getAbsolute()
        Get absolute?
        Returns:
        absolute?

      • absoluteTipText

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

      • setField

        public void setField​(adams.data.report.Field f)
        Set Field.
        Parameters:
        f - field

      • getField

        public adams.data.report.Field getField()
        get Field.
        Returns:
        field

      • fieldTipText

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

      • setConditions

        public void setConditions​(adams.db.AbstractConditions value)
        Sets the conditions container to use for retrieving the spectra.
        Parameters:
        value - the conditions

      • getConditions

        public adams.db.AbstractConditions getConditions()
        Returns the conditions container to use for retrieving the spectra.
        Returns:
        the conditions

      • conditionsTipText

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

      • updateDatabaseConnection

        protected void updateDatabaseConnection()
        Updates the database connection in dependent schemes.
        Overrides:
        updateDatabaseConnection in class adams.data.filter.AbstractDatabaseConnectionFilter<Spectrum>

      • processData

        protected Spectrum processData​(Spectrum data)
        Performs the actual filtering.
        Specified by:
        processData in class adams.data.filter.AbstractFilter<Spectrum>
        Parameters:
        data - the data to filter
        Returns:
        the filtered data