MATLAB File Help: prtCluster

prtCluster

  prtCluster   Base class for prt clustering objects
 
    prtCluster is an abstract class and cannot be instantiated. 
 
    All prtCluster objects inherit all properities and methods from the
    prtAction object. 
 
    prtCluster objects have the following methods:
 
    plot          - Plot the output cluster of a trained clustering
                    algorithm. Only valid when the clutering algorithm
                    has been trained with a data set of 3 dimensions or
                    less.
 
    A prtCluster object inherits the TRAIN, RUN, CROSSVALIDATE and KFOLDS
    functions from the prtAction object.

See also

prtClusterGmm, prtClusterKmeans

Class Details

Superclasses	prtAction
Sealed	false
Construct on load	false

Constructor Summary

prtCluster

As an action subclass we must set the properties to reflect

Property Summary

dataSet	The training prtDataSet, only stored if verboseStorage is true.
dataSetSummary	Structure that summarizes prtDataSet.
includesDecision	Flag indicating if result includes a decision
internalDecider	Optional prtDecider object for making decisions
isCrossValidateValid	True
isSupervised	False
isTrained	Indicates if prtAction object has been trained.
nClusters	The number of clusters
name	Descriptive name of prtAction object.
nameAbbreviation	Shortened name for the prtAction object.
showProgressBar
userData	User specified data
verboseStorage	Specifies whether or not to store the training prtDataset.

Method Summary

	crossValidate	Cross validate prtAction using prtDataSet and cross validation keys.
	get	get the object properties
	kfolds	Perform K-folds cross-validation of prtAction
	optimize	Optimize action parameter by exhaustive function maximization.
	plot	Plot the output of the prtCluster object
	run	Run a prtAction object on a prtDataSet object.
	set	set the object properties
	train	Train a prtAction object using training a prtDataSet object.