Package adams.data.instances

Class AbstractSpectrumInstanceGeneratorWithClass

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.instances.AbstractInstanceGenerator<Spectrum>

adams.data.instances.AbstractSpectrumBasedInstanceGenerator

adams.data.instances.AbstractSpectrumInstanceGenerator

adams.data.instances.AbstractSpectrumInstanceGeneratorWithClass

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, InstanceGeneratorWithClassLabels, InstanceGeneratorWithSampleID, InstanceGeneratorWithTargetField, adams.db.DatabaseConnectionHandler, adams.db.DatabaseConnectionProvider, adams.db.DatabaseConnectionUser, adams.db.OptionalDatabaseConnectionUser, Serializable, Comparable

Direct Known Subclasses:

SimpleInstanceGenerator

public abstract class AbstractSpectrumInstanceGeneratorWithClass
extends AbstractSpectrumInstanceGenerator
implements InstanceGeneratorWithTargetField, InstanceGeneratorWithClassLabels

Abstract base class for schemes that turn spectra/sample data into weka.core.Instance objects (spectra is included). In addition, a class attribute (or field) is also defined.

Version:

$Revision: 1286 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.base.BaseString[]	m_ClassLabels	the nominal labels to use, in case of a nominal class.
protected adams.data.report.Field	m_Field	the field that acts as class attribute.

Fields inherited from class adams.data.instances.AbstractSpectrumInstanceGenerator

m_AdditionalFields, m_AmplitudePrefix, m_NoAdditionalFieldsPrefix, m_WaveNumberPrefix

Fields inherited from class adams.data.instances.AbstractSpectrumBasedInstanceGenerator

m_AddSampleID, m_LoadSampleData, m_Notes

Fields inherited from class adams.data.instances.AbstractInstanceGenerator

LABEL_FALSE, LABEL_TRUE, m_AddDatabaseID, m_DatabaseConnection, m_Offline, m_OutputHeader, m_TolerateHeaderChanges

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
AbstractSpectrumInstanceGeneratorWithClass()

Method Summary

Modifier and Type	Method	Description
protected void	checkHeader(Spectrum data)	Checks whether the number of waves are the same.
String	classLabelsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	fieldTipText()	Returns the tip text for this property.
protected abstract void	generateHeader(Spectrum data)	Generates the header of the output data.
protected String	getAdditionalFieldsPosition()	Returns the position used in the "Add" filter for adding the additional fields to the dataset.
adams.core.base.BaseString[]	getClassLabels()	Returns the labels for a nominal class attribute.
adams.data.report.Field	getField()	Returns the field that acts as class attribute.
void	setClassLabels(adams.core.base.BaseString[] value)	Sets the labels for a nominal class attribute.
void	setField(adams.data.report.Field value)	Sets the field to act as class attribute.

Methods inherited from class adams.data.instances.AbstractSpectrumInstanceGenerator

addField, additionalFieldsTipText, amplitudePrefixTipText, getAdditionalFields, getAdditionalFieldsPrefix, getAmplitudePrefix, getNoAdditionalFieldsPrefix, getWaveNumberPrefix, noAdditionalFieldsPrefixTipText, postProcessHeader, postProcessOutput, setAdditionalFields, setAmplitudePrefix, setNoAdditionalFieldsPrefix, setWaveNumberPrefix, waveNumberPrefixTipText

Methods inherited from class adams.data.instances.AbstractSpectrumBasedInstanceGenerator

addSampleIDTipText, checkInput, getAddSampleID, getDefaultDatabaseConnection, getLoadSampleData, getNotes, loadSampleDataTipText, notesTipText, setAddSampleID, setLoadSampleData, setNotes

Methods inherited from class adams.data.instances.AbstractInstanceGenerator

addDatabaseIDTipText, checkSetup, cleanUp, compareTo, destroy, equals, forCommandLine, forName, generate, generateOutput, getAddDatabaseID, getDatabaseConnection, getGenerators, getOffline, getOutputHeader, getTolerateHeaderChanges, initialize, interpretePosition, offlineTipText, reset, setAddDatabaseID, setDatabaseConnection, setOffline, setTolerateHeaderChanges, shallowCopy, shallowCopy, tolerateHeaderChangesTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Field

protected adams.data.report.Field m_Field

the field that acts as class attribute.

m_ClassLabels

protected adams.core.base.BaseString[] m_ClassLabels

the nominal labels to use, in case of a nominal class.

Constructor Detail

AbstractSpectrumInstanceGeneratorWithClass

public AbstractSpectrumInstanceGeneratorWithClass()

Method Detail

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 AbstractSpectrumInstanceGenerator

setField

public void setField(adams.data.report.Field value)

Sets the field to act as class attribute.

Specified by:

setField in interface InstanceGeneratorWithTargetField

Parameters:

value - the field

getField

public adams.data.report.Field getField()

Returns the field that acts as class attribute.

Specified by:

getField in interface InstanceGeneratorWithTargetField

Returns:

the field

fieldTipText

public String fieldTipText()

Returns the tip text for this property.

Specified by:

fieldTipText in interface InstanceGeneratorWithTargetField

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setClassLabels

public void setClassLabels(adams.core.base.BaseString[] value)

Sets the labels for a nominal class attribute.

Specified by:

setClassLabels in interface InstanceGeneratorWithClassLabels

Parameters:

value - the labels

getClassLabels

public adams.core.base.BaseString[] getClassLabels()

Returns the labels for a nominal class attribute.

Specified by:

getClassLabels in interface InstanceGeneratorWithClassLabels

Returns:

the labels

classLabelsTipText

public String classLabelsTipText()

Returns the tip text for this property.

Specified by:

classLabelsTipText in interface InstanceGeneratorWithClassLabels

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.

Overrides:

checkHeader in class AbstractSpectrumInstanceGenerator

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.

Overrides:

getAdditionalFieldsPosition in class AbstractSpectrumInstanceGenerator

Returns:

the position string

See Also:

AbstractInstanceGenerator.interpretePosition(weka.core.Instances, String)

generateHeader

protected abstract void generateHeader(Spectrum data)

Generates the header of the output data.

Specified by:

generateHeader in class AbstractSpectrumInstanceGenerator

Parameters:

data - the input data