niFgen_EnableAnalogFilter
ViStatus niFgen_EnableAnalogFilter (ViSession vi, ViConstString channelName, ViReal64 filterCorrectionFrequency);
Purpose
Enables the analog filter. You can also specify the filter correction frequency of the analog filter. This sets the NIFGEN_ATTR_ANALOG_FILTER_ENABLED attribute to VI_TRUE. This function is valid in Arbitrary Waveform, Arbitrary Sequence, and Script output modes. This function can also be used in Standard Function and Frequency List output modes for user-defined waveforms.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. |
| channelName | ViConstString | Specifies the channel name for which you want to enable the analog filter.
Default Value: "0" |
| filterCorrectionFrequency | ViReal64 | Specifies the filter correction frequency of the analog filter. On the NI 5411 and NI 5431,
NI-FGEN adjusts signal amplitude to compensate for the filter attenuation at that
frequency. To disable amplitude correction, set filterCorrectionFrequency to 0. For
Standard function output mode, the filter correction frequency typically should be set to
the same value as the frequency of the standard waveform.
Units: hertz Default Value: 0 |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|