CanopyMapTask

java.lang.Object
- weka.distributed.CanopyMapTask

All Implemented Interfaces:

java.io.Serializable, weka.core.EnvironmentHandler, weka.core.OptionHandler
```
public class CanopyMapTask
extends java.lang.Object
implements weka.core.OptionHandler, weka.core.EnvironmentHandler, java.io.Serializable
```
Map task for building partial canopies

Version:

$Revision: 11431 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CanopyMapTask.ECanopy
Subclass of Canopy that gives us access to the distance function

Nested Classes
Modifier and Type	Class and Description
`static class`	`CanopyMapTask.ECanopy` Subclass of Canopy that gives us access to the distance function

Field Summary

Fields
Modifier and Type Field and Description

double m_hT1
heuristic value for T1

double m_hT2
heuristic value for T2

Fields
Modifier and Type	Field and Description
`double`	`m_hT1` heuristic value for T1
`double`	`m_hT2` heuristic value for T2

Constructor Summary

Constructors
Constructor and Description

CanopyMapTask()

Constructors
Constructor and Description
`CanopyMapTask()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`dontReplaceMissingValuesTipText()` Returns the tip text for this property.
`java.lang.String`	`environmentSubstitute(java.lang.String orig)` Substitute environment variables in the supplied string.
`boolean`	`getDontReplaceMissingValues()` Gets whether missing values are to be replaced.
`weka.filters.Filter[]`	`getFiltersToUse()` Get the filters to wrap up with the base classifier
`weka.clusterers.Clusterer`	`getFinalizedClusterer()`
`static double`	`getHeuristicT2(weka.core.Instances headerWithSummary)`
`java.lang.String`	`getMaxNumCandidateCanopiesToHoldInMemory()` Get the maximum number of candidate canopies to retain in memory during training.
`java.lang.String`	`getMaxNumCanopies()` Get the number of clusters to find by this map task.
`java.lang.String`	`getMinimumCanopyDensity()` Get the minimum T2-based density below which a canopy will be pruned during periodic pruning.
`java.lang.String[]`	`getOptions()`
`java.lang.String`	`getPeriodicPruningRate()` Get the how often to prune low density canopies during training
`java.lang.String`	`getT1MapPhase()` Get the T1 distance.
`java.lang.String`	`getT2MapPhase()` Get the T2 distance to use.
`void`	`init(weka.core.Instances headerWithSummary)`
`java.util.Enumeration<weka.core.Option>`	`listOptions()`
`java.lang.String`	`maxNumCandidateCanopiesToHoldInMemory()` Returns the tip text for this property.
`java.lang.String`	`minimumCanopyDensityTipText()` Returns the tip text for this property.
`java.lang.String`	`periodicPruningRateTipText()` Returns the tip text for this property.
`void`	`setDontReplaceMissingValues(boolean r)` Sets whether missing values are to be replaced.
`void`	`setEnvironment(weka.core.Environment env)`
`void`	`setFiltersToUse(weka.filters.Filter[] toUse)` Set the filters to wrap up with the base classifier
`void`	`setMaxNumCandidateCanopiesToHoldInMemory(java.lang.String max)` Set the maximum number of candidate canopies to retain in memory during training.
`void`	`setMaxNumCanopies(java.lang.String c)` Set the maximum number of clusters to find in this map task.
`void`	`setMinimumCanopyDensity(java.lang.String dens)` Set the minimum T2-based density below which a canopy will be pruned during periodic pruning.
`void`	`setOptions(java.lang.String[] options)`
`void`	`setPeriodicPruningRate(java.lang.String p)` Set the how often to prune low density canopies during training
`void`	`setT1MapPhase(java.lang.String t1)` Set the T1 distance.
`void`	`setT2MapPhase(java.lang.String t2)` Set the T2 distance to use.
`java.lang.String`	`t1MapPhaseTipText()` Tip text for this property
`java.lang.String`	`t2MapPhaseTipText()` Tip text for this property
`void`	`update(weka.core.Instance inst)`
`void`	`updateFinished()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface weka.core.OptionHandler
makeCopy

