Package adams.data.cleaner.spectrum

Class MinMax

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<AbstractCleaner>, adams.core.SizeOfHandler, Serializable, Comparable
    public class MinMax
extends AbstractCleaner
    Checks a field in the sample data whether the value is within a certain range.

    Valid options are: 

    -D (property: debug)
         If set to true, scheme may output additional info to the console.
 
    -field <knir.data.sampledata.Field> (property: field)
         The field in the sample data to check.
         default: knir.data.sampledata.Field
 
    -min <double> (property: minimum)
         The minimum value the field is allowed to have (inclusive).
         default: 0.0
 
    -max <double> (property: maximum)
         Only every n-th point will be output.
         default: 1000.0
    Version:
    $Revision: 2242 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Field

        protected adams.data.report.Field m_Field
        the field in the sample data to check.

      • m_Minimum

        protected double m_Minimum
        the minimum value of the field.

      • m_Maximum

        protected double m_Maximum
        the maximum value of the field.

    • Constructor Detail

      • MinMax

        public MinMax()

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

      • setField

        public void setField​(adams.data.report.Field value)
        Sets the field to use.
        Parameters:
        value - the field to use

      • getField

        public adams.data.report.Field getField()
        Returns the field in use.
        Returns:
        the 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.

      • setMinimum

        public void setMinimum​(double value)
        Sets the minimum value the field can have (incl.).
        Parameters:
        value - the minimum

      • getMinimum

        public double getMinimum()
        Returns the minimum value the field can have (incl.).
        Returns:
        the minimum

      • minimumTipText

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

      • setMaximum

        public void setMaximum​(double value)
        Sets maximum value the field is allowed to have (incl).
        Parameters:
        value - the maximum

      • getMaximum

        public double getMaximum()
        Returns the maximum value the field is allowed to have (incl).
        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.

      • performCheck

        protected String performCheck​(Spectrum data)
        Performs the actual check.
        Specified by:
        performCheck in class AbstractCleaner
        Parameters:
        data - the spectrum to check
        Returns:
        null if ok, otherwise error message