Skip to content

NI RFmx SpecAn Fcnt Attributes

Dane Stull edited this page Feb 18, 2022 · 4 revisions

Fcnt Attributes

RFMXSPECAN_ATTR_FCNT_MEASUREMENT_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable the FCnt measurement.

You do not need to use a selector string to read this result for 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_FCntGetMeasurementEnabled
Set Function: RFmxSpecAn_FCntSetMeasurementEnabled

RFMXSPECAN_ATTR_FCNT_MEASUREMENT_INTERVAL

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the acquisition time for the FCnt measurement. 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_FCntGetMeasurementInterval
Set Function: RFmxSpecAn_FCntSetMeasurementInterval

Fcnt RBW Filter

RFMXSPECAN_ATTR_FCNT_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 measure the signal. 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 100 kHz.

Get Function: RFmxSpecAn_FCntGetRBWFilterBandwidth
Set Function: RFmxSpecAn_FCntSetRBWFilterBandwidth

RFMXSPECAN_ATTR_FCNT_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_FCNT_RBW_FILTER_TYPE_NONE.

Get Function: RFmxSpecAn_FCntGetRBWFilterType
Set Function: RFmxSpecAn_FCntSetRBWFilterType
Values:
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_NONE (5) The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_GAUSSIAN (1) The RBW filter has a Gaussian response.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_FLAT (2) The RBW filter has a flat response.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_RRC (6) The RRC filter with the roll-off specified by RFMXSPECAN_ATTR_FCNT_RBW_FILTER_RRC_ALPHA attribute is used as the RBW filter.

| :- | :- |

RFMXSPECAN_ATTR_FCNT_RBW_FILTER_RRC_ALPHA

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the roll-off factor for the root-raised-cosine (RRC) 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 0.1.

Get Function: RFmxSpecAn_FCntGetRBWFilterRRCAlpha
Set Function: RFmxSpecAn_FCntSetRBWFilterRRCAlpha

Fcnt Threshold

RFMXSPECAN_ATTR_FCNT_THRESHOLD_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable thresholding of the acquired samples to be used for the FCnt 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_FCNT_THRESHOLD_ENABLED_FALSE.

Get Function: RFmxSpecAn_FCntGetThresholdEnabled
Set Function: RFmxSpecAn_FCntSetThresholdEnabled
Values:
RFMXSPECAN_VAL_FCNT_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the FCnt measurement.
RFMXSPECAN_VAL_FCNT_THRESHOLD_ENABLED_TRUE (1) The samples above the threshold level specified in the RFMXSPECAN_ATTR_FCNT_THRESHOLD_LEVEL attribute are considered for the FCnt measurement.

| :- | :- |

RFMXSPECAN_ATTR_FCNT_THRESHOLD_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the reference for the power level used for thresholding.

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

Get Function: RFmxSpecAn_FCntGetThresholdType
Set Function: RFmxSpecAn_FCntSetThresholdType
Values:
RFMXSPECAN_VAL_FCNT_THRESHOLD_TYPE_RELATIVE (0) The threshold is relative to the peak power of the acquired samples.
RFMXSPECAN_VAL_FCNT_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

| :- | :- |

RFMXSPECAN_ATTR_FCNT_THRESHOLD_LEVEL

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies either the relative or absolute threshold power level based on the value of the RFMXSPECAN_ATTR_FCNT_THRESHOLD_TYPE attribute.

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

Get Function: RFmxSpecAn_FCntGetThresholdLevel
Set Function: RFmxSpecAn_FCntSetThresholdLevel

Fcnt Averaging

RFMXSPECAN_ATTR_FCNT_AVERAGING_ENABLED

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

Get Function: RFmxSpecAn_FCntGetAveragingEnabled
Set Function: RFmxSpecAn_FCntSetAveragingEnabled
Values:
RFMXSPECAN_VAL_FCNT_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_FCNT_AVERAGING_ENABLED_TRUE (1) The FCnt measurement uses the RFMXSPECAN_ATTR_FCNT_AVERAGING_COUNT attribute as the number of acquisitions over which the FCnt measurement is averaged.

| :- | :- |

RFMXSPECAN_ATTR_FCNT_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_FCNT_AVERAGING_ENABLED attribute to RFMXSPECAN_VAL_FCNT_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_FCntGetAveragingCount
Set Function: RFmxSpecAn_FCntSetAveragingCount

RFMXSPECAN_ATTR_FCNT_AVERAGING_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the averaging type for the FCnt measurement. The averaged instantaneous signal phase difference is used 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_FCNT_AVERAGING_TYPE_MEAN.

Get Function: RFmxSpecAn_FCntGetAveragingType
Set Function: RFmxSpecAn_FCntSetAveragingType
Values:
RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MEAN (6) The mean of the instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.
RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MAXIMUM (3) The maximum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.
RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MINIMUM (4) The minimum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.
RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MINMAX (7) The maximum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement. The sign of the phase difference is ignored to find the maximum instantaneous value.

| :- | :- |

RFMXSPECAN_ATTR_FCNT_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 FCnt 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_FCntGetAllTracesEnabled
Set Function: RFmxSpecAn_FCntSetAllTracesEnabled

RFMXSPECAN_ATTR_FCNT_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 FCnt 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_FCntGetNumberOfAnalysisThreads
Set Function: RFmxSpecAn_FCntSetNumberOfAnalysisThreads

Fcnt Results

RFMXSPECAN_ATTR_FCNT_RESULTS_AVERAGE_RELATIVE_FREQUENCY

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the RFMXSPECAN_ATTR_FCNT_THRESHOLD_ENABLED attribute to RFMXSPECAN_VAL_FCNT_THRESHOLD_ENABLED_TRUE.

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_FCntGetResultsAverageRelativeFrequency

RFMXSPECAN_ATTR_FCNT_RESULTS_AVERAGE_ABSOLUTE_FREQUENCY

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the RF signal frequency. Only samples above the threshold are used when you set the RFMXSPECAN_ATTR_FCNT_THRESHOLD_ENABLED attribute to RFMXSPECAN_VAL_FCNT_THRESHOLD_ENABLED_TRUE.

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_FCntGetResultsAverageAbsoluteFrequency

RFMXSPECAN_ATTR_FCNT_RESULTS_MEAN_PHASE

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the net phase of the vector sum of the I/Q samples used for frequency measurement.

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_FCntGetResultsMeanPhase

RFMXSPECAN_ATTR_FCNT_RESULTS_ALLAN_DEVIATION

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the two-sample deviation of the measured frequency.

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_FCntGetResultsAllanDeviation

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