Skip to content

NI RFmx SpecAn Cdf Attributes

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

Cdf Attributes

RFMXSPECAN_ATTR_CCDF_MEASUREMENT_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable the CCDF 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_CCDFGetMeasurementEnabled
Set Function: RFmxSpecAn_CCDFSetMeasurementEnabled

RFMXSPECAN_ATTR_CCDF_MEASUREMENT_INTERVAL

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the acquisition time for the CCDF 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_CCDFGetMeasurementInterval
Set Function: RFmxSpecAn_CCDFSetMeasurementInterval

RFMXSPECAN_ATTR_CCDF_NUMBER_OF_RECORDS

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the number of acquisitions used for the CCDF 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 1.

Get Function: RFmxSpecAn_CCDFGetNumberOfRecords
Set Function: RFmxSpecAn_CCDFSetNumberOfRecords

Cdf RBW Filter

RFMXSPECAN_ATTR_CCDF_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_CCDFGetRBWFilterBandwidth
Set Function: RFmxSpecAn_CCDFSetRBWFilterBandwidth

RFMXSPECAN_ATTR_CCDF_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_CCDF_RBW_FILTER_TYPE_NONE.

Get Function: RFmxSpecAn_CCDFGetRBWFilterType
Set Function: RFmxSpecAn_CCDFSetRBWFilterType
Values:
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_NONE (5) The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_GAUSSIAN (1) The RBW filter has a Gaussian response.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_FLAT (2) The RBW filter has a flat response.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_RRC (6) The RRC filter with the roll-off specified by the RFMXSPECAN_ATTR_CCDF_RBW_FILTER_RRC_ALPHA attribute is used as the RBW filter.

RFMXSPECAN_ATTR_CCDF_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_CCDFGetRBWFilterRRCAlpha
Set Function: RFmxSpecAn_CCDFSetRBWFilterRRCAlpha

Cdf Threshold

RFMXSPECAN_ATTR_CCDF_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 CCDF 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_CCDF_THRESHOLD_ENABLED_FALSE.

Get Function: RFmxSpecAn_CCDFGetThresholdEnabled
Set Function: RFmxSpecAn_CCDFSetThresholdEnabled
Values:
RFMXSPECAN_VAL_CCDF_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the CCDF measurement.
RFMXSPECAN_VAL_CCDF_THRESHOLD_ENABLED_TRUE (1) The samples above the threshold level specified in the RFMXSPECAN_ATTR_CCDF_THRESHOLD_LEVEL attribute are considered for the CCDF measurement.

RFMXSPECAN_ATTR_CCDF_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_CCDF_THRESHOLD_TYPE_RELATIVE.

Get Function: RFmxSpecAn_CCDFGetThresholdType
Set Function: RFmxSpecAn_CCDFSetThresholdType
Values:
RFMXSPECAN_VAL_CCDF_THRESHOLD_TYPE_RELATIVE (0) The threshold is relative to the peak power of the acquired samples.
RFMXSPECAN_VAL_CCDF_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

RFMXSPECAN_ATTR_CCDF_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_CCDF_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_CCDFGetThresholdLevel
Set Function: RFmxSpecAn_CCDFSetThresholdLevel

RFMXSPECAN_ATTR_CCDF_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 CCDF 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_CCDFGetAllTracesEnabled
Set Function: RFmxSpecAn_CCDFSetAllTracesEnabled

RFMXSPECAN_ATTR_CCDF_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 CCDF 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_CCDFGetNumberOfAnalysisThreads
Set Function: RFmxSpecAn_CCDFSetNumberOfAnalysisThreads

Cdf Results

RFMXSPECAN_ATTR_CCDF_RESULTS_MEAN_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the average power of all the samples. This value is expressed in dBm. If you set the RFMXSPECAN_ATTR_CCDF_THRESHOLD_ENABLED attribute to RFMXSPECAN_VAL_CCDF_THRESHOLD_ENABLED_TRUE, samples above the threshold are measured.

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_CCDFGetResultsMeanPower

RFMXSPECAN_ATTR_CCDF_RESULTS_MEAN_POWER_PERCENTILE

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the percentage of samples that have more power than the mean power.

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_CCDFGetResultsMeanPowerPercentile

RFMXSPECAN_ATTR_CCDF_RESULTS_TEN_PERCENT_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the power above the mean power, over which 10% of the total samples in the signal are present. This value is expressed in dB.

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_CCDFGetResultsTenPercentPower

RFMXSPECAN_ATTR_CCDF_RESULTS_ONE_PERCENT_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the power above the mean power, over which 1% of the total samples in the signal are present. This value is expressed in dB.

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_CCDFGetResultsOnePercentPower

RFMXSPECAN_ATTR_CCDF_RESULTS_ONE_TENTH_PERCENT_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the power above the mean power, over which 0.1% of the total samples in the signal are present. This value is expressed in dB.

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_CCDFGetResultsOneTenthPercentPower

RFMXSPECAN_ATTR_CCDF_RESULTS_ONE_HUNDREDTH_PERCENT_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the power above the mean power, over which 0.01% of the total samples in the signal are present. This value is expressed in dB.

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_CCDFGetResultsOneHundredthPercentPower

RFMXSPECAN_ATTR_CCDF_RESULTS_ONE_THOUSANDTH_PERCENT_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the power above the mean power, over which 0.001% of the total samples in the signal are present. This value is expressed in dB.

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_CCDFGetResultsOneThousandthPercentPower

RFMXSPECAN_ATTR_CCDF_RESULTS_ONE_TEN_THOUSANDTH_PERCENT_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the power above the mean power, over which 0.0001% of the total samples in the signal are present. This value is expressed in dB.

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_CCDFGetResultsOneTenThousandthPercentPower

RFMXSPECAN_ATTR_CCDF_RESULTS_PEAK_POWER

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the peak power of the acquired signal, relative to the mean power.

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.

Get Function: RFmxSpecAn_CCDFGetResultsPeakPower

RFMXSPECAN_ATTR_CCDF_RESULTS_MEASURED_SAMPLES_COUNT

Data Type: int32
Access: read only
Functions: RFmxSpecAn_GetAttributeI32
Description: Returns the total number of samples measured. The total number of samples includes only the samples above the threshold, when you set the RFMXSPECAN_ATTR_CCDF_THRESHOLD_ENABLED attribute to RFMXSPECAN_VAL_CCDF_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_CCDFGetResultsMeasuredSampleCount

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