- Field Detail
  - m_hT1
```
public double m_hT1
```
    heuristic value for T1
  - m_hT2
```
public double m_hT2
```
    heuristic value for T2
- Constructor Detail
  - CanopyMapTask
```
public CanopyMapTask()
```
- Method Detail
  - environmentSubstitute
```
public java.lang.String environmentSubstitute(java.lang.String orig)
```
    Substitute environment variables in the supplied string.
    
    Parameters:
    
    orig - the string to modify
    
    Returns:
    
    the string with environment variables resolved
  - init
```
public void init(weka.core.Instances headerWithSummary)
          throws DistributedWekaException
```
    Throws:
    
    DistributedWekaException
  - update
```
public void update(weka.core.Instance inst)
            throws DistributedWekaException
```
    Throws:
    
    DistributedWekaException
  - updateFinished
```
public void updateFinished()
```
  - getFinalizedClusterer
```
public weka.clusterers.Clusterer getFinalizedClusterer()
                                                throws DistributedWekaException
```
    Throws:
    
    DistributedWekaException
  - getHeuristicT2
```
public static double getHeuristicT2(weka.core.Instances headerWithSummary)
                             throws DistributedWekaException
```
    Throws:
    
    DistributedWekaException
  - listOptions
```
public java.util.Enumeration<weka.core.Option> listOptions()
```
    Specified by:
    
    listOptions in interface weka.core.OptionHandler
  - setOptions
```
public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
```
    Specified by:
    
    setOptions in interface weka.core.OptionHandler
    
    Throws:
    
    java.lang.Exception
  - getOptions
```
public java.lang.String[] getOptions()
```
    Specified by:
    
    getOptions in interface weka.core.OptionHandler
  - setMaxNumCanopies
```
public void setMaxNumCanopies(java.lang.String c)
```
    Set the maximum number of clusters to find in this map task. Fewer clusters may be found than the specified maximum.
    
    Parameters:
    
    c - the maximum number of clusters to find
  - getMaxNumCanopies
```
public java.lang.String getMaxNumCanopies()
```
    Get the number of clusters to find by this map task. Fewer clusters may be found than the specified maximum.
    
    Returns:
    
    the maximum number of clusters to find
  - periodicPruningRateTipText
```
public java.lang.String periodicPruningRateTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setPeriodicPruningRate
```
public void setPeriodicPruningRate(java.lang.String p)
```
    Set the how often to prune low density canopies during training
    
    Parameters:
    
    p - how often (every p instances) to prune low density canopies
  - getPeriodicPruningRate
```
public java.lang.String getPeriodicPruningRate()
```
    Get the how often to prune low density canopies during training
    
    Returns:
    
    how often (every p instances) to prune low density canopies
  - minimumCanopyDensityTipText
```
public java.lang.String minimumCanopyDensityTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setMinimumCanopyDensity
```
public void setMinimumCanopyDensity(java.lang.String dens)
```
    Set the minimum T2-based density below which a canopy will be pruned during periodic pruning.
    
    Parameters:
    
    dens - the minimum canopy density
  - getMinimumCanopyDensity
```
public java.lang.String getMinimumCanopyDensity()
```
    Get the minimum T2-based density below which a canopy will be pruned during periodic pruning.
    
    Returns:
    
    the minimum canopy density
  - maxNumCandidateCanopiesToHoldInMemory
```
public java.lang.String maxNumCandidateCanopiesToHoldInMemory()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setMaxNumCandidateCanopiesToHoldInMemory
```
public void setMaxNumCandidateCanopiesToHoldInMemory(java.lang.String max)
```
    Set the maximum number of candidate canopies to retain in memory during training. T2 distance and data characteristics determine how many candidate canopies are formed before periodic and final pruning are performed. There may not be enough memory available if T2 is set too low.
    
    Parameters:
    
    max - the maximum number of candidate canopies to retain in memory during training
  - getMaxNumCandidateCanopiesToHoldInMemory
```
public java.lang.String getMaxNumCandidateCanopiesToHoldInMemory()
```
    Get the maximum number of candidate canopies to retain in memory during training. T2 distance and data characteristics determine how many candidate canopies are formed before periodic and final pruning are performed. There may not be enough memory available if T2 is set too low.
    
    Returns:
    
    the maximum number of candidate canopies to retain in memory during training
  - dontReplaceMissingValuesTipText
```
public java.lang.String dontReplaceMissingValuesTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setDontReplaceMissingValues
```
public void setDontReplaceMissingValues(boolean r)
```
    Sets whether missing values are to be replaced.
    
    Parameters:
    
    r - true if missing values are to be replaced
  - getDontReplaceMissingValues
```
public boolean getDontReplaceMissingValues()
```
    Gets whether missing values are to be replaced.
    
    Returns:
    
    true if missing values are to be replaced
  - t1MapPhaseTipText
```
public java.lang.String t1MapPhaseTipText()
```
    Tip text for this property
    
    Returns:
    
    the tip text for this property
  - setT1MapPhase
```
public void setT1MapPhase(java.lang.String t1)
```
    Set the T1 distance. Values < 0 are taken as a positive multiplier for the T2 distance - e.g. T1_actual = Math.abs(t1) * t2;
    
    Parameters:
    
    t1 - the T1 distance to use
  - getT1MapPhase
```
public java.lang.String getT1MapPhase()
```
    Get the T1 distance. Values < 0 are taken as a positive multiplier for the T2 distance - e.g. T1_actual = Math.abs(t1) * t2;
    
    Returns:
    
    the T1 distance to use
  - t2MapPhaseTipText
```
public java.lang.String t2MapPhaseTipText()
```
    Tip text for this property
    
    Returns:
    
    the tip text for this property
  - setT2MapPhase
```
public void setT2MapPhase(java.lang.String t2)
```
    Set the T2 distance to use. Values < 0 indicate that a heuristic based on attribute standard deviation should be used to set this (note that the heuristic is only applicable when batch training).
    
    Parameters:
    
    t2 - the T2 distance to use
  - getT2MapPhase
```
public java.lang.String getT2MapPhase()
```
    Get the T2 distance to use. Values < 0 indicate that a heuristic based on attribute standard deviation should be used to set this (note that the heuristic is only applicable when batch training).
    
    Returns:
    
    the T2 distance to use
  - getFiltersToUse
```
public weka.filters.Filter[] getFiltersToUse()
```
    Get the filters to wrap up with the base classifier
    
    Returns:
    
    the filters to wrap up with the base classifier
  - setFiltersToUse
```
public void setFiltersToUse(weka.filters.Filter[] toUse)
```
    Set the filters to wrap up with the base classifier
    
    Parameters:
    
    toUse - filters to wrap up with the base classifier
  - setEnvironment
```
public void setEnvironment(weka.core.Environment env)
```
    Specified by:
    
    setEnvironment in interface weka.core.EnvironmentHandler

Class CanopyMapTask

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface weka.core.OptionHandler

Field Detail

m_hT1

m_hT2

Constructor Detail

CanopyMapTask

Method Detail

environmentSubstitute

init

update

updateFinished

getFinalizedClusterer

getHeuristicT2

listOptions

setOptions

getOptions

setMaxNumCanopies

getMaxNumCanopies

periodicPruningRateTipText

setPeriodicPruningRate

getPeriodicPruningRate

minimumCanopyDensityTipText

setMinimumCanopyDensity

getMinimumCanopyDensity

maxNumCandidateCanopiesToHoldInMemory

setMaxNumCandidateCanopiesToHoldInMemory

getMaxNumCandidateCanopiesToHoldInMemory

dontReplaceMissingValuesTipText

setDontReplaceMissingValues

getDontReplaceMissingValues

t1MapPhaseTipText

setT1MapPhase

getT1MapPhase

t2MapPhaseTipText

setT2MapPhase

getT2MapPhase

getFiltersToUse

setFiltersToUse

setEnvironment