Name

adams.flow.transformer.WekaFilter

Synopsis

Filters Instances/Instance objects using the specified filter.
When re-using a trained filter, ensure that 'initializeOnce' is checked.

The following order is used to obtain the model (when using AUTO):
1. model file present?
2. source actor present?
3. storage item present?
4. use specified filter definition

Additional information

Flow input/output:
- input: weka.core.Instance, weka.core.Instances, adams.data.instance.Instance
- output: weka.core.Instance, weka.core.Instances, adams.data.instance.Instance

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	WekaFilter

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• properties
  

  The properties to update with the values associated with the specified values.

  command-line	-property <adams.core.base.BaseString> [-property ...]
  default

  
  
• variableNames
  

  The names of the variables to update the properties with.

  command-line	-variable <adams.core.VariableName> [-variable ...]
  default

  
  
• filter
  

  The filter to use for filtering the Instances/Instance objects.

  command-line	-filter <weka.filters.Filter>
  default	weka.filters.AllFilter

  
  
• modelLoadingType
  

  Determines how to load the model, in case of AUTO, first the model file is checked, then the callable actor and then the storage.

  command-line	-model-loading-type <AUTO|FILE|SOURCE_ACTOR|STORAGE>
  default	AUTO

  
  
• modelFile
  

  The file to load the model from, ignored if pointing to a directory.

  command-line	-model <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• modelActor
  

  The callable actor (source) to obtain the model from, ignored if not present.

  command-line	-source <adams.flow.core.CallableActorReference>
  default

  
  
• modelStorage
  

  The storage item to obtain the model from, ignored if not present.

  command-line	-storage <adams.flow.control.StorageName>
  default	storage

  
  
• initializeOnce
  

  If set to true, then the filter will get initialized only with the first batch of data; otherwise every time data gets passed through; only applies when using the filter definition, the others (model file, source, storage) assume the filter to be built.

  command-line	-init-once <boolean>
  default	false

  
  
• keepRelationName
  

  If set to true, then the filter won't change the relation name of the incoming dataset.

  command-line	-keep <boolean>
  default	false

  
  
• preferJobRunner
  

  If enabled, tries to offload the processing onto a adams.flow.standalone.JobRunnerInstance; applies only to batch filtering.

  command-line	-prefer-jobrunner <boolean>
  default	false

  
  
• outputContainer
  

  If enabled, a adams.flow.container.WekaFilterContainer is output with the filter and the filtered data (Instance or Instances).

  command-line	-output-container <boolean>
  default	false