Package adams.flow.transformer

Class WekaExtractPLSMatrix

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class WekaExtractPLSMatrix
extends AbstractTransformer
    Transformer that allows the extraction of internal PLS filter/classifier matrices, forwarding them as spreadsheets.

    Input/output:
    - accepts:
       weka.classifiers.Classifier
       weka.filters.Filter
       weka.core.PLSMatrixAccess
       adams.flow.container.WekaModelContainer
    - generates:
       adams.data.spreadsheet.SpreadSheet


    Container information:
    - adams.flow.container.WekaModelContainer: Model, Header, Dataset

    Valid options are: 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WekaExtractPLSMatrix
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -matrix-type <PLS1_REGVECTOR|PLS1_P|PLS1_W|PLS1_B_HAT|SIMPLS_W|SIMPLS_B> (property: matrixType)
    The type of matrix to extract, either PLS1 or SIMPLS will be available.
    default: PLS1_P
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • WekaExtractPLSMatrix

        public WekaExtractPLSMatrix()

    • Method Detail

      • matrixTypeTipText

        public String matrixTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • getMatrix

        protected SpreadSheet getMatrix​(weka.classifiers.Classifier classifier)
        Returns the spreadsheet representation of the chosen from the classifier.
        Parameters:
        classifier - the classifier to extract the matrix from
        Returns:
        the generated spreadsheet, null if matrix not available

      • getMatrix

        protected SpreadSheet getMatrix​(PLSMatrixAccess obj)
        Returns the spreadsheet representation of the chosen from the classifier/filter.
        Parameters:
        obj - the classifier/filter to extract the matrix from
        Returns:
        the generated spreadsheet, null if matrix not available

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message