NI RFmx SpecAn PAVT Attributes - ni/grpc-device GitHub Wiki
- RFMXSPECAN_ATTR_PAVT_MEASUREMENT_ENABLED
- RFMXSPECAN_ATTR_PAVT_MEASUREMENT_LOCATION_TYPE
- RFMXSPECAN_ATTR_PAVT_MEASUREMENT_BANDWIDTH
- RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE
- RFMXSPECAN_ATTR_PAVT_NUMBER_OF_SEGMENTS
- RFMXSPECAN_ATTR_PAVT_SEGMENT_TYPE
- RFMXSPECAN_ATTR_PAVT_SEGMENT_START_TIME
- RFMXSPECAN_ATTR_PAVT_MEASUREMENT_OFFSET
- RFMXSPECAN_ATTR_PAVT_MEASUREMENT_LENGTH
- RFMXSPECAN_ATTR_PAVT_SEGMENT_MEASUREMENT_OFFSET
- RFMXSPECAN_ATTR_PAVT_SEGMENT_MEASUREMENT_LENGTH
- RFMXSPECAN_ATTR_PAVT_PHASE_UNWRAP_ENABLED
- RFMXSPECAN_ATTR_PAVT_FREQUENCY_OFFSET_CORRECTION_ENABLED
- RFMXSPECAN_ATTR_PAVT_FREQUENCY_TRACKING_ENABLED
- RFMXSPECAN_ATTR_PAVT_ALL_TRACES_ENABLED
- Results
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies whether to enable the Phase Amplitude Versus Time (PAVT) measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXSPECAN_VAL_FALSE. Get Function: RFmxSpecAn_PAVTGetMeasurementEnabled Set Function: RFmxSpecAn_PAVTSetMeasurementEnabled |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies whether the location at which the segment is measured is indicated by time or trigger. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXSPECAN_VAL_PAVT_MEASUREMENT_LOCATION_TYPE_TIME. Get Function: RFmxSpecAn_PAVTGetMeasurementLocationType Set Function: RFmxSpecAn_PAVTSetMeasurementLocationType |
| Values: |
| RFMXSPECAN_VAL_PAVT_MEASUREMENT_LOCATION_TYPE_TIME (0) | The measurement is performed over a single record across multiple segments separated in time. The measurement locations of the segments are specified by the RFMXSPECAN_ATTR_PAVT_SEGMENT_START_TIME attribute. The number of segments is equal to the number of segment start times. |
|---|---|
| RFMXSPECAN_VAL_PAVT_MEASUREMENT_LOCATION_TYPE_TRIGGER (1) | The measurement is performed across segments obtained in multiple records, where each record is obtained when a trigger is received. The number of segments is equal to the number of triggers (records). |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64 |
| Description: | Specifies the bandwidth over which the signal is measured. This value is expressed in Hz. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 10 MHz. Get Function: RFmxSpecAn_PAVTGetMeasurementBandwidth Set Function: RFmxSpecAn_PAVTSetMeasurementBandwidth |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies the mode of configuring the measurement interval. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_UNIFORM. Get Function: RFmxSpecAn_PAVTGetMeasurementIntervalMode Set Function: RFmxSpecAn_PAVTSetMeasurementIntervalMode |
| Values: |
| RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_UNIFORM (0) | The time offset from the start of segment and the duration over which the measurement is performed is uniform for all segments and is given by the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_OFFSET attribute and the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_LENGTH attribute respectively. |
|---|---|
| RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE (1) | The time offset from the start of segment and the duration over which the measurement is performed is configured separately for each segment and is given by the RFMXSPECAN_ATTR_PAVT_SEGMENT_MEASUREMENT_OFFSET attribute and the RFMXSPECAN_ATTR_PAVT_SEGMENT_MEASUREMENT_LENGTH attribute respectively. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies the number of segments to be measured. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 1. Get Function: RFmxSpecAn_PAVTGetNumberOfSegments Set Function: RFmxSpecAn_PAVTSetNumberOfSegments |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies the type of segment. Use 'segment(n)' as the selector string to configure or read this attribute. The default value is RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_PHASE_AND_AMPLITUDE. Get Function: RFmxSpecAn_PAVTGetSegmentType Set Function: RFmxSpecAn_PAVTSetSegmentType |
| Values: |
| RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_PHASE_AND_AMPLITUDE (0) | Phase and amplitude is measured in this segment. |
|---|---|
| RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_AMPLITUDE (1) | Amplitude is measured in this segment. |
| RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_FREQUENCY_ERROR_MEASUREMENT (2) | Frequency error is measured in this segment. |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64 |
| Description: | Specifies the start time of measurement of the segments. This value is expressed in seconds. You can use this attribute only when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_LOCATION_TYPE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_LOCATION_TYPE_TIME. Use 'segment(n)' as the selector string to configure or read this attribute. The default value is 0. Get Function: RFmxSpecAn_PAVTGetSegmentStartTime Set Function: RFmxSpecAn_PAVTSetSegmentStartTime |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64 |
| Description: | Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_UNIFORM. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 0. Get Function: RFmxSpecAn_PAVTGetMeasurementOffset Set Function: RFmxSpecAn_PAVTSetMeasurementOffset |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64 |
| Description: | Specifies the duration within the segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_UNIFORM. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 1 millisecond. Get Function: RFmxSpecAn_PAVTGetMeasurementLength Set Function: RFmxSpecAn_PAVTSetMeasurementLength |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64 |
| Description: | Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE. Use 'segment(n)' as the selector string to configure or read this attribute. The default value is 0. Get Function: RFmxSpecAn_PAVTGetSegmentMeasurementOffset Set Function: RFmxSpecAn_PAVTSetSegmentMeasurementOffset |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64 |
| Description: | Specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE. Use 'segment(n)' as the selector string to configure or read this attribute. The default value is 1 millisecond. Get Function: RFmxSpecAn_PAVTGetSegmentMeasurementLength Set Function: RFmxSpecAn_PAVTSetSegmentMeasurementLength |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies whether the phase measurement results are unwrapped or wrapped. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXSPECAN_VAL_PAVT_PHASE_UNWRAP_ENABLED_FALSE. Get Function: RFmxSpecAn_PAVTGetPhaseUnwrapEnabled Set Function: RFmxSpecAn_PAVTSetPhaseUnwrapEnabled |
| Values: |
| RFMXSPECAN_VAL_PAVT_PHASE_UNWRAP_ENABLED_FALSE (0) | Phase measurement results are wrapped within +/-180 degrees. |
|---|---|
| RFMXSPECAN_VAL_PAVT_PHASE_UNWRAP_ENABLED_TRUE (1) | Phase measurement results are unwrapped. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies whether to enable frequency offset correction for the measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXSPECAN_VAL_PAVT_FREQUENCY_OFFSET_CORRECTION_ENABLED_FALSE. Get Function: RFmxSpecAn_PAVTGetFrequencyOffsetCorrectionEnabled Set Function: RFmxSpecAn_PAVTSetFrequencyOffsetCorrectionEnabled |
| Values: |
| RFMXSPECAN_VAL_PAVT_FREQUENCY_OFFSET_CORRECTION_ENABLED_FALSE (0) | Disables the frequency offset correction. |
|---|---|
| RFMXSPECAN_VAL_PAVT_FREQUENCY_OFFSET_CORRECTION_ENABLED_TRUE (1) | Enables the frequency offset correction. The measurement computes and corrects any frequency offset between the reference and the acquired waveforms. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies whether to enable frequency offset correction per segment for the measurement. While you set this attribute to RFMXSPECAN_VAL_PAVT_FREQUENCY_TRACKING_ENABLED_TRUE, ensure that the RFMXSPECAN_ATTR_PAVT_FREQUENCY_OFFSET_CORRECTION_ENABLED attribute is set to RFMXSPECAN_VAL_PAVT_FREQUENCY_OFFSET_CORRECTION_ENABLED_TRUE and the RFMXSPECAN_ATTR_PAVT_SEGMENT_TYPE attribute is set to RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_PHASE_AND_AMPLITUDE. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXSPECAN_VAL_PAVT_FREQUENCY_TRACKING_ENABLED_FALSE. Get Function: RFmxSpecAn_PAVTGetFrequencyTrackingEnabled Set Function: RFmxSpecAn_PAVTSetFrequencyTrackingEnabled |
| Values: |
| RFMXSPECAN_VAL_PAVT_FREQUENCY_TRACKING_ENABLED_FALSE (0) | Disables the drift correction for the measurement. |
|---|---|
| RFMXSPECAN_VAL_PAVT_FREQUENCY_TRACKING_ENABLED_TRUE (1) | Enables the drift correction. The measurement corrects and reports the frequency offset per segment. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32 |
| Description: | Specifies whether to enable the traces to be stored and retrieved after performing the PAVT measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXSPECAN_VAL_FALSE. Get Function: RFmxSpecAn_PAVTGetAllTracesEnabled Set Function: RFmxSpecAn_PAVTSetAllTracesEnabled |
| Data Type: | float64 |
|---|---|
| Access: | read only |
| Functions: | RFmxSpecAn_GetAttributeF64 |
| Description: | Returns the mean phase of the segment, relative to the phase of the reference segment. This value is expressed in degrees. Use 'segment(n)' as the selector string to read this result. Get Function: RFmxSpecAn_PAVTGetResultsMeanRelativePhase |
| Data Type: | float64 |
|---|---|
| Access: | read only |
| Functions: | RFmxSpecAn_GetAttributeF64 |
| Description: | Returns the mean amplitude of the segment, relative to the amplitude of the reference segment. This value is expressed in dB. Mean Relative Amplitude = ai - ar ai is the absolute amplitude of the segment i, expressed in dBm ar is the absolute amplitude of the reference segment r, expressed in dBm where, r = 1, if Segment0 is configured as Frequency Error Measurement segment r = 0, otherwise Use 'segment(n)' as the selector string to read this result. Get Function: RFmxSpecAn_PAVTGetResultsMeanRelativeAmplitude |
| Data Type: | float64 |
|---|---|
| Access: | read only |
| Functions: | RFmxSpecAn_GetAttributeF64 |
| Description: | Returns the mean absolute phase of the segment. This value is expressed in degrees. Use 'segment(n)' as the selector string to read this result. Get Function: RFmxSpecAn_PAVTGetResultsMeanAbsolutePhase |
| Data Type: | float64 |
|---|---|
| Access: | read only |
| Functions: | RFmxSpecAn_GetAttributeF64 |
| Description: | Returns the mean absolute amplitude of the segment. This value is expressed in dBm. Use 'segment(n)' as the selector string to read this result. Get Function: RFmxSpecAn_PAVTGetResultsMeanAbsoluteAmplitude |
| Data Type: | float64 |
|---|---|
| Access: | read only |
| Functions: | RFmxSpecAn_GetAttributeF64 |
| Description: | Returns the mean frequency error of the segment. This value is expressed in Hz Use 'segment(n)' as the selector string to read this result. Get Function: RFmxSpecAn_PAVTGetResultsFrequencyErrorMean |