SetNotchFilterBandwidth Method

Summary

Sets the notch filter bandwidth for the channel.

Syntax

C++

public bool SetNotchFilterBandwidth( 
   bool include, 
   double notchFilterBandwidth 
)

Public Function SetNotchFilterBandwidth( _ 
   ByVal include As Boolean, _ 
   ByVal notchFilterBandwidth As Double _ 
) As Boolean

public: 
bool SetNotchFilterBandwidth(  
   bool include, 
   double notchFilterBandwidth 
)

Parameters

include
true to insert the "Notch Filter Bandwidth" (003A,0223) element (that corresponds to this channel) into the dataset and then set its value, false to delete the "Notch Filter Bandwidth" (003A,0223) element (that corresponds to this channel) from the dataset.

notchFilterBandwidth
New notch filter bandwidth.

Return Value

true if the notch filter bandwidth was updated successfully, false if an error occurred.

Remarks

This method sets the value of the "Notch Filter Bandwidth" (003A,0223) element that corresponds to this channel. Set include to true to force the method to insert the element if it does not already exist in the dataset.

Example

For an example, refer to WaveformGroupCount.

Requirements

Target Platforms