RFmxPulseMXPulseConfiguration Class
- Updated2025-10-13
- 10 minute(s) read
Provides methods to configure the Pulse measurement.
Derives from
Syntax
Namespace: NationalInstruments.RFmx.PulseMX
public class RFmxPulseMXPulseConfiguration : RFmxPulseMXSubObject
Methods
| Name | Description |
|---|---|
| Configure1ReferenceWaveform(string, ComplexWaveform< ComplexSingle >) | Configures the reference pulse waveform used for time sidelobe measurements. |
| GetAcquisitionTraceSelect(string, out RFmxPulseMXPulseAcquisitionTraceSelect) | Gets the mode to select all pulses or the subset of acquired pulses available for display acquisition trace, limited to MaximumPulseCountEnabled method if set to True. |
| GetAcquisitionTraceSubsetLength(string, out int) | Gets the total number of pulses starting from offset to be used for display acquisition trace. You must configure this method when you set the PulseAcquisitionTraceSelect method to Subset. Set length to 0 to disable the acquisition trace. |
| GetAcquisitionTraceSubsetOffset(string, out int) | Gets the offset in number of pulses to be used for display acquisition trace. You must configure this method when you set the PulseAcquisitionTraceSelect method to Subset. |
| GetAllTracesEnabled(string, out bool) | Gets whether to enable storing and retrieving traces after performing the measurements. |
| GetAmplitudeLevelDomain(string, out RFmxPulseMXPulseAmplitudeLevelDomain) | Gets whether voltage or power to be used as domain for pulse measurements. |
| GetAmplitudeTraceUnit(string, out RFmxPulseMXPulseAmplitudeTraceUnit) | Gets the unit of the amplitude level. This method is applicable only for the amplitude and acquired amplitude trace. |
| GetDetectionHysteresis(string, out double) | Gets the hysteresis for pulse detection in dB for the defined threshold. |
| GetDetectionMaximumWidth(string, out double) | Gets the maximum pulse width time to be considered for pulse detection. Any detected pulse width time above the specified value will be ignored by the pulse detection. This value is expressed in seconds. |
| GetDetectionMinimumOffDuration(string, out double) | Gets the minimum pulse off duration to be ignored by the pulse detection. This value is expressed in seconds. |
| GetDetectionMinimumWidth(string, out double) | Gets the minimum pulse width time to be considered for pulse detection. Any detected pulse width time below the specified value will be ignored by the pulse detection. This value is expressed in seconds. |
| GetDetectionReference(string, out RFmxPulseMXPulseDetectionReference) | Gets the reference used for SetDetectionThreshold(string, double) method. |
| GetDetectionThreshold(string, out double) | Gets the threshold used for pulse detection. The unit dB or dBm is based on the value you set to the SetDetectionReference(string, RFmxPulseMXPulseDetectionReference) method. |
| GetDroopCompensationEnabled(string, out RFmxPulseMXPulseDroopCompensationEnabled) | Gets whether to compensate the droop detected in pulse level when applying thresholds. |
| GetFrequencyAndPhaseCWFrequencyOffset(string, out double) | Gets to manually enter the CW frequency offset. This method is valid only when you set the SetFrequencyAndPhaseModulationType(string, RFmxPulseMXPulseModulationType) method to CW. |
| GetFrequencyAndPhaseCWFrequencyOffsetAuto(string, out RFmxPulseMXPulseCWFrequencyOffsetAuto) | Gets whether the CW frequency offset computation of every detected pulse is automatic or manual. This method is valid only when you set the SetFrequencyAndPhaseModulationType(string, RFmxPulseMXPulseModulationType) method to CW. |
| GetFrequencyAndPhaseDeviationRangeEdgeStart(string, out double) | Gets the start of the pulse data used for the phase/frequency deviation and error measurements when you set the SetFrequencyAndPhaseDeviationRangeReference(string, RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) method to Edge. |
| GetFrequencyAndPhaseDeviationRangeEdgeStop(string, out double) | Gets the stop of the pulse data used for the phase/frequency deviation and error measurements when you set the SetFrequencyAndPhaseDeviationRangeReference(string, RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) method to Edge. |
| GetFrequencyAndPhaseDeviationRangeLength(string, out double) | Gets the length of the pulse data used for the phase/frequency deviation and error measurements when you set the SetFrequencyAndPhaseDeviationRangeReference(string, RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) method to Center. |
| GetFrequencyAndPhaseDeviationRangeReference(string, out RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) | Gets the reference used for the measurement range in phase/frequency deviation and error measurements. |
| GetFrequencyAndPhaseModulationType(string, out RFmxPulseMXPulseModulationType) | Gets the pulse modulation type used for the phase and frequency error, and pulsed FM Measurement. |
| GetLevelComputationMethod(string, out RFmxPulseMXPulseLevelComputationMethod) | Gets the algorithm used to detect the pulse levels. The algorithm is based on the histogram method of level detection as defined in IEEE Std 181-2011. |
| GetLowerThresholdLevel(string, out double) | Gets the lower threshold level as a percentage of the pulse amplitude used to signify the start of a rising or end of a falling edge. |
| GetMeasurementEnabled(string, out bool) | Gets whether pulse measurements are enabled.. |
| GetMeasurementPointAveragingDuration(string, out double) | Gets the length of the averaging window centered at the measurement point. A minimum of 1 sample is used internally. |
| GetMeasurementPointOffset(string, out double) | Gets the time offset of the measurement point within the pulse for phase, frequency, and stability measurements. |
| GetMeasurementPointReference(string, out RFmxPulseMXPulseMeasurementPointReference) | Gets the reference used for the measurement point calculation, in phase, frequency, and stability measurements. You can set measurement point based on a reference and offset. |
| GetMetricsAmplitudeDeviationUnit(string, out RFmxPulseMXPulseMetricsAmplitudeDeviationUnit) | Gets the unit for amplitude deviation results. This method is applicable only for droop, ripple and overshoot results. |
| GetMetricsEnabled(string, out RFmxPulseMXPulseMetricsEnabled) | Gets whether to enable pulse metrics results computation. |
| GetMultiburstEnabled(string, out RFmxPulseMXMultiburstEnabled) | Gets whether to enable pulse measurements on the multiple burst transmission. |
| GetMultiburstLength(string, out int) | Gets the number of pulses assigned to a single burst. |
| GetMultipleMeasurementPointsEnabled(string, out RFmxPulseMXPulseMultipleMeasurementPointsEnabled) | Gets whether to enable pulse stability measurements on multiple measurement points. This method is used to enable the multiple measurement points stability trace when you set the All Traces Enabled method to TRUE. |
| GetMultipleMeasurementPointsWindowStart(string, out double) | Gets the start of the measurement window used for multiple measurement points selection over pulse ON duration. |
| GetMultipleMeasurementPointsWindowStepSize(string, out double) | Gets the step size of multiple measurement points selection within the measurement window over pulse ON duration. A minimum of 1 sample step size is used internally. |
| GetMultipleMeasurementPointsWindowStop(string, out double) | Gets the stop of the measurement window used for multiple measurement points selection over pulse ON duration. |
| GetNumberOfAnalysisThreads(string, out int) | Gets the maximum number of threads used for parallelism for the pulse measurement. |
| GetSelectedBurstTrace(string, out int) | Gets the burst number selected for the display of traces. This method is applicable for IQ, amplitude and pulse stability traces. |
| GetSelectedPulseTrace(string, out int) | Gets the pulse number selected for displaying the traces. This method is valid only for IQ, amplitude and pulse stability traces. |
| GetStabilityEnabled(string, out RFmxPulseMXPulseStabilityEnabled) | Gets whether to enable pulse stability results computation. |
| GetStabilityFrequencyErrorCompensation(string, out RFmxPulseMXPulseStabilityFrequencyErrorCompensation) | Gets whether to compute and correct the frequency offset for stability results computation. This is an optional setting and in negligible frequency error condition you must set this method to Off to avoid incorrect results. |
| GetStabilityMeasurementOffset(string, out int) | Gets the offset in number of pulses to be used for pulse stability measurement. This method is applicable for average stability results and pulse-to-pulse stabilty trace. |
| GetStabilityPulseToPulseOffset(string, out int) | Gets the offset in number of pulses used for pulse-to-pulse stability measurement trace. |
| GetStabilityReferenceOffset(string, out int) | Gets the offset in number of pulses used for pulse stability reference computation. |
| GetTimeSidelobeEnabled(string, out RFmxPulseMXPulseTimeSidelobeEnabled) | Gets whether to enable pulse time sidelobe results computation. You can use the NationalInstruments.RFmx.PulseMX.RFmxPulseMXPulseConfiguration.Configure1ReferenceWaveform(string,NationalInstruments.ComplexWaveform<NationalInstruments.ComplexSingle>) function to set the reference waveform for correlation computation. |
| GetTimeSidelobeKeepOutTime(string, out double) | Gets keep out time for the time sidelobe measurements. |
| GetTimeSidelobeKeepOutTimeAuto(string, out RFmxPulseMXPulseTimeSidelobeKeepOutTimeAuto) | Gets whether the keep out time computation for the time sidelobe measurements is automatic or manual. |
| GetTimeSidelobeMinimumCorrelation(string, out double) | Gets the minimum peak correlation value for the time sidelobe measurements. |
| GetTimeSidelobeReferenceWindowType(string, out RFmxPulseMXPulseTimeSidelobeReferenceWindowType) | Gets the window type to be applied to the reference pulse to obtain correlated output for the time sidelobe measurements. |
| GetTraceRangeAuto(string, out RFmxPulseMXPulseTraceRangeAuto) | Gets whether the trace range computation of the selected pulse is automatic or manually configured by you. |
| GetTraceRangeLength(string, out double) | Gets the length in seconds of the trace range centered at the reference point. |
| GetTraceRangeOffset(string, out double) | Gets the time offset in seconds from the reference point to position the trace range. |
| GetTraceRangeReference(string, out RFmxPulseMXPulseTraceRangeReference) | Gets the reference point for positioning of trace range. You can set reference point based on reference and Pulse Trace Range Offset (s) value. |
| GetUpperThresholdLevel(string, out double) | Gets the upper threshold level as a percentage of the pulse amplitude used to signify the end of a rising edge or beginning of a falling edge. |
| GetWidthThresholdLevel(string, out double) | Gets the middle threshold level as a percentage of the pulse amplitude used to signify the mid-transition level between pulse states used for pulse width computation. |
| SetAcquisitionTraceSelect(string, RFmxPulseMXPulseAcquisitionTraceSelect) | Sets the mode to select all pulses or the subset of acquired pulses available for display acquisition trace, limited to MaximumPulseCountEnabled method if set to True. |
| SetAcquisitionTraceSubsetLength(string, int) | Sets the total number of pulses starting from offset to be used for display acquisition trace. You must configure this method when you set the PulseAcquisitionTraceSelect method to Subset. Set length to 0 to disable the acquisition trace. |
| SetAcquisitionTraceSubsetOffset(string, int) | Sets the offset in number of pulses to be used for display acquisition trace. You must configure this method when you set the PulseAcquisitionTraceSelect method to Subset. |
| SetAllTracesEnabled(string, bool) | Sets whether to enable storing and retrieving traces after performing the measurements. |
| SetAmplitudeLevelDomain(string, RFmxPulseMXPulseAmplitudeLevelDomain) | Sets whether voltage or power to be used as domain for pulse measurements. |
| SetAmplitudeTraceUnit(string, RFmxPulseMXPulseAmplitudeTraceUnit) | Sets the unit of the amplitude level. This method is applicable only for the amplitude trace. |
| SetDetectionHysteresis(string, double) | Sets the hysteresis for pulse detection in dB for the defined threshold. |
| SetDetectionMaximumWidth(string, double) | Sets the maximum pulse width time to be considered for pulse detection. Any detected pulse width time above the specified value will be ignored by the pulse detection. This value is expressed in seconds. |
| SetDetectionMinimumOffDuration(string, double) | Sets the minimum pulse off duration to be ignored by the pulse detection. This value is expressed in seconds. |
| SetDetectionMinimumWidth(string, double) | Sets the minimum pulse width time to be considered for pulse detection. Any detected pulse width time below the specified value will be ignored by the pulse detection. This value is expressed in seconds. |
| SetDetectionReference(string, RFmxPulseMXPulseDetectionReference) | Sets the reference used for SetDetectionThreshold(string, double) method. |
| SetDetectionThreshold(string, double) | Sets the threshold used for pulse detection. The unit dB or dBm is based on the value you set to the SetDetectionReference(string, RFmxPulseMXPulseDetectionReference) method. |
| SetDroopCompensationEnabled(string, RFmxPulseMXPulseDroopCompensationEnabled) | Sets whether to compensate the droop detected in pulse level when applying thresholds. |
| SetFrequencyAndPhaseCWFrequencyOffset(string, double) | Sets to manually enter the CW frequency offset. This method is valid only when you set the SetFrequencyAndPhaseModulationType(string, RFmxPulseMXPulseModulationType) method to CW. |
| SetFrequencyAndPhaseCWFrequencyOffsetAuto(string, RFmxPulseMXPulseCWFrequencyOffsetAuto) | Sets whether the CW frequency offset computation of every detected pulse is automatic or manual. This method is valid only when you set the SetFrequencyAndPhaseModulationType(string, RFmxPulseMXPulseModulationType) method to CW. |
| SetFrequencyAndPhaseDeviationRangeEdgeStart(string, double) | Sets the start of the pulse data used for the phase/frequency deviation and error measurements when you set the SetFrequencyAndPhaseDeviationRangeReference(string, RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) method to Edge. |
| SetFrequencyAndPhaseDeviationRangeEdgeStop(string, double) | Sets the stop of the pulse data used for the phase/frequency deviation and error measurements when you set the SetFrequencyAndPhaseDeviationRangeReference(string, RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) method to Edge. |
| SetFrequencyAndPhaseDeviationRangeLength(string, double) | Sets the length of the pulse data used for the phase/frequency deviation and error measurements when you set the SetFrequencyAndPhaseDeviationRangeReference(string, RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) method to Center. |
| SetFrequencyAndPhaseDeviationRangeReference(string, RFmxPulseMXPulseFrequencyAndPhaseDeviationRangeReference) | Sets the reference used for the measurement range in phase/frequency deviation and error measurements. |
| SetFrequencyAndPhaseModulationType(string, RFmxPulseMXPulseModulationType) | Sets the pulse modulation type used for the phase and frequency error, and pulsed FM Measurement. |
| SetLevelComputationMethod(string, RFmxPulseMXPulseLevelComputationMethod) | Sets the algorithm used to detect the pulse levels. The algorithm is based on the histogram method of level detection as defined in IEEE Std 181-2011. |
| SetLowerThresholdLevel(string, double) | Sets the lower threshold level as a percentage of the pulse amplitude used to signify the start of a rising or end of a falling edge. |
| SetMeasurementEnabled(string, bool) | Sets whether pulse measurements are enabled.. |
| SetMeasurementPointAveragingDuration(string, double) | Sets the length of the averaging window centered at the measurement point. A minimum of 1 sample is used internally. |
| SetMeasurementPointOffset(string, double) | Sets the time offset of the measurement point within the pulse for phase, frequency, and stability measurements. |
| SetMeasurementPointReference(string, RFmxPulseMXPulseMeasurementPointReference) | Sets the reference used for the measurement point calculation, in phase, frequency, and stability measurements. You can set measurement point based on a reference and offset. |
| SetMetricsAmplitudeDeviationUnit(string, RFmxPulseMXPulseMetricsAmplitudeDeviationUnit) | Sets the unit for amplitude deviation results. This method is applicable only for droop, ripple and overshoot results. |
| SetMetricsEnabled(string, RFmxPulseMXPulseMetricsEnabled) | Sets whether to enable pulse metrics results computation. |
| SetMultiburstEnabled(string, RFmxPulseMXMultiburstEnabled) | Sets whether to enable pulse measurements on the multiple burst transmission. |
| SetMultiburstLength(string, int) | Sets the number of pulses assigned to a single burst. |
| SetMultipleMeasurementPointsEnabled(string, RFmxPulseMXPulseMultipleMeasurementPointsEnabled) | Sets whether to enable pulse stability measurements on multiple measurement points. This method is used to enable the multiple measurement points stability trace when you set the All Traces Enabled method to TRUE. |
| SetMultipleMeasurementPointsWindowStart(string, double) | Sets the start of the measurement window used for multiple measurement points selection over pulse ON duration. |
| SetMultipleMeasurementPointsWindowStepSize(string, double) | Sets the step size of multiple measurement points selection within the measurement window over pulse ON duration. A minimum of 1 sample step size is used internally. |
| SetMultipleMeasurementPointsWindowStop(string, double) | Sets the stop of the measurement window used for multiple measurement points selection over pulse ON duration. |
| SetNumberOfAnalysisThreads(string, int) | Sets the maximum number of threads used for parallelism for the pulse measurement. |
| SetSelectedBurstTrace(string, int) | Sets the burst number selected for the display of traces. This method is applicable for IQ, amplitude and pulse stability traces. |
| SetSelectedPulseTrace(string, int) | Sets the pulse number selected for displaying the traces. This method is valid only for IQ, amplitude and pulse stability traces. |
| SetStabilityEnabled(string, RFmxPulseMXPulseStabilityEnabled) | Sets whether to enable pulse stability results computation. |
| SetStabilityFrequencyErrorCompensation(string, RFmxPulseMXPulseStabilityFrequencyErrorCompensation) | Sets whether to compute and correct the frequency offset for stability results computation. This is an optional setting and in negligible frequency error condition you must set this method to Off to avoid incorrect results. |
| SetStabilityMeasurementOffset(string, int) | Sets the offset in number of pulses to be used for pulse stability measurement. This method is applicable for average stability results and pulse-to-pulse stabilty trace. |
| SetStabilityPulseToPulseOffset(string, int) | Sets the offset in number of pulses used for pulse-to-pulse stability measurement trace. |
| SetStabilityReferenceOffset(string, int) | Sets the offset in number of pulses used for pulse stability reference computation. |
| SetTimeSidelobeEnabled(string, RFmxPulseMXPulseTimeSidelobeEnabled) | Sets whether to enable pulse time sidelobe results computation. You can use the NationalInstruments.RFmx.PulseMX.RFmxPulseMXPulseConfiguration.Configure1ReferenceWaveform(string,NationalInstruments.ComplexWaveform<NationalInstruments.ComplexSingle>) function to set the reference waveform for correlation computation. |
| SetTimeSidelobeKeepOutTime(string, double) | Sets keep out time for the time sidelobe measurements. |
| SetTimeSidelobeKeepOutTimeAuto(string, RFmxPulseMXPulseTimeSidelobeKeepOutTimeAuto) | Sets whether the keep out time computation for the time sidelobe measurements is automatic or manual. |
| SetTimeSidelobeMinimumCorrelation(string, double) | Sets the minimum peak correlation value for the time sidelobe measurements. |
| SetTimeSidelobeReferenceWindowType(string, RFmxPulseMXPulseTimeSidelobeReferenceWindowType) | Sets the window type to be applied to the reference pulse to obtain correlated output for the time sidelobe measurements. |
| SetTraceRangeAuto(string, RFmxPulseMXPulseTraceRangeAuto) | Sets whether the trace range computation of the selected pulse is automatic or manually configured by you. |
| SetTraceRangeLength(string, double) | Sets the length in seconds of the trace range centered at the reference point. |
| SetTraceRangeOffset(string, double) | Sets the time offset in seconds from the reference point to position the trace range. |
| SetTraceRangeReference(string, RFmxPulseMXPulseTraceRangeReference) | Sets the reference point for positioning of trace range. You can set reference point based on reference and Pulse Trace Range Offset (s) value. |
| SetUpperThresholdLevel(string, double) | Sets the upper threshold level as a percentage of the pulse amplitude used to signify the end of a rising edge or beginning of a falling edge. |
| SetWidthThresholdLevel(string, double) | Sets the middle threshold level as a percentage of the pulse amplitude used to signify the mid-transition level between pulse states used for pulse width computation. |