Fmag_LPF_Enabled Property

Application
Force Trigger Object FT#, Force Monitor Object FM#

Description
Activates/inactivates or returns the resultant force low-pass filter.

Immediate Execution
No

Usage
FGet Object.Fmag_LPF_Enabled, bVar
FSet Object.Fmag_LPF_Enabled, bValue

• Object
  Object name
  The object is specified as either of FT (numerical value), FMR (numerical value), FT (label) or FMR (label).

• bVar
  A Boolean variable defining the value of the property

• bValue
  A Boolean value or formula defining the new value of the property

Values

Name of Constants	Values	Description
False	0	Sets the low-pass filter to inactive. (default)
True	-1	Sets the low-pass filter to active.

Detailed Explanation
Activates/inactivates or returns the resultant force low-pass filter.
When the low-pass filter is active, signal noise can be reduced, but the following performance for quick signal changes deteriorates.
The low-pass filter is used with AvgForces status, PeakForces status, the Force Trigger Function, and Force Monitor, but is not applied to Forces status.

Usage Example
This example sets the low-pass filter for resultant force and acquires the force peak data.

Function GetPeakForceTest
  Real myPeakForce
  FSet FCS1.Orientation, FG_TOOL
  FSet FM1.CoordinateSystem, FCS1
  FSet FM1.Fmag_Axes, FG_XYZ
  FSet FM1.Fmag_LPF_Enabled, True
  FSet FM1.Fmag_LPF_TimeConstant, 0.02
  FSet FM1.PeakForceClear, True, True, True, True, True, True, True, True
  Wait 10
  FGet FM1.Fmag_PeakForce, myPeakForce
  Print myPeakForce
Fend

See Also
Force Trigger Object FT#, Force Monitor Object FM#, Fmag_LPF_TimeConstant Property, LPF_Enabled Property