|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.NodeModel
org.knime.base.node.mine.cluster.fuzzycmeans.FuzzyClusterNodeModel
public class FuzzyClusterNodeModel
Generate a fuzzy c-means clustering using a fixed number of cluster centers.
Field Summary | |
---|---|
static String |
CFGKEY_KEEPALL
Config key to keep all columns in include list. |
static String |
CLUSTER_KEY
Key for the Cluster Columns in the output DataTable. |
static String |
DELTAVALUE_KEY
Key to store the delta value in the config. |
static String |
FUZZIFIER_KEY
Key to store the fuzzifier in the settings. |
static String |
INCLUDELIST_KEY
Key to store the excluded column list in the settings. |
(package private) static int |
INPORT
The input port used here. |
static String |
LAMBDAVALUE_KEY
Key to store the lambda value in the config. |
static String |
MAXITERATIONS_KEY
Key to store the number of maximal iterations in the settings. |
static String |
MEASURES_KEY
Key to store whether cluster quality measures should be calculated. |
static String |
MEMORY_KEY
Key to store whether the clustering should be performed in memory in the PredParams. |
static String |
NOISE_KEY
Key to store wheher a noise cluster is induced. |
static String |
NOISESPEC_KEY
Key for the Cluster Columns in the output DataTable. |
static String |
NRCLUSTERS_KEY
Key to store the number of clusters in the settings. |
(package private) static int |
OUTPORT
The output port used here. |
Constructor Summary | |
---|---|
FuzzyClusterNodeModel()
Constructor, remember parent and initialize status. |
Method Summary | |
---|---|
protected PortObjectSpec[] |
configure(PortObjectSpec[] inSpecs)
Number of columns in the output table is not deterministic. |
protected PortObject[] |
execute(PortObject[] inData,
ExecutionContext exec)
Generate new clustering based on InputDataTable and specified number of clusters. |
double |
getBetweenClusterVariation()
Calculates the Between-Cluster Variation. |
double[][] |
getClusterCentres()
|
double[] |
getFuzzyHyperVolumes()
Calculates the fuzzy hypervolumnes for each cluster. |
double |
getPartitionCoefficient()
Calculates the partition coefficient. |
double |
getPartitionEntropy()
Calculates the partition entropy. |
double[][] |
getweightMatrix()
|
double[] |
getWithinClusterVariations()
Calculates the Within-Cluster Variation for each cluster. |
double |
getXieBeniIndex()
Calculates the Xie Beni Index. |
protected void |
loadInternals(File internDir,
ExecutionMonitor exec)
Load internals into the derived NodeModel . |
protected void |
loadValidatedSettingsFrom(NodeSettingsRO settings)
Loads the number of clusters and the maximum number of iterations from the settings. |
boolean |
noiseClustering()
|
void |
reset()
Override this function in the derived model and reset your NodeModel . |
protected void |
saveInternals(File internDir,
ExecutionMonitor exec)
Save internals of the derived NodeModel . |
protected void |
saveSettingsTo(NodeSettingsWO settings)
Saves the number of Clusters and the maximum number of iterations in the settings. |
protected void |
validateSettings(NodeSettingsRO settings)
Validates the number of Clusters and the maximum number of iterations in the settings. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CLUSTER_KEY
public static final String NOISESPEC_KEY
public static final String NRCLUSTERS_KEY
public static final String MAXITERATIONS_KEY
public static final String FUZZIFIER_KEY
public static final String INCLUDELIST_KEY
public static final String NOISE_KEY
public static final String DELTAVALUE_KEY
public static final String LAMBDAVALUE_KEY
public static final String MEMORY_KEY
public static final String MEASURES_KEY
public static final String CFGKEY_KEEPALL
static final int INPORT
static final int OUTPORT
Constructor Detail |
---|
public FuzzyClusterNodeModel()
Method Detail |
---|
protected PortObject[] execute(PortObject[] inData, ExecutionContext exec) throws Exception
PortObject classes
that are defined through the
PortTypes
given in the
constructor
.
Similarly, the returned output objects need to comply with their port
types object class (otherwise an error is reported by the framework).
For a general description of the execute method refer to the description
of the specialized
NodeModel.execute(BufferedDataTable[], ExecutionContext)
methods as it
addresses more use cases.
execute
in class NodeModel
inData
- The input objects.exec
- For BufferedDataTable
creation and progress.
Exception
- If the node execution fails for any reason.public void reset()
NodeModel
. All components should unregister themselves
from any observables (at least from the hilite handler right now). All
internally stored data structures should be released. User settings
should not be deleted/reset though.
reset
in class NodeModel
protected void saveSettingsTo(NodeSettingsWO settings)
NodeSettings
the model specific
settings. The settings don't need to be complete or consistent. If, right
after startup, no valid settings are available this method can write
either nothing or invalid settings.
Method is called by the Node
if the current settings need
to be saved or transfered to the node's dialog.
saveSettingsTo
in class NodeModel
settings
- The object to write settings into.NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected void validateSettings(NodeSettingsRO settings) throws InvalidSettingsException
NodeSettings
object.
The specified settings should be checked for completeness and
consistency. It must be possible to load a settings object validated
here without any exception in the
#loadValidatedSettings(NodeSettings)
method. The method
must not change the current settings in the model - it is supposed to
just check them. If some settings are missing, invalid, inconsistent, or
just not right throw an exception with a message useful to the user.
validateSettings
in class NodeModel
settings
- The settings to validate.
InvalidSettingsException
- If the validation of the settings
failed.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
protected void loadValidatedSettingsFrom(NodeSettingsRO settings) throws InvalidSettingsException
#validateSettings(NodeSettings)
method. The model must set
its internal configuration according to the settings object passed.
loadValidatedSettingsFrom
in class NodeModel
settings
- The settings to read.
InvalidSettingsException
- If a property is not available.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected PortObjectSpec[] configure(PortObjectSpec[] inSpecs) throws InvalidSettingsException
PortObjectSpecs
that are defined through the
PortTypes
given in the
constructor
.
Similarly, the returned output specs need to comply with their port types
spec class (otherwise an error is reported by the framework). They may
also be null.
For a general description of the configure method refer to the
description of the specialized NodeModel.configure(DataTableSpec[])
methods as it addresses more use cases.
configure
in class NodeModel
inSpecs
- The input object specs.
InvalidSettingsException
- If this node can't be configured.public double[][] getClusterCentres()
public double[][] getweightMatrix()
public double getBetweenClusterVariation()
public double getPartitionCoefficient()
public double getPartitionEntropy()
public double getXieBeniIndex()
public double[] getWithinClusterVariations()
public double[] getFuzzyHyperVolumes()
public boolean noiseClustering()
protected void loadInternals(File internDir, ExecutionMonitor exec) throws IOException
NodeModel
. This method is
only called if the Node
was executed. Read all your
internal structures from the given file directory to create your internal
data structure which is necessary to provide all node functionalities
after the workflow is loaded, e.g. view content and/or hilite mapping.
loadInternals
in class NodeModel
internDir
- The directory to read from.exec
- Used to report progress and to cancel the load process.
IOException
- If an error occurs during reading from this dir.NodeModel.saveInternals(File,ExecutionMonitor)
protected void saveInternals(File internDir, ExecutionMonitor exec) throws IOException
NodeModel
. This method is
only called if the Node
is executed. Write all your
internal structures into the given file directory which are necessary to
recreate this model when the workflow is loaded, e.g. view content and/or
hilite mapping.
saveInternals
in class NodeModel
internDir
- The directory to write into.exec
- Used to report progress and to cancel the save process.
IOException
- If an error occurs during writing to this dir.NodeModel.loadInternals(File,ExecutionMonitor)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |