TrcIIRFilter

java.lang.Object

trclib.dataprocessor.TrcFilter

trclib.dataprocessor.TrcIIRFilter

public class TrcIIRFilter extends TrcFilter

This class implements the Infinite Impulse Response filter. It is useful for filtering noise from the sensor data.

Field Summary

Fields

Modifier and Type

Field

Description

private static final double

DEF_WEIGHT

private double

filteredData

private final double

weight

Fields inherited from class trclib.dataprocessor.TrcFilter
instanceName, tracer
Constructor Summary

Constructors

Constructor

Description

TrcIIRFilter(String instanceName)

Constructor: Create an instance of the object.

TrcIIRFilter(String instanceName, double weight)

Constructor: Create an instance of the object.
Method Summary

Modifier and Type

Method

Description

double

filterData(double data)

This method returns the filtered data.

void

reset()

This method resets the filter.

Methods inherited from class trclib.dataprocessor.TrcFilter
toString

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

Field Details
- DEF_WEIGHT
  
  private static final double DEF_WEIGHT
  See Also:
  
  Constant Field Values
- weight
  
  private final double weight
- filteredData
  
  private double filteredData
Constructor Details
- TrcIIRFilter
  
  public TrcIIRFilter(String instanceName, double weight)
  
  Constructor: Create an instance of the object.
  
  Parameters:
  
  instanceName - specifies the instance name.
  
  weight - specifies the weight of the current data point.
- TrcIIRFilter
  
  public TrcIIRFilter(String instanceName)
  
  Constructor: Create an instance of the object.
  
  Parameters:
  
  instanceName - specifies the instance name.
Method Details
- reset
  
  public void reset()
  
  This method resets the filter.
  
  Specified by:
  
  reset in class TrcFilter
- filterData
  
  public double filterData(double data)
  
  This method returns the filtered data.
  
  Specified by:
  
  filterData in class TrcFilter
  
  Parameters:
  
  data - specifies the data value to be filtered.
  
  Returns:
  
  filtered data.