Package adams.data.conversion

Class SpectraToMultiSpectrum

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.ClassCrossReference, adams.core.CleanUpHandler, adams.core.CrossReference, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.data.conversion.AbstractConversion>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.conversion.Conversion, Serializable
    public class SpectraToMultiSpectrum
extends adams.data.conversion.AbstractConversion
implements adams.core.ClassCrossReference
    Generates a adams.data.spectrum.MultiSpectrum from the incoming array of adams.data.spectrum.Spectrum.
    If the first spectrum in the array is a report-only spectrum (ie no spectral data points), then this report is used as the 'global' report for the multi-spectrum. This spectrum's ID is also used as the multi-spectrum's ID.

    See also:
    adams.data.conversion.MultiSpectrumToSpectra 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -use-custom-comparator <boolean> (property: useCustomComparator)
    If enabled, the specified custom comparator is used for sorting the spectra
    in the generated MultiSpectrum.
    default: false
 
    -custom-comparator <adams.data.spectrum.AbstractSpectrumComparator> (property: customComparator)
    The custom comparator to use for sorting the spectra in the generated MultiSpectrum.
    default: adams.data.spectrum.SpectrumComparator
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_UseCustomComparator

        protected boolean m_UseCustomComparator
        whether to use a custom comparator.

    • Constructor Detail

      • SpectraToMultiSpectrum

        public SpectraToMultiSpectrum()

    • 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.core.option.AbstractOptionHandler

      • setUseCustomComparator

        public void setUseCustomComparator​(boolean value)
        Sets whether to use a custom comparator.
        Parameters:
        value - true if to use custom comparator

      • getUseCustomComparator

        public boolean getUseCustomComparator()
        Returns whether to use a custom comparator.
        Returns:
        true if to use a custom comparator

      • useCustomComparatorTipText

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

      • setCustomComparator

        public void setCustomComparator​(AbstractSpectrumComparator value)
        Sets the custom comparator.
        Parameters:
        value - the custom comparator

      • getCustomComparator

        public AbstractSpectrumComparator getCustomComparator()
        Returns the custom comparator.
        Returns:
        the custom comparator

      • customComparatorTipText

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

      • accepts

        public Class accepts()
        Returns the class that is accepted as input.
        Specified by:
        accepts in interface adams.data.conversion.Conversion
        Specified by:
        accepts in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • generates

        public Class generates()
        Returns the class that is generated as output.
        Specified by:
        generates in interface adams.data.conversion.Conversion
        Specified by:
        generates in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • getClassCrossReferences

        public Class[] getClassCrossReferences()
        Returns the cross-referenced classes.
        Specified by:
        getClassCrossReferences in interface adams.core.ClassCrossReference
        Returns:
        the classes

      • doConvert

        protected Object doConvert()
                    throws Exception
        Performs the actual conversion.
        Specified by:
        doConvert in class adams.data.conversion.AbstractConversion
        Returns:
        the converted data
        Throws:
        Exception - if something goes wrong with the conversion