MATLAB File Help: prtClass
prtClass
  prtClass   Base class for prt Classification objects
 
  All prtClass objects inherit all properities and methods from the
  prtAction object. prtClass objects have the following additional
  properties:
  
    isNativeMary - Whather or not the classifier natively produces an
                   M-ary result.
 
    internalDecider - An optionl property, the default is empty.
                    InternalDecider is an instance of a prtDecision 
                    object. When set, the RUN function of the 
                    classifier will output discrete values
                    corresponding to the class determined by the 
                    classifier and the decision object
                    (binary classifier), or a binary vector of
                    zeros and ones (M-ary classification).
 
    prtClass objects have the following methods:
 
    plot          - Plot the output confidence of a trained classifier.
                    This function only operates when trained by a
                    dataset of 3 dimensions or lower.
 
    A prtClass object inherits the TRAIN, RUN, CROSSVALIDATE and KFOLDS
    functions from the prtAction object.
 
 
    
 
 
 
    Sub-classing prtClass:
        Concrete sub-classes of prtClass must define the abstract
    methods trainAction and runAction defined in prtAction.  These
    methods have function definitions as follows:
 
        Obj = trainAction(Obj, DataSet)
        DataSet = runAction(Obj, DataSet)
 
    Both methods are protected and hidden.  A concrete subclass of
    prtClass should contain code similar to the following:
 
 
      methods (Access = protected, Hidden = true)
          function Obj = trainAction(Obj, DataSet)
            %Code to set trained parameters of Obj
            
          end
 
          function DataSetOut = runAction(Obj, DataSet)
            %Code to run trained Obj on DataSet and generate DataSetOut
            %with observations set to the output of the classification
            %algorithm
 
          end
      end
See also
Class Details
Superclasses prtAction
Sealed false
Construct on load false
Constructor Summary
prtClass 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. 
internalDecider Optional prtDecider object for making decisions 
isCrossValidateValid True 
isNativeMary Logical, classifier natively produces an output for each unique class 
isSupervised True 
isTrained Indicates if prtAction object has been trained. 
name Descriptive name of prtAction object. 
nameAbbreviation Shortened name for the prtAction object. 
showProgressBar  
twoClassParadigm Whether the classifier retures one output (binary) or two outputs (m-ary) when there are only two unique class labels 
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 confidence of a prtClass 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.