RfsgBurstDetection Class
- Updated2025-05-22
- 3 minute(s) read
Rfsg
Provides methods and properties used to configure the burst properties of a waveform.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIRfsgRfsgSubObject
NationalInstruments.ModularInstruments.NIRfsgRfsgBurstDetection
NationalInstruments.ModularInstruments.NIRfsgRfsgSubObject
NationalInstruments.ModularInstruments.NIRfsgRfsgBurstDetection
Namespace: NationalInstruments.ModularInstruments.NIRfsg
Assembly: NationalInstruments.ModularInstruments.NIRfsg.Fx45 (in NationalInstruments.ModularInstruments.NIRfsg.Fx45.dll) Version: 2025
Syntax
public sealed class RfsgBurstDetection : RfsgSubObject
Public NotInheritable Class RfsgBurstDetection Inherits RfsgSubObject
The RfsgBurstDetection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Enabled |
Enables the detection of burst start and burst stop locations in the waveform. Set this method to Enabled before writing a waveform to RFSG memory for detecting bursts.
You can read the detected burst start and burst stop locations using
GetWaveformBurstStartLocations and GetWaveformBurstStopLocations methods respectively.
When you download a waveform using ReadandDownloadWaveformFromfileTDMS and if RFBlankingproperty is enabled, you must set the RfsgBurstDetectionEnabled property to Disable. For PXIe-5830/5831/5832, the RF Blanking reserves a PXI trigger line. If you are calling any RfsgDriverUtility.ResetDevice or RfsaDriverUtility.ResetDevice on the same device, NI recommends calling it before committing blanking attributes. Alternatively, you can call RfsgDriverUtility.ResetWithOptions or RfsaDriverUtility.ResetWithOptions. Select Routes in the stepsToOmit parameter. |
| MinimumBurstTime | Sets or gets the minimum duration of the detected bursts. Any detected burst with a duration smaller than the value of this property is ignored by NI-RFSG.
This property is ignored when you disable the RfsgBurstDetectionEnabled property or when you set the RfsgBurstDetectionMode property to Auto. |
| MinimumQuietTime | Sets or gets the time duration for which the signal must be quiet before a valid burst start location or after a valid burst stop location.
This method is ignored when you disable the RfsgBurstDetectionEnabled or when you set the RfsgBurstDetectionModeproperty to Auto. |
| Mode | Sets or gets the algorithm that NI-RFSG uses to detect the burst start and burst stop locations in the waveform when burst detection is enabled using the RfsgBurstDetectionEnabled property. When you set RfsgBurstDetectionMode to Auto, NI-RFSG automatically detects the burst start and burst stop locations by analyzing the waveform. To fine-tune the burst detection process parameters yourself, you can set this attribute to Manual and specify the burst detection parameters using the MinimumQuietTime, PowerThreshold, and MinimumBurstTime methods. |
| PowerThreshold | Sets or gets the relative power level at which burst start or stop locations are detected.
The threshold is relative to the peak power in the waveform. NI-RFSG detects burst start (or burst stop) locations when the signal exceeds
(or falls below) the level specified by this property.
This property is ignored when you disable the RfsgBurstDetectionEnabled property or when you set the RfsgBurstDetectionMode property to Auto. |
Methods
| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |