public class KernelFilter extends SimpleBatchFilter implements UnsupervisedFilter, TechnicalInformationHandler
@inproceedings{Bennett2003, author = {K.P. Bennett and M.J. Embrechts}, booktitle = {Advances in Learning Theory: Methods, Models and Applications}, editor = {J. Suykens et al.}, pages = {227-249}, publisher = {IOS Press, Amsterdam, The Netherlands}, series = {NATO Science Series, Series III: Computer and System Sciences}, title = {An Optimization Perspective on Kernel Partial Least Squares Regression}, volume = {190}, year = {2003} }Valid options are:
-D Turns on output of debugging information.
-no-checks Turns off all checks - use with caution! Turning them off assumes that data is purely numeric, doesn't contain any missing values, and has a nominal class. Turning them off also means that no header information will be stored if the machine is linear. Finally, it also assumes that no instance has a weight equal to 0. (default: checks on)
-F <filename> The file to initialize the filter with (optional).
-C <num> The class index for the file to initialize with, First and last are valid (optional, default: last).
-K <classname and parameters> The Kernel to use. (default: weka.classifiers.functions.supportVector.PolyKernel)
-kernel-factor Defines a factor for the kernel. - RBFKernel: a factor for gamma Standardize: 1/(2*N) Normalize..: 6/N Available parameters are: N for # of instances, A for # of attributes (default: 1)
-P <classname and parameters> The Filter used for preprocessing (use weka.filters.AllFilter to disable preprocessing). (default: weka.filters.unsupervised.attribute.Center)
Options specific to kernel weka.classifiers.functions.supportVector.PolyKernel:
-D Enables debugging output (if available) to be printed. (default: off)
-no-checks Turns off all checks - use with caution! (default: checks on)
-C <num> The size of the cache (a prime number), 0 for full cache and -1 to turn it off. (default: 250007)
-E <num> The Exponent to use. (default: 1.0)
-L Use lower-order terms. (default: no)
Options specific to preprocessing filter weka.filters.unsupervised.attribute.Center:
-unset-class-temporarily Unsets the class index temporarily before the filter is applied to the data. (default: no)
Constructor and Description |
---|
KernelFilter() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
checksTurnedOffTipText()
Returns the tip text for this property
|
Capabilities |
getCapabilities()
Returns the Capabilities of this filter.
|
boolean |
getChecksTurnedOff()
Returns whether the checks are turned off or not.
|
java.io.File |
getInitFile()
Gets the file to initialize the filter with, can be null.
|
java.lang.String |
getInitFileClassIndex()
Gets the class index of the file to initialize the filter with.
|
Kernel |
getKernel()
Gets the kernel to use.
|
java.lang.String |
getKernelFactorExpression()
Gets the expression for the kernel.
|
java.lang.String[] |
getOptions()
Gets the current settings of the filter.
|
Filter |
getPreprocessing()
Gets the filter used for preprocessing
|
java.lang.String |
getRevision()
Returns the revision string.
|
TechnicalInformation |
getTechnicalInformation()
Returns an instance of a TechnicalInformation object, containing
detailed information about the technical background of this class,
e.g., paper reference or book this class is based on.
|
java.lang.String |
globalInfo()
Returns a string describing this filter.
|
java.lang.String |
initFileClassIndexTipText()
Returns the tip text for this property
|
java.lang.String |
initFileTipText()
Returns the tip text for this property
|
void |
initFilter(Instances instances)
initializes the filter with the given dataset, i.e., the kernel gets
built.
|
java.lang.String |
kernelFactorExpressionTipText()
Returns the tip text for this property
|
java.lang.String |
kernelTipText()
Returns the tip text for this property
|
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options.
|
static void |
main(java.lang.String[] args)
runs the filter with the given arguments
|
java.lang.String |
preprocessingTipText()
Returns the tip text for this property
|
void |
setChecksTurnedOff(boolean value)
Disables or enables the checks (which could be time-consuming).
|
void |
setInitFile(java.io.File value)
Sets the file to initialize the filter with, can be null.
|
void |
setInitFileClassIndex(java.lang.String value)
Sets class index of the file to initialize the filter with.
|
void |
setKernel(Kernel value)
Sets the kernel to use.
|
void |
setKernelFactorExpression(java.lang.String value)
Sets the expression for the kernel.
|
void |
setOptions(java.lang.String[] options)
Parses a given list of options.
|
void |
setPreprocessing(Filter value)
Sets the filter to use for preprocessing (use the AllFilter for no
preprocessing)
|
batchFinished, input
debugTipText, getDebug, setDebug, setInputFormat
batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper
public java.lang.String globalInfo()
globalInfo
in class SimpleFilter
public TechnicalInformation getTechnicalInformation()
getTechnicalInformation
in interface TechnicalInformationHandler
public java.util.Enumeration listOptions()
listOptions
in interface OptionHandler
listOptions
in class SimpleFilter
public java.lang.String[] getOptions()
getOptions
in interface OptionHandler
getOptions
in class SimpleFilter
public void setOptions(java.lang.String[] options) throws java.lang.Exception
-D Turns on output of debugging information.
-no-checks Turns off all checks - use with caution! Turning them off assumes that data is purely numeric, doesn't contain any missing values, and has a nominal class. Turning them off also means that no header information will be stored if the machine is linear. Finally, it also assumes that no instance has a weight equal to 0. (default: checks on)
-F <filename> The file to initialize the filter with (optional).
-C <num> The class index for the file to initialize with, First and last are valid (optional, default: last).
-K <classname and parameters> The Kernel to use. (default: weka.classifiers.functions.supportVector.PolyKernel)
-kernel-factor Defines a factor for the kernel. - RBFKernel: a factor for gamma Standardize: 1/(2*N) Normalize..: 6/N Available parameters are: N for # of instances, A for # of attributes (default: 1)
-P <classname and parameters> The Filter used for preprocessing (use weka.filters.AllFilter to disable preprocessing). (default: weka.filters.unsupervised.attribute.Center)
Options specific to kernel weka.classifiers.functions.supportVector.PolyKernel:
-D Enables debugging output (if available) to be printed. (default: off)
-no-checks Turns off all checks - use with caution! (default: checks on)
-C <num> The size of the cache (a prime number), 0 for full cache and -1 to turn it off. (default: 250007)
-E <num> The Exponent to use. (default: 1.0)
-L Use lower-order terms. (default: no)
Options specific to preprocessing filter weka.filters.unsupervised.attribute.Center:
-unset-class-temporarily Unsets the class index temporarily before the filter is applied to the data. (default: no)
setOptions
in interface OptionHandler
setOptions
in class SimpleFilter
options
- the list of options as an array of stringsjava.lang.Exception
- if an option is not supportedSimpleFilter.reset()
public java.lang.String initFileTipText()
public java.io.File getInitFile()
public void setInitFile(java.io.File value)
value
- the filepublic java.lang.String initFileClassIndexTipText()
public java.lang.String getInitFileClassIndex()
public void setInitFileClassIndex(java.lang.String value)
value
- the class indexpublic java.lang.String kernelTipText()
public Kernel getKernel()
public void setKernel(Kernel value)
value
- the kernelpublic void setChecksTurnedOff(boolean value)
value
- if true turns off all checkspublic boolean getChecksTurnedOff()
public java.lang.String checksTurnedOffTipText()
public java.lang.String kernelFactorExpressionTipText()
public java.lang.String getKernelFactorExpression()
public void setKernelFactorExpression(java.lang.String value)
value
- the filepublic java.lang.String preprocessingTipText()
public void setPreprocessing(Filter value)
value
- the preprocessing filterpublic Filter getPreprocessing()
public void initFilter(Instances instances) throws java.lang.Exception
instances
- the data to initialize withjava.lang.Exception
- if building of kernel failspublic Capabilities getCapabilities()
getCapabilities
in interface CapabilitiesHandler
getCapabilities
in class Filter
Capabilities
public java.lang.String getRevision()
getRevision
in interface RevisionHandler
getRevision
in class Filter
public static void main(java.lang.String[] args)
args
- the commandline arguments