weka.classifiers.evaluation.output.prediction

Class CSV

java.lang.Object

weka.classifiers.evaluation.output.prediction.AbstractOutput

weka.classifiers.evaluation.output.prediction.CSV

All Implemented Interfaces:

java.io.Serializable, OptionHandler

public class CSV
extends AbstractOutput

Outputs the predictions as CSV.

Valid options are:

 -p <range>
  The range of attributes to print in addition to the classification.
  (default: none)
 

 -distribution
  Whether to turn on the output of the class distribution.
  Only for nominal class attributes.
  (default: off)
 

 -decimals <num>
  The number of digits after the decimal point.
  (default: 3)
 

 -file <path>
  The file to store the output in, instead of outputting it on stdout.
  Gets ignored if the supplied path is a directory.
  (default: .)
 

 -suppress
  In case the data gets stored in a file, then this flag can be used
  to suppress the regular output.
  (default: not suppressed)
 

 -use-tab
  Whether to use TAB as separator instead of comma.
  (default: comma)
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	m_Delimiter the delimiter.

Fields inherited from class weka.classifiers.evaluation.output.prediction.AbstractOutput

m_Attributes, m_Buffer, m_FileBuffer, m_Header, m_NumDecimals, m_OutputDistribution, m_OutputFile, m_SuppressOutput

Constructor Summary

Constructors

Constructor and Description
CSV()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	attributeValuesString(Instance instance) Builds a string listing the attribute values in a specified range of indices, separated by commas and enclosed in brackets.
protected void	doPrintClassification(Classifier classifier, Instance inst, int index) Store the prediction made by the classifier as a string.
protected void	doPrintClassification(double[] dist, Instance inst, int index) Store the prediction made by the classifier as a string.
protected void	doPrintFooter() Does nothing.
protected void	doPrintHeader() Performs the actual printing of the header.
java.lang.String	getDisplay() Returns a short display text, to be used in comboboxes.
java.lang.String[]	getOptions() Gets the current option settings for the OptionHandler.
boolean	getUseTab() Returns whether tab is used as separator.
java.lang.String	globalInfo() Returns a string describing the output generator.
java.util.Enumeration<Option>	listOptions() Returns an enumeration of all the available options..
void	setOptions(java.lang.String[] options) Sets the OptionHandler's options using the given list.
void	setUseTab(boolean value) Sets whether to use tab instead of comma as separator.
java.lang.String	useTabTipText() Returns the tip text for this property.

Methods inherited from class weka.classifiers.evaluation.output.prediction.AbstractOutput

append, attributesTipText, checkBasic, checkHeader, fromCommandline, generatesOutput, getAttributes, getBuffer, getDefaultNumDecimals, getHeader, getNumDecimals, getOutputDistribution, getOutputFile, getSuppressOutput, numDecimalsTipText, outputDistributionTipText, outputFileTipText, preProcessInstance, print, print, printClassification, printClassification, printClassifications, printClassifications, printFooter, printHeader, setAttributes, setBuffer, setHeader, setNumDecimals, setOutputDistribution, setOutputFile, setSuppressOutput, suppressOutputTipText

Methods inherited from class java.lang.Object

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

Field Detail

m_Delimiter

protected java.lang.String m_Delimiter

the delimiter.

Constructor Detail

CSV

public CSV()

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing the output generator.

Specified by:

globalInfo in class AbstractOutput

Returns:

a description suitable for displaying in the GUI

getDisplay

public java.lang.String getDisplay()

Returns a short display text, to be used in comboboxes.

Specified by:

getDisplay in class AbstractOutput

Returns:

a short display text

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration of all the available options..

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class AbstractOutput

Returns:

an enumeration of all available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Sets the OptionHandler's options using the given list. All options will be set (or reset) during this call (i.e. incremental setting of options is not possible).

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class AbstractOutput

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current option settings for the OptionHandler.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class AbstractOutput

Returns:

the list of current option settings as an array of strings

setUseTab

public void setUseTab(boolean value)

Sets whether to use tab instead of comma as separator.

Parameters:

value - true if tab is to be used

getUseTab

public boolean getUseTab()

Returns whether tab is used as separator.

Returns:

true if tab is used instead of comma

useTabTipText

public java.lang.String useTabTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI

doPrintHeader

protected void doPrintHeader()

Performs the actual printing of the header.

Specified by:

doPrintHeader in class AbstractOutput

attributeValuesString

protected java.lang.String attributeValuesString(Instance instance)

Builds a string listing the attribute values in a specified range of indices, separated by commas and enclosed in brackets.

Parameters:

instance - the instance to print the values from

Returns:

a string listing values of the attributes in the range

doPrintClassification

protected void doPrintClassification(double[] dist,
                                     Instance inst,
                                     int index)
                              throws java.lang.Exception

Store the prediction made by the classifier as a string.

Specified by:

doPrintClassification in class AbstractOutput

Parameters:

dist - the distribution to use

inst - the instance to generate text from

index - the index in the dataset

Throws:

java.lang.Exception - if something goes wrong

doPrintClassification

protected void doPrintClassification(Classifier classifier,
                                     Instance inst,
                                     int index)
                              throws java.lang.Exception

Store the prediction made by the classifier as a string.

Specified by:

doPrintClassification in class AbstractOutput

Parameters:

classifier - the classifier to use

inst - the instance to generate text from

index - the index in the dataset

Throws:

java.lang.Exception - if something goes wrong

doPrintFooter

protected void doPrintFooter()

Does nothing.

Specified by:

doPrintFooter in class AbstractOutput