Skip to content

NI RFmx SpecAn CHP Attributes

Alex Starche edited this page Feb 28, 2022 · 4 revisions

CHP Attributes

RFMXSPECAN_ATTR_CHP_MEASUREMENT_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable 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 RFMXSPECAN_VAL_FALSE.

Get Function: RFmxSpecAn_CHPGetMeasurementEnabled
Set Function: RFmxSpecAn_CHPSetMeasurementEnabled

RFMXSPECAN_ATTR_CHP_SPAN

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the frequency range around the center frequency, to acquire for the measurement. 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 1 MHz.

Get Function: RFmxSpecAn_CHPGetSpan
Set Function: RFmxSpecAn_CHPSetSpan

CHP Carrier

RFMXSPECAN_ATTR_CHP_NUMBER_OF_CARRIERS

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the number of carriers.

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_CHPGetNumberOfCarriers
Set Function: RFmxSpecAn_CHPSetNumberOfCarriers

RFMXSPECAN_ATTR_CHP_CARRIER_FREQUENCY

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the center frequency of the carrier, relative to the RF center frequency. This value is expressed in Hz.

Use 'carrier(n)' as the selector string to configure or read this attribute.



The default value is 0.

Get Function: RFmxSpecAn_CHPGetCarrierFrequency
Set Function: RFmxSpecAn_CHPSetCarrierFrequency

RFMXSPECAN_ATTR_CHP_CARRIER_INTEGRATION_BANDWIDTH

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the frequency range, over which the measurement integrates the power. This value is expressed in Hz.

Use 'carrier(n)' as the selector string to configure or read this attribute.

The default value is 1 MHz.

Get Function: RFmxSpecAn_CHPGetCarrierIntegrationBandwidth
Set Function: RFmxSpecAn_CHPSetCarrierIntegrationBandwidth

CHP RRC Filter

RFMXSPECAN_ATTR_CHP_CARRIER_RRC_FILTER_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired channel before measuring the channel power.

Use 'carrier(n)' as the selector string to configure or read this attribute.

The default value is RFMXSPECAN_VAL_CHP_CARRIER_RRC_FILTER_ENABLED_FALSE.

Get Function: RFmxSpecAn_CHPGetCarrierRRCFilterEnabled
Set Function: RFmxSpecAn_CHPSetCarrierRRCFilterEnabled
Values:
RFMXSPECAN_VAL_CHP_CARRIER_RRC_FILTER_ENABLED_FALSE (0) The channel power of the acquired channel is measured directly.
RFMXSPECAN_VAL_CHP_CARRIER_RRC_FILTER_ENABLED_TRUE (1) The measurement applies the RRC filter on the acquired channel before measuring the channel power.

RFMXSPECAN_ATTR_CHP_CARRIER_RRC_FILTER_ALPHA

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the roll-off factor of the root-raised-cosine (RRC) filter.

Use 'carrier(n)' as the selector string to configure or read this attribute.

The default value is 0.1.

Get Function: RFmxSpecAn_CHPGetCarrierRRCFilterAlpha
Set Function: RFmxSpecAn_CHPSetCarrierRRCFilterAlpha

CHP RBW Filter

