Package adams.data.spectrumfilter

Class LRCoeff

  • 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 LRCoeff
extends adams.data.filter.AbstractDatabaseConnectionFilter<Spectrum>
    A filter that returns only every n-th wave number.

    Valid options are: 

    -D (property: debug)
         If set to true, scheme may output additional info to the console.
 
    -nth <int> (property: nthPoint)
         Only every n-th point will be output.
         default: 1
    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 boolean m_Apply
      apply coefficients to spectrum.
      protected AbstractSpectrumConditions m_Conditions
      the spectrum retrieval conditions.
      protected adams.data.instances.AbstractInstanceGenerator m_Generator
      the generator to use.
      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
      LRCoeff()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String absoluteTipText()
      Returns the tip text for this property.
      String applyTipText()
      Returns the tip text for this property.
      protected void checkData​(Spectrum data)
      The default implementation only checks whether there is any data set.
      String conditionsTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      String generatorTipText()
      Returns the tip text for this property.
      boolean getAbsolute()
      Get absolute?
      boolean getApply()
      Get apply coeff to spectrum?
      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.instances.AbstractInstanceGenerator getGenerator()
      Returns the generator in use.
      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 setApply​(boolean apply)
      Set apply coeff to spectrum?
      void setConditions​(adams.db.AbstractConditions value)
      Sets the conditions container to use for retrieving the spectra.
      void setGenerator​(adams.data.instances.AbstractInstanceGenerator value)
      Sets the generator to use.
      void setScale​(boolean sc)
      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

        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_Generator

        protected adams.data.instances.AbstractInstanceGenerator m_Generator
        the generator to use.

      • m_Apply

        protected boolean m_Apply
        apply coefficients to spectrum.

      • m_Absolute

        protected boolean m_Absolute
        display absolute values.

      • m_Scale

        protected boolean m_Scale
        display absolute values.

    • Constructor Detail

      • LRCoeff

        public LRCoeff()

    • 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

      • setScale

        public void setScale​(boolean sc)
        Set scale?
        Parameters:
        abs - 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.

      • setApply

        public void setApply​(boolean apply)
        Set apply coeff to spectrum?
        Parameters:
        apply - apply?

      • getApply

        public boolean getApply()
        Get apply coeff to spectrum?
        Returns:
        apply?

      • applyTipText

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

      • setGenerator

        public void setGenerator​(adams.data.instances.AbstractInstanceGenerator value)
        Sets the generator to use.
        Parameters:
        value - the generator

      • updateDatabaseConnection

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

      • 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.

      • getGenerator

        public adams.data.instances.AbstractInstanceGenerator getGenerator()
        Returns the generator in use.
        Returns:
        the generator

      • generatorTipText

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

      • checkData

        protected void checkData​(Spectrum data)
        The default implementation only checks whether there is any data set.
        Overrides:
        checkData in class adams.data.filter.AbstractFilter<Spectrum>
        Parameters:
        data - the data to filter

      • 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