com.yobotics.simulationconstructionset.util.math.filter
Class BetaFilteredYoVariable

java.lang.Object
  extended by com.yobotics.simulationconstructionset.YoVariable
      extended by com.yobotics.simulationconstructionset.DoubleYoVariable
          extended by com.yobotics.simulationconstructionset.util.math.filter.BetaFilteredYoVariable
All Implemented Interfaces:
java.io.Serializable

public class BetaFilteredYoVariable
extends DoubleYoVariable

Author:
thutcheson

A BetaFilteredYoVariable is a filtered version of an input YoVar. Either a YoVariable holding the unfiltered val is passed in to the constructor and update() is called every tick, or update(double) is called every tick. The BetaFilteredYoVariable updates it's val with the current filtered version using

            filtered_{n} = (raw_{0} + ... + raw_{n-1} + raw_{n}) / n
         
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.yobotics.simulationconstructionset.YoVariable
MAX_LENGTH_SHORT_NAME
 
Constructor Summary
BetaFilteredYoVariable(java.lang.String name, YoVariableRegistry registry, int beta)
           
BetaFilteredYoVariable(java.lang.String name, YoVariableRegistry registry, int beta, DoubleYoVariable positionVariable)
           
 
Method Summary
 void reset()
           
 void update()
           
 void update(double currentPosition)
           
 
Methods inherited from class com.yobotics.simulationconstructionset.DoubleYoVariable
add, add, getDoubleValue, getValueAsDouble, getValueString, getValueStringFromDouble, getYoVariableType, isNaN, mul, mul, set, setValueFromDouble, sub, sub, toString, valueEquals
 
Methods inherited from class com.yobotics.simulationconstructionset.YoVariable
addVariableChangedListener, fullNameEndsWithCaseInsensitive, getDescription, getFullNameWithNameSpace, getManualScalingMax, getManualScalingMin, getName, getName, getNameAndValueString, getNameAndValueStringFromDouble, getNameSpace, getNumericValueAsAString, getShortName, getVariableChangedListeners, getYoVariableRegistry, hasSameFullName, notifyVariableChangedListeners, removeAllVariableChangedListeners, removeVariableChangedListener, setManualScalingMinMax
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BetaFilteredYoVariable

public BetaFilteredYoVariable(java.lang.String name,
                              YoVariableRegistry registry,
                              int beta)

BetaFilteredYoVariable

public BetaFilteredYoVariable(java.lang.String name,
                              YoVariableRegistry registry,
                              int beta,
                              DoubleYoVariable positionVariable)
Method Detail

reset

public void reset()

update

public void update()

update

public void update(double currentPosition)