Package adams.data.io.output

Class FilteredSpectrumWriter

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.output.AbstractDataContainerWriter>, adams.core.SizeOfHandler, Serializable, Comparable
    public class FilteredSpectrumWriter
extends AbstractSpectrumWriter
    Applies the specified filter to the data before outputting it using the supplied writer. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -output <adams.core.io.PlaceholderFile> (property: output)
    The directory to write the container to.
    default: ${TMP}/out.tmp
 
    -filter <adams.data.filter.Filter> (property: filter)
    The filter to apply to the data that was read.
    default: adams.data.filter.PassThrough
 
    -writer <adams.data.io.output.AbstractSpectrumWriter> (property: writer)
    The writer to use for reading the data before applying the filter.
    default: adams.data.io.output.SimpleSpectrumWriter
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.data.filter.Filter m_Filter
      the filter to apply.
      protected AbstractSpectrumWriter m_Writer
      the underlying writer.

      • Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

        m_Output, m_OutputIsFile

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Field Detail

      • m_Filter

        protected adams.data.filter.Filter m_Filter
        the filter to apply.

    • Constructor Detail

      • FilteredSpectrumWriter

        public FilteredSpectrumWriter()

    • 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.io.output.AbstractDataContainerWriter<Spectrum>

      • getDefaultWriter

        protected AbstractSpectrumWriter getDefaultWriter()
        Returns the default instrument of the spectra.
        Returns:
        the default

      • setWriter

        public void setWriter​(AbstractSpectrumWriter value)
        Sets the underlying writer.
        Parameters:
        value - the writer

      • writerTipText

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

      • getDefaultFilter

        protected adams.data.filter.Filter getDefaultFilter()
        Returns the default instrument of the spectra.
        Returns:
        the default

      • setFilter

        public void setFilter​(adams.data.filter.Filter value)
        Sets the filter to apply to the data that was read.
        Parameters:
        value - the filter

      • getFilter

        public adams.data.filter.Filter getFilter()
        Returns the filter to apply to the data that was read.
        Returns:
        the filter

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

      • getFormatDescription

        public String getFormatDescription()
        Returns a string describing the format (used in the file chooser).
        Specified by:
        getFormatDescription in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatDescription in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>
        Returns:
        a description suitable for displaying in the file chooser

      • getFormatExtensions

        public String[] getFormatExtensions()
        Returns the extension(s) of the format.
        Specified by:
        getFormatExtensions in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatExtensions in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>
        Returns:
        the extension (without the dot!)

      • checkData

        protected void checkData​(List<Spectrum> data)
        Performs checks on the data.
        Overrides:
        checkData in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>
        Parameters:
        data - the data to write

      • writeData

        protected boolean writeData​(List<Spectrum> data)
        Performs the actual writing.
        Specified by:
        writeData in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>
        Parameters:
        data - the data to write
        Returns:
        true if successfully written