Package adams.data.instances

Class AbstractSpectrumInstanceGenerator

  • 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.instances.AbstractInstanceGenerator>, adams.core.SizeOfHandler, adams.data.instances.InstanceGeneratorWithAdditionalFields, InstanceGeneratorWithSampleID, adams.db.DatabaseConnectionHandler, adams.db.DatabaseConnectionProvider, adams.db.DatabaseConnectionUser, adams.db.OptionalDatabaseConnectionUser, Serializable, Comparable
    Direct Known Subclasses:
    AbstractSpectrumInstanceGeneratorWithClass, SimpleSpectralInstanceGenerator
    public abstract class AbstractSpectrumInstanceGenerator
extends AbstractSpectrumBasedInstanceGenerator
implements adams.data.instances.InstanceGeneratorWithAdditionalFields
    Abstract base class for schemes that turn spectra/sample data into weka.core.Instance objects (spectra is included).
    Version:
    $Revision: 1905 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_WaveNumberPrefix

        protected String m_WaveNumberPrefix
        the prefix for the wave-numbers attributes.

      • m_AmplitudePrefix

        protected String m_AmplitudePrefix
        the prefix for the amplitude attributes.

      • m_AdditionalFields

        protected adams.data.report.Field[] m_AdditionalFields
        additional fields to add to the output data.

      • m_NoAdditionalFieldsPrefix

        protected boolean m_NoAdditionalFieldsPrefix
        drops the prefix for the additional fields.

    • Constructor Detail

      • AbstractSpectrumInstanceGenerator

        public AbstractSpectrumInstanceGenerator()

    • Method Detail

      • setWaveNumberPrefix

        public void setWaveNumberPrefix​(String value)
        Sets the prefix for the wave number attributes.
        Parameters:
        value - the prefix

      • getWaveNumberPrefix

        public String getWaveNumberPrefix()
        Returns the prefix for the wave number attributes.
        Returns:
        the prefix

      • waveNumberPrefixTipText

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

      • setAmplitudePrefix

        public void setAmplitudePrefix​(String value)
        Sets the prefix for the wave number attributes.
        Parameters:
        value - the prefix

      • getAmplitudePrefix

        public String getAmplitudePrefix()
        Returns the prefix for the wave number attributes.
        Returns:
        the prefix

      • amplitudePrefixTipText

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

      • setNoAdditionalFieldsPrefix

        public void setNoAdditionalFieldsPrefix​(boolean value)
        Sets whether to drop the prefix for the additional fields.
        Specified by:
        setNoAdditionalFieldsPrefix in interface adams.data.instances.InstanceGeneratorWithAdditionalFields
        Parameters:
        value - if true then no prefix

      • getNoAdditionalFieldsPrefix

        public boolean getNoAdditionalFieldsPrefix()
        Returns whether to drop the prefix for the additional fields.
        Specified by:
        getNoAdditionalFieldsPrefix in interface adams.data.instances.InstanceGeneratorWithAdditionalFields
        Returns:
        true if no prefix

      • noAdditionalFieldsPrefixTipText

        public String noAdditionalFieldsPrefixTipText()
        Returns the tip text for this property.
        Specified by:
        noAdditionalFieldsPrefixTipText in interface adams.data.instances.InstanceGeneratorWithAdditionalFields
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAdditionalFields

        public void setAdditionalFields​(adams.data.report.Field[] value)
        Sets the additional fields to add.
        Specified by:
        setAdditionalFields in interface adams.data.instances.InstanceGeneratorWithAdditionalFields
        Parameters:
        value - the fields

      • getAdditionalFields

        public adams.data.report.Field[] getAdditionalFields()
        Returns the additional fields to add.
        Specified by:
        getAdditionalFields in interface adams.data.instances.InstanceGeneratorWithAdditionalFields
        Returns:
        the fields

      • additionalFieldsTipText

        public String additionalFieldsTipText()
        Returns the tip text for this property.
        Specified by:
        additionalFieldsTipText in interface adams.data.instances.InstanceGeneratorWithAdditionalFields
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • checkHeader

        protected void checkHeader​(Spectrum data)
        Checks whether the number of waves are the same.
        Specified by:
        checkHeader in class adams.data.instances.AbstractInstanceGenerator<Spectrum>
        Parameters:
        data - the input data

      • generateHeader

        protected abstract void generateHeader​(Spectrum data)
        Generates the header of the output data.
        Specified by:
        generateHeader in class adams.data.instances.AbstractInstanceGenerator<Spectrum>
        Parameters:
        data - the input data

      • getAdditionalFieldsPosition

        protected String getAdditionalFieldsPosition()
        Returns the position used in the "Add" filter for adding the additional fields to the dataset. "first", "second", "third", "last_2", "last_1" and "last" are valid as well.
        Returns:
        the position string
        See Also:
        AbstractInstanceGenerator.interpretePosition(weka.core.Instances, String)

      • getAdditionalFieldsPrefix

        protected String getAdditionalFieldsPrefix()
        Returns the prefix to use for the additional fields.
        Returns:
        the prefix

      • addField

        protected void addField​(adams.data.report.Field field)
        Adds the specified field to the output format.
        Parameters:
        field - the field/field to add

      • postProcessOutput

        protected weka.core.Instance postProcessOutput​(Spectrum data,
                                               weka.core.Instance inst)
        Adds the IDs, notes, additional fields to the data.
        Overrides:
        postProcessOutput in class AbstractSpectrumBasedInstanceGenerator
        Parameters:
        data - the input data
        inst - the generated instance
        Returns:
        the processed instance