RFMXSPECAN_ATTR_CHP_RBW_FILTER_AUTO_BANDWIDTH

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether the measurement computes the resolution bandwidth (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 RFMXSPECAN_VAL_CHP_RBW_AUTO_TRUE.

Get Function: RFmxSpecAn_CHPGetRBWFilterAutoBandwidth
Set Function: RFmxSpecAn_CHPSetRBWFilterAutoBandwidth
Values:
RFMXSPECAN_VAL_CHP_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RFMXSPECAN_ATTR_CHP_RBW_FILTER_BANDWIDTH attribute.
RFMXSPECAN_VAL_CHP_RBW_AUTO_TRUE (1) The measurement computes the RBW.

RFMXSPECAN_ATTR_CHP_RBW_FILTER_BANDWIDTH

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RFMXSPECAN_ATTR_CHP_RBW_FILTER_AUTO_BANDWIDTH attribute to RFMXSPECAN_VAL_CHP_RBW_AUTO_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 10 kHz.

Get Function: RFmxSpecAn_CHPGetRBWFilterBandwidth
Set Function: RFmxSpecAn_CHPSetRBWFilterBandwidth

RFMXSPECAN_ATTR_CHP_RBW_FILTER_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the shape of the digital resolution bandwidth (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 RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_GAUSSIAN.

Get Function: RFmxSpecAn_CHPGetRBWFilterType
Set Function: RFmxSpecAn_CHPSetRBWFilterType
Values:
RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.

RFMXSPECAN_ATTR_CHP_RBW_FILTER_BANDWIDTH_DEFINITION

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the bandwidth definition that you use to specify the value of the RFMXSPECAN_ATTR_CHP_RBW_FILTER_BANDWIDTH attribute.



The default value is RFMXSPECAN_VAL_CHP_RBW_FILTER_BANDWIDTH_DEFINITION_3DB.

Get Function: RFmxSpecAn_CHPGetRBWFilterBandwidthDefinition
Set Function: RFmxSpecAn_CHPSetRBWFilterBandwidthDefinition
Values:
RFMXSPECAN_VAL_CHP_RBW_FILTER_BANDWIDTH_DEFINITION_3DB (0) Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the RFMXSPECAN_ATTR_CHP_RBW_FILTER_TYPE attribute to RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_FFT_BASED, RBW is the 3 dB bandwidth of the window specified by the RFMXSPECAN_ATTR_CHP_FFT_WINDOW attribute.
RFMXSPECAN_VAL_CHP_RBW_FILTER_BANDWIDTH_DEFINITION_BIN_WIDTH (2) Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the RFMXSPECAN_ATTR_CHP_RBW_FILTER_TYPE attribute to FFT Based.

CHP Sweep Time

RFMXSPECAN_ATTR_CHP_SWEEP_TIME_AUTO

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether the measurement computes 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 RFMXSPECAN_VAL_CHP_SWEEP_TIME_AUTO_TRUE.

Get Function: RFmxSpecAn_CHPGetSweepTimeAuto
Set Function: RFmxSpecAn_CHPSetSweepTimeAuto
Values:
RFMXSPECAN_VAL_CHP_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the RFMXSPECAN_ATTR_CHP_SWEEP_TIME_INTERVAL attribute.
RFMXSPECAN_VAL_CHP_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_CHP_RBW_FILTER_BANDWIDTH attribute.

RFMXSPECAN_ATTR_CHP_SWEEP_TIME_INTERVAL

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the sweep time when you set the RFMXSPECAN_ATTR_CHP_SWEEP_TIME_AUTO attribute to RFMXSPECAN_VAL_CHP_SWEEP_TIME_AUTO_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 0.001.

Get Function: RFmxSpecAn_CHPGetSweepTimeInterval
Set Function: RFmxSpecAn_CHPSetSweepTimeInterval

CHP Noise Calibration

RFMXSPECAN_ATTR_CHP_NOISE_CALIBRATION_MODE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_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 RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_MODE_AUTO.

Get Function: RFmxSpecAn_CHPGetNoiseCalibrationMode
Set Function: RFmxSpecAn_CHPSetNoiseCalibrationMode
Values:
RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_MODE_MANUAL (0) When you set the RFMXSPECAN_ATTR_CHP_MEASUREMENT_MODE attribute to RFMXSPECAN_VAL_CHP_MEASUREMENT_MODE_CALIBRATE_NOISE_FLOOR, you can initiate instrument noise calibration for the CHP measurement manually. When you set the RFMXSPECAN_ATTR_CHP_MEASUREMENT_MODE attribute to RFMXSPECAN_VAL_CHP_MEASUREMENT_MODE_MEASURE, you can initiate the CHP measurement manually.
RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_MODE_AUTO (1) When you set the RFMXSPECAN_ATTR_CHP_NOISE_COMPENSATION_ENABLED attribute to RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_ENABLED_TRUE, RFmx sets Input Isolation Enabled to Enabled and calibrates the intrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the CHP measurement, including compensation for noise of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the RFMXSPECAN_ATTR_CHP_NOISE_COMPENSATION_ENABLED attribute to RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_ENABLED_FALSE, RFmx does not calibrate instrument noise and performs only the CHP measurement without compensating for the noise contribution of the instrument.

RFMXSPECAN_ATTR_CHP_NOISE_CALIBRATION_AVERAGING_AUTO

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_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 RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_AVERAGING_AUTO_TRUE.

Get Function: RFmxSpecAn_CHPGetNoiseCalibrationAveragingAuto
Set Function: RFmxSpecAn_CHPSetNoiseCalibrationAveragingAuto
Values:
RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_AVERAGING_AUTO_FALSE (0) RFmx uses the averages that you set for the RFMXSPECAN_ATTR_CHP_NOISE_CALIBRATION_AVERAGING_COUNT attribute.
RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_AVERAGING_AUTO_TRUE (1) RFmx uses a noise calibration averaging count of 32.

RFMXSPECAN_ATTR_CHP_NOISE_CALIBRATION_AVERAGING_COUNT

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the averaging count used for noise calibration when you set the RFMXSPECAN_ATTR_CHP_NOISE_CALIBRATION_AVERAGING_AUTO attribute to RFMXSPECAN_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: RFmxSpecAn_CHPGetNoiseCalibrationAveragingCount
Set Function: RFmxSpecAn_CHPSetNoiseCalibrationAveragingCount

CHP Noise Compensation

RFMXSPECAN_ATTR_CHP_NOISE_COMPENSATION_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_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 RFMXSPECAN_ATTR_CHP_NOISE_CALIBRATION_MODE attribute to RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_MODE_AUTO, or set the RFMXSPECAN_ATTR_CHP_NOISE_CALIBRATION_MODE attribute to RFMXSPECAN_VAL_CHP_NOISE_CALIBRATION_MODE_MANUAL and RFMXSPECAN_ATTR_CHP_MEASUREMENT_MODE attribute to RFMXSPECAN_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 RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_ENABLED_FALSE.

Get Function: RFmxSpecAn_CHPGetNoiseCompensationEnabled
Set Function: RFmxSpecAn_CHPSetNoiseCompensationEnabled
Values:
RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_ENABLED_FALSE (0) Disables noise compensation.
RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_ENABLED_TRUE (1) Enables noise compensation.

RFMXSPECAN_ATTR_CHP_NOISE_COMPENSATION_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the noise compensation type. Refer to 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 RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_TYPE_ANALYZER_AND_TERMINATION.

Get Function: RFmxSpecAn_CHPGetNoiseCompensationType
Set Function: RFmxSpecAn_CHPSetNoiseCompensationType
Values:
RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_TYPE_ANALYZER_AND_TERMINATION (0) Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.
RFMXSPECAN_VAL_CHP_NOISE_COMPENSATION_TYPE_ANALYZER_ONLY (1) Compensates for the analyzer noise only.

CHP Averaging

RFMXSPECAN_ATTR_CHP_AVERAGING_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_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 RFMXSPECAN_VAL_CHP_AVERAGING_ENABLED_FALSE.

Get Function: RFmxSpecAn_CHPGetAveragingEnabled
Set Function: RFmxSpecAn_CHPSetAveragingEnabled
Values:
RFMXSPECAN_VAL_CHP_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_CHP_AVERAGING_ENABLED_TRUE (1) The CHP measurement uses the RFMXSPECAN_ATTR_CHP_AVERAGING_COUNT attribute as the number of acquisitions over which the CHP measurement is averaged.

RFMXSPECAN_ATTR_CHP_AVERAGING_COUNT

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the number of acquisitions used for averaging when you set the RFMXSPECAN_ATTR_CHP_AVERAGING_ENABLED attribute to RFMXSPECAN_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: RFmxSpecAn_CHPGetAveragingCount
Set Function: RFmxSpecAn_CHPSetAveragingCount

RFMXSPECAN_ATTR_CHP_AVERAGING_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_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 RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_RMS.

Get Function: RFmxSpecAn_CHPGetAveragingType
Set Function: RFmxSpecAn_CHPSetAveragingType
Values:
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithmic scale.
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_MINIMUM (4) The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RFMXSPECAN_ATTR_CHP_MEASUREMENT_MODE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_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 RFMXSPECAN_VAL_CHP_MEASUREMENT_MODE_MEASURE.

Get Function: RFmxSpecAn_CHPGetMeasurementMode
Set Function: RFmxSpecAn_CHPSetMeasurementMode
Values:
RFMXSPECAN_VAL_CHP_MEASUREMENT_MODE_MEASURE (0) CHP measurement is performed on the acquired signal.
RFMXSPECAN_VAL_CHP_MEASUREMENT_MODE_CALIBRATE_NOISE_FLOOR (1) Manual noise calibration of the signal analyzer is performed for the CHP measurement.

CHP FFT

RFMXSPECAN_ATTR_CHP_FFT_WINDOW

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the FFT window type to use 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 RFMXSPECAN_VAL_CHP_FFT_WINDOW_FLAT_TOP.

Get Function: RFmxSpecAn_CHPGetFFTWindow
Set Function: RFmxSpecAn_CHPSetFFTWindow
Values:
RFMXSPECAN_VAL_CHP_FFT_WINDOW_NONE (0) Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_HANNING (2) Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_GAUSSIAN (4) Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_BLACKMAN (5) Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_BLACKMAN_HARRIS (6) Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

RFMXSPECAN_ATTR_CHP_FFT_PADDING

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the factor by which the time-domain waveform is zero-padded before fast Fourier transform (FFT). The FFT size is given by the following formula:

waveform size * padding

This attribute is used only when the acquisition span is less than the device instantaneous bandwidth of the device.

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_CHPGetFFTPadding
Set Function: RFmxSpecAn_CHPSetFFTPadding

RFMXSPECAN_ATTR_CHP_AMPLITUDE_CORRECTION_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the 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 RFMXSPECAN_VAL_CHP_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY.

Get Function: RFmxSpecAn_CHPGetAmplitudeCorrectionType
Set Function: RFmxSpecAn_CHPSetAmplitudeCorrectionType
Values:
RFMXSPECAN_VAL_CHP_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY (0) All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.
RFMXSPECAN_VAL_CHP_AMPLITUDE_CORRECTION_TYPE_SPECTRUM_FREQUENCY_BIN (1) An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

RFMXSPECAN_ATTR_CHP_ALL_TRACES_ENABLED

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 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 RFMXSPECAN_VAL_FALSE.

Get Function: RFmxSpecAn_CHPGetAllTracesEnabled
Set Function: RFmxSpecAn_CHPSetAllTracesEnabled

RFMXSPECAN_ATTR_CHP_NUMBER_OF_ANALYSIS_THREADS

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the maximum number of threads used for parallelism for 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: RFmxSpecAn_CHPGetNumberOfAnalysisThreads
Set Function: RFmxSpecAn_CHPSetNumberOfAnalysisThreads

CHP Results

RFMXSPECAN_ATTR_CHP_RESULTS_TOTAL_CARRIER_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the total integrated carrier power of all carriers, in dBm.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxSpecAn_CHPGetResultsTotalCarrierPower

RFMXSPECAN_ATTR_CHP_RESULTS_FREQUENCY_RESOLUTION

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the frequency bin spacing of the spectrum acquired by the measurement. This value is expressed in Hz.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxSpecAn_CHPGetResultsFrequencyResolution

CHP Results Carrier

RFMXSPECAN_ATTR_CHP_RESULTS_CARRIER_FREQUENCY

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the center frequency of the carrier relative to the Center Frequency attribute. This value is expressed in Hz.

Use 'carrier(n)' as the selector string to read this result.

Get Function: RFmxSpecAn_CHPGetResultsCarrierFrequency

RFMXSPECAN_ATTR_CHP_RESULTS_CARRIER_INTEGRATION_BANDWIDTH

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the frequency range over which the measurement integrates the carrier power. This value is expressed in Hz.

Use 'carrier(n)' as the selector string to read this result.

Get Function: RFmxSpecAn_CHPGetResultsCarrierIntegrationBandwidth

RFMXSPECAN_ATTR_CHP_RESULTS_CARRIER_ABSOLUTE_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the carrier power measured in the integration bandwidth that you specify in the RFMXSPECAN_ATTR_CHP_CARRIER_INTEGRATION_BANDWIDTH attribute. This value is expressed in dBm.

Use 'carrier(n)' as the selector string to read this result.

Get Function: RFmxSpecAn_CHPGetResultsCarrierAbsolutePower

RFMXSPECAN_ATTR_CHP_RESULTS_CARRIER_PSD

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the power spectral density of the channel. This value is expressed in dBm/Hz.

Use 'carrier(n)' as the selector string to read this result.

Get Function: RFmxSpecAn_CHPGetResultsCarrierPSD

RFMXSPECAN_ATTR_CHP_RESULTS_CARRIER_RELATIVE_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the carrier power measured relative to the total carrier power of all carriers. This value is expressed in dB.

Use 'carrier(n)' as the selector string to read this result.

Get Function: RFmxSpecAn_CHPGetResultsCarrierRelativePower

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally