NI RFmx NR CHP Attributes - ni/grpc-device GitHub Wiki
- RFMXNR_ATTR_CHP_MEASUREMENT_ENABLED
- Sweep Time
- RFMXNR_ATTR_CHP_INTEGRATION_BANDWIDTH_TYPE
- RFMXNR_ATTR_CHP_SUBBLOCK_INTEGRATION_BANDWIDTH
- Component Carrier
- RBW Filter
- Noise Calibration
- Noise Compensation
- Averaging
- RFMXNR_ATTR_CHP_MEASUREMENT_MODE
- FFT
- RFMXNR_ATTR_CHP_AMPLITUDE_CORRECTION_TYPE
- RFMXNR_ATTR_CHP_ALL_TRACES_ENABLED
- RFMXNR_ATTR_CHP_NUMBER_OF_ANALYSIS_THREADS
- Results
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether to enable the channel power 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 RFMXNR_VAL_FALSE. Get Function: RFmxNR_CHPGetMeasurementEnabled Set Function: RFmxNR_CHPSetMeasurementEnabled |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether the measurement sets the sweep time. 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 RFMXNR_VAL_CHP_SWEEP_TIME_AUTO_TRUE. Get Function: RFmxNR_CHPGetSweepTimeAuto Set Function: RFmxNR_CHPSetSweepTimeAuto |
Values: |
RFMXNR_VAL_CHP_SWEEP_TIME_AUTO_FALSE (0) | The measurement uses the sweep time that you specify in the Sweep Time Interval attribute. |
---|---|
RFMXNR_VAL_CHP_SWEEP_TIME_AUTO_TRUE (1) | The measurement uses the sweep time based on the resolution bandwidth. |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the sweep time when you set the RFMXNR_ATTR_CHP_SWEEP_TIME_AUTO attribute to False. This value is expressed in seconds. 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 ms. Get Function: RFmxNR_CHPGetSweepTimeInterval Set Function: RFmxNR_CHPSetSweepTimeInterval |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the integration bandwidth (IBW) type used to measure the power of the acquired signal. Integration bandwidth is the frequency interval over which the power in each frequency bin is added to measure the total power in that 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 RFMXNR_VAL_CHP_INTEGRATION_BANDWIDTH_TYPE_SIGNAL_BANDWIDTH. Get Function: RFmxNR_CHPGetIntegrationBandwidthType Set Function: RFmxNR_CHPSetIntegrationBandwidthType |
Values: |
RFMXNR_VAL_CHP_INTEGRATION_BANDWIDTH_TYPE_SIGNAL_BANDWIDTH (0) | The IBW excludes the guard bands at the edges of the carrier or subblock. |
---|---|
RFMXNR_VAL_CHP_INTEGRATION_BANDWIDTH_TYPE_CHANNEL_BANDWIDTH (1) | The IBW includes the guard bands at the edges of the carrier or subblock. |
Data Type: | float64 |
---|---|
Access: | read only |
Functions: | RFmxNR_GetAttributeF64 |
Description: | Specifies the integration bandwidth of the subblock. This value is expressed in Hz. It is the span from left edge of the integration bandwidth of the leftmost carrier to the right edge of the integration bandwidth of the rightmost carrier within a subblock. Use 'subblock(n)' as the Selector Strings to read this attribute. The default value is 0. Get Function: RFmxNR_CHPGetSubblockIntegrationBandwidth |
Data Type: | float64 |
---|---|
Access: | read only |
Functions: | RFmxNR_GetAttributeF64 |
Description: | Specifies the integration bandwidth of a component carrier (CC). This value is expressed in Hz. Use 'carrier(k)' or 'subblock(n)' or 'subblock(n)/carrier(k)' as the Selector Strings to read this result. The default value is 9 MHz. Get Function: RFmxNR_CHPGetComponentCarrierIntegrationBandwidth |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether the measurement computes the RBW. 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 RFMXNR_VAL_CHP_RBW_FILTER_AUTO_BANDWIDTH_TRUE. Get Function: RFmxNR_CHPGetRBWFilterAutoBandwidth Set Function: RFmxNR_CHPSetRBWFilterAutoBandwidth |
Values: |
RFMXNR_VAL_CHP_RBW_FILTER_AUTO_BANDWIDTH_FALSE (0) | The measurement uses the RBW that you specify in the RFMXNR_ATTR_CHP_RBW_FILTER_BANDWIDTH attribute. |
---|---|
RFMXNR_VAL_CHP_RBW_FILTER_AUTO_BANDWIDTH_TRUE (1) | The measurement computes the RBW. |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the bandwidth of the RBW filter, used to sweep the acquired signal, when you set the RFMXNR_ATTR_CHP_RBW_FILTER_AUTO_BANDWIDTH attribute to RFMXNR_VAL_CHP_RBW_FILTER_AUTO_BANDWIDTH_FALSE. 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 30 kHz. Get Function: RFmxNR_CHPGetRBWFilterBandwidth Set Function: RFmxNR_CHPSetRBWFilterBandwidth |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the shape of the digital RBW filter. 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 RFMXNR_VAL_CHP_RBW_FILTER_TYPE_FFT_BASED. Get Function: RFmxNR_CHPGetRBWFilterType Set Function: RFmxNR_CHPSetRBWFilterType |
Values: |
RFMXNR_VAL_CHP_RBW_FILTER_TYPE_FFT_BASED (0) | No RBW filtering is performed. |
---|---|
RFMXNR_VAL_CHP_RBW_FILTER_TYPE_GAUSSIAN (1) | An RBW filter with a Gaussian response is applied. |
RFMXNR_VAL_CHP_RBW_FILTER_TYPE_FLAT (2) | An RBW filter with a flat response is applied. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. 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 RFMXNR_VAL_CHP_NOISE_CALIBRATION_MODE_AUTO. Get Function: RFmxNR_CHPGetNoiseCalibrationMode Set Function: RFmxNR_CHPSetNoiseCalibrationMode |
Values: |
RFMXNR_VAL_CHP_NOISE_CALIBRATION_MODE_MANUAL (0) | When you set RFMXNR_ATTR_CHP_MEASUREMENT_MODE attribute to RFMXNR_VAL_CHP_MEASUREMENT_MODE_CALIBRATE_NOISE_FLOOR, you can initiate the instrument noise calibration for CHP manually. When you set the RFMXNR_ATTR_CHP_MEASUREMENT_MODE attribute to RFMXNR_VAL_CHP_MEASUREMENT_MODE_MEASURE, you can initiate the CHP measurement manually. |
---|---|
RFMXNR_VAL_CHP_NOISE_CALIBRATION_MODE_AUTO (1) | When you set the RFMXNR_ATTR_CHP_NOISE_COMPENSATION_ENABLED attribute to RFMXNR_VAL_CHP_NOISE_COMPENSATION_ENABLED_TRUE, RFmx sets the Input Isolation Enabled attribute to Enabled and calibrates the instrument noise in the current state of the instrument. Next, RFmx resets the Input Isolation Enabled attribute and performs the CHP measurement including compensation for the noise contribution of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the RFMXNR_ATTR_CHP_NOISE_COMPENSATION_ENABLED to RFMXNR_VAL_CHP_NOISE_COMPENSATION_ENABLED_FALSE, RFmx does not calibrate instrument noise and performs the CHP measurement without compensating for the noise contribution of the instrument. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether RFmx automatically computes the averaging count used for instrument noise calibration. 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 RFMXNR_VAL_CHP_NOISE_CALIBRATION_AVERAGING_AUTO_TRUE. Get Function: RFmxNR_CHPGetNoiseCalibrationAveragingAuto Set Function: RFmxNR_CHPSetNoiseCalibrationAveragingAuto |
Values: |
RFMXNR_VAL_CHP_NOISE_CALIBRATION_AVERAGING_AUTO_FALSE (0) | RFmx uses the averages that you set for RFMXNR_ATTR_CHP_NOISE_CALIBRATION_AVERAGING_COUNT attribute. |
---|---|
RFMXNR_VAL_CHP_NOISE_CALIBRATION_AVERAGING_AUTO_TRUE (1) | RFmx uses a noise calibration averaging count of 32. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the averaging count used for noise calibration when you set the RFMXNR_ATTR_CHP_NOISE_CALIBRATION_AVERAGING_AUTO attribute to RFMXNR_VAL_CHP_NOISE_CALIBRATION_AVERAGING_AUTO_FALSE. 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 32. Get Function: RFmxNR_CHPGetNoiseCalibrationAveragingCount Set Function: RFmxNR_CHPSetNoiseCalibrationAveragingCount |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the RFMXNR_ATTR_CHP_NOISE_CALIBRATION_MODE attribute to RFMXNR_VAL_CHP_NOISE_CALIBRATION_MODE_AUTO, or set the RFMXNR_ATTR_CHP_NOISE_CALIBRATION_MODE attribute to RFMXNR_VAL_CHP_NOISE_CALIBRATION_MODE_MANUAL and the RFMXNR_ATTR_CHP_MEASUREMENT_MODE attribute to RFMXNR_VAL_CHP_MEASUREMENT_MODE_MEASURE. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. 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 RFMXNR_VAL_CHP_NOISE_COMPENSATION_ENABLED_FALSE. Get Function: RFmxNR_CHPGetNoiseCompensationEnabled Set Function: RFmxNR_CHPSetNoiseCompensationEnabled |
Values: |
RFMXNR_VAL_CHP_NOISE_COMPENSATION_ENABLED_FALSE (0) | Indicates that noise compensation is disabled. |
---|---|
RFMXNR_VAL_CHP_NOISE_COMPENSATION_ENABLED_TRUE (1) | Indicates that noise compensation is enabled. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the noise compensation type. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. 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 RFMXNR_VAL_CHP_NOISE_COMPENSATION_TYPE_ANALYZER_AND_TERMINATION. Get Function: RFmxNR_CHPGetNoiseCompensationType Set Function: RFmxNR_CHPSetNoiseCompensationType |
Values: |
RFMXNR_VAL_CHP_NOISE_COMPENSATION_TYPE_ANALYZER_AND_TERMINATION (0) | Compensates for noise contribution of the analyzer instrument and the 50-ohm termination. The measured power values are in excess of the thermal noise floor. |
---|---|
RFMXNR_VAL_CHP_NOISE_COMPENSATION_TYPE_ANALYZER_ONLY (1) | Compensates only for analyzer noise only. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether to enable averaging for the CHP 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 RFMXNR_VAL_CHP_AVERAGING_ENABLED_FALSE. Get Function: RFmxNR_CHPGetAveragingEnabled Set Function: RFmxNR_CHPSetAveragingEnabled |
Values: |
RFMXNR_VAL_CHP_AVERAGING_ENABLED_FALSE (0) | The measurement is performed on a single acquisition. |
---|---|
RFMXNR_VAL_CHP_AVERAGING_ENABLED_TRUE (1) | The CHP measurement uses the value of the RFMXNR_ATTR_CHP_AVERAGING_COUNT attribute as the number of acquisitions over which the CHP measurement is averaged. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the number of acquisitions used for averaging when you set the RFMXNR_ATTR_CHP_AVERAGING_ENABLED attribute to RFMXNR_VAL_CHP_AVERAGING_ENABLED_TRUE. 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. Get Function: RFmxNR_CHPGetAveragingCount Set Function: RFmxNR_CHPSetAveragingCount |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP 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 RFMXNR_VAL_CHP_AVERAGING_TYPE_RMS. Get Function: RFmxNR_CHPGetAveragingType Set Function: RFmxNR_CHPSetAveragingType |
Values: |
RFMXNR_VAL_CHP_AVERAGING_TYPE_RMS (0) | The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor. |
---|---|
RFMXNR_VAL_CHP_AVERAGING_TYPE_LOG (1) | The power spectrum is averaged in a logarithmic scale. |
RFMXNR_VAL_CHP_AVERAGING_TYPE_SCALAR (2) | The square root of the power spectrum is averaged. |
RFMXNR_VAL_CHP_AVERAGING_TYPE_MAXIMUM (3) | The peak power in the spectrum at each frequency bin is retained from one acquisition to the next. |
RFMXNR_VAL_CHP_AVERAGING_TYPE_MINIMUM (4) | The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. 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 RFMXNR_VAL_CHP_MEASUREMENT_MODE_MEASURE. Get Function: RFmxNR_CHPGetMeasurementMode Set Function: RFmxNR_CHPSetMeasurementMode |
Values: |
RFMXNR_VAL_CHP_MEASUREMENT_MODE_MEASURE (0) | Performs the CHP measurement on the acquired signal. |
---|---|
RFMXNR_VAL_CHP_MEASUREMENT_MODE_CALIBRATE_NOISE_FLOOR (1) | Performs manual noise calibration of the signal analyzer for the CHP measurement. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the FFT window type to be used to reduce spectral leakage. 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 RFMXNR_VAL_CHP_FFT_WINDOW_FLAT_TOP. Get Function: RFmxNR_CHPGetFFTWindow Set Function: RFmxNR_CHPSetFFTWindow |
Values: |
RFMXNR_VAL_CHP_FFT_WINDOW_NONE (0) | No spectral leakage. |
---|---|
RFMXNR_VAL_CHP_FFT_WINDOW_FLAT_TOP (1) | Spectral leakage is reduced using flat top window type. |
RFMXNR_VAL_CHP_FFT_WINDOW_HANNING (2) | Spectral leakage is reduced using Hanning window type. |
RFMXNR_VAL_CHP_FFT_WINDOW_HAMMING (3) | Spectral leakage is reduced using Hamming window type. |
RFMXNR_VAL_CHP_FFT_WINDOW_GAUSSIAN (4) | Spectral leakage is reduced using Gaussian window type. |
RFMXNR_VAL_CHP_FFT_WINDOW_BLACKMAN (5) | Spectral leakage is reduced using Blackman window type. |
RFMXNR_VAL_CHP_FFT_WINDOW_BLACKMAN_HARRIS (6) | Spectral leakage is reduced using Blackman-Harris window type. |
RFMXNR_VAL_CHP_FFT_WINDOW_KAISER_BESSEL (7) | Spectral leakage is reduced using Kaiser-Bessel window type. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether the amplitude of frequency bins in the spectrum used by the measurement is corrected for external attenuation at RF center frequency or corrected for external attenuation at individual frequency bins Use the RFmxInstr_CfgExternalAttenuationTable function to configure the external attenuation table. 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 RFMXNR_VAL_CHP_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY. Get Function: RFmxNR_CHPGetAmplitudeCorrectionType Set Function: RFmxNR_CHPSetAmplitudeCorrectionType |
Values: |
RFMXNR_VAL_CHP_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY (0) | All frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency. |
---|---|
RFMXNR_VAL_CHP_AMPLITUDE_CORRECTION_TYPE_SPECTRUM_FREQUENCY_BIN (1) | Individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether to enable the traces to be stored and retrieved after performing the CHP 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 RFMXNR_VAL_FALSE. Get Function: RFmxNR_CHPGetAllTracesEnabled Set Function: RFmxNR_CHPSetAllTracesEnabled |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the maximum number of threads used for parallelism for the CHP measurement. The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations. 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: RFmxNR_CHPGetNumberOfAnalysisThreads Set Function: RFmxNR_CHPSetNumberOfAnalysisThreads |
Data Type: | float64 |
---|---|
Access: | read only |
Functions: | RFmxNR_GetAttributeF64 |
Description: | Returns the total power of all the subblocks. This value is expressed in dBm. The power in each subblock is the sum of powers of all the frequency bins over the integration bandwidth of the subblocks. This value includes the power in the inter-carrier gaps within a subblock, but it does not include the power within the subblock gaps. You do not need to use a selector string to read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. Get Function: RFmxNR_CHPGetResultsTotalAggregatedPower |
Data Type: | float64 |
---|---|
Access: | read only |
Functions: | RFmxNR_GetAttributeF64 |
Description: | Returns the sum of powers of all the frequency bins over the integration bandwidth of the subblock. This includes the power in inter-carrier gaps within a subblock. This value is expressed in dBm. Use 'subblock(n)' as the Selector Strings to read this result. Get Function: RFmxNR_CHPGetResultsSubblockPower |
Data Type: | float64 |
---|---|
Access: | read only |
Functions: | RFmxNR_GetAttributeF64 |
Description: | Returns the power measured over the integration bandwidth of the component carrier. This value is expressed in dBm. Use 'carrier(k)' or 'subblock(n)' or 'subblock(n)/carrier(k)' as the Selector Strings to read this result. Get Function: RFmxNR_CHPGetResultsComponentCarrierAbsolutePower |
Data Type: | float64 |
---|---|
Access: | read only |
Functions: | RFmxNR_GetAttributeF64 |
Description: | Returns the component carrier power relative to its subblock power. This value is expressed in dB. Use 'carrier(k)' or 'subblock(n)' or 'subblock(n)/carrier(k)' as the Selector Strings to read this result. Get Function: RFmxNR_CHPGetResultsComponentCarrierRelativePower |