Package adams.data.instancesanalysis

Class FastICA

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.analysis.AbstractAnalysis<weka.core.Instances>

adams.data.instancesanalysis.AbstractInstancesAnalysis

adams.data.instancesanalysis.FastICA

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class FastICA
extends AbstractInstancesAnalysis

Performs independent components analysis and allows access to components and sources.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected WekaAttributeRange	m_AttributeRange	the range of attributes to work.
protected SpreadSheet	m_Components	the components.
protected com.github.waikatodatamining.matrix.algorithm.ica.FastICA	m_ICA	the Fast ICA analysis to use.
protected SpreadSheet	m_Sources	the sources.

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

Method Summary

Modifier and Type	Method	Description
String	attributeRangeTipText()	Returns the tip text for this property.
protected void	check(weka.core.Instances data)	Hook method for checks.
void	defineOptions()	Adds options to the internal list of options.
protected String	doAnalyze(weka.core.Instances data)	Performs the actual analysis.
WekaAttributeRange	getAttributeRange()	Returns the attribute range parameter.
SpreadSheet	getComponents()	Returns the components.
com.github.waikatodatamining.matrix.algorithm.ica.FastICA	getICA()	Returns the ICA analysis.
SpreadSheet	getSources()	Returns the sources.
String	globalInfo()	Returns a string describing the object.
String	ICATipText()	Returns the tip text for this property.
protected void	reset()	Resets the scheme.
void	setAttributeRange(WekaAttributeRange value)	Sets the attribute range parameter.
void	setICA(com.github.waikatodatamining.matrix.algorithm.ica.FastICA value)	Sets the ICA analysis.

Methods inherited from class adams.data.analysis.AbstractAnalysis

analyze

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_AttributeRange

protected WekaAttributeRange m_AttributeRange

the range of attributes to work.

m_ICA

protected com.github.waikatodatamining.matrix.algorithm.ica.FastICA m_ICA

the Fast ICA analysis to use.

m_Components

protected SpreadSheet m_Components

the components.

m_Sources

protected SpreadSheet m_Sources

the sources.

Constructor Detail

FastICA

public FastICA()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractOptionHandler

setAttributeRange

public void setAttributeRange(WekaAttributeRange value)

Sets the attribute range parameter.

Parameters:

value - the range

getAttributeRange

public WekaAttributeRange getAttributeRange()

Returns the attribute range parameter.

Returns:

the range

attributeRangeTipText

public String attributeRangeTipText()

Returns the tip text for this property.

Returns:

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

setICA

public void setICA(com.github.waikatodatamining.matrix.algorithm.ica.FastICA value)

Sets the ICA analysis.

Parameters:

value - the analysis

getICA

public com.github.waikatodatamining.matrix.algorithm.ica.FastICA getICA()

Returns the ICA analysis.

Returns:

the analysis

ICATipText

public String ICATipText()

Returns the tip text for this property.

Returns:

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

check

protected void check(weka.core.Instances data)

Hook method for checks.

Overrides:

check in class AbstractAnalysis<weka.core.Instances>

Parameters:

data - the data to check

doAnalyze

protected String doAnalyze(weka.core.Instances data)
                    throws Exception

Performs the actual analysis.

Specified by:

doAnalyze in class AbstractAnalysis<weka.core.Instances>

Parameters:

data - the data to analyze

Returns:

null if successful, otherwise error message

Throws:

Exception - if analysis fails

getComponents

public SpreadSheet getComponents()

Returns the components.

Returns:

the components, null if not available

getSources

public SpreadSheet getSources()

Returns the sources.

Returns:

the sources, null if not available