NI-RFPM API Reference

niRFPM Properties

  • Updated2023-12-28
  • 5 minute(s) read

niRFPM Properties

May 2021 375624E-01

Use the NI-RFPM properties to access advanced configuration options for NI-RFPM applications.

Property Description
Active Channel

Specifies the port name used to access all subsequent properties in this instance of the property node. If the property you want to use is port-based, you must first select this property and then pass the name of the specific port. If the property you specify is not port-based, pass an empty string, or omit setting this property. Details

Measurement:Vector Correction Enabled

Specifies whether the vector error correction is applied to the measurement data. Details

Measurement:De-embedding Enabled

Specifies whether de-embedding is applied to the measurement and calibration data. Details

Measurement:De-embedding S2P Path

Specifies the path to the S2P file that characterizes the de-embedding network for the given port. Details

Measurement:De-embedding S2P Orientation

Specifies whether the de-embedding network in the S2P file is connected with port 1 towards the DUT or port 2 towards the DUT. Details

Measurement:Reference Level Port Extension Selected Table

Specifies reference level port extension table for the active channel.

This property does not support the RF subsystem. Details

Measurement:Reference Clock Source

Specifies the source to use for the Reference Clock. Details

Measurement:Interpolation Enabled

Specifies if interpolation across frequency is used when fetching source and receiver offsets by parameters.

This property does not support the mmWave subsystem. Details

Measurement:Maximum Frequency Span for Interpolation

Specifies the maximum span between two adjacent calibration frequencies for which interpolation will be performed, expressed in Hz.

This property does not support the mmWave subsystem. Details

Measurement:External Settling Time

Specifies the time to delay the S-parameter measurement after the source is modified to allow for external settling. This value is expressed in seconds. Details

Measurement:Reference Level Coercion Enabled

Specifies whether reference level is coerced to the next highest reference level with a matching frequency when fetching receiver offset by parameters.

This property does not support the mmWave subsystem. Details

Measurement:Maximum Reference Level Coercion

Specifies the maximum difference allowed between the requested reference level and the matching reference level when reference level coercion is enabled, expressed in dBm.

This property does not support the mmWave subsystem. Details

Measurement:Power Level Coercion Method

Specifies if and how power level is coerced when fetching the source offset. Coercion can either be to the nearest calibrated power level with a matching frequency, or to a lower power level only.

This property does not support the mmWave subsystem. Details

Measurement:Maximum Power Level Coercion

Specifies the maximum difference allowed between the requested power level and the matching power level when power level coercion is enabled, expressed in dBm.

This property does not support the mmWave subsystem. Details

Measurement:Source Amplitude Settling

Specifies the source amplitude settling accuracy for vector and scalar measurements in decibels.

This property does not support the mmWave subsystem. Details

Measurement:Receiver Amplitude Settling

Specifies the receiver amplitude settling accuracy for scalar measurements in decibels.

This property does not support the mmWave subsystem. Details

Measurement:Vector Receiver Amplitude Settling

Specifies the receiver amplitude settling accuracy for vector measurements in decibels.

This property does not support the mmWave subsystem. Details

Calibration:Source Power Correction Enabled

Specifies whether the source output power offsets use user-calibrated values or factory calibration values. This property also specifies whether the source output power offsets are applied during S-parameter measurements.

This property does not support the mmWave subsystem. Details

Calibration:Receiver Power Correction Enabled

Specifies whether the receiver input power offsets use user-calibrated values or factory calibration values.

This property does not support the mmWave subsystem. Details

Calibration:AutoCal Resource Name

Specifies the resource name of the NI Automatic RF Calibration Module used for automatic calibration.

This property does not support the mmWave subsystem. Details

Calibration:Power Meter Resource Name

Specifies the name of the power meter resource that an RF multiport calibration module uses. To read this attribute, the RF multiport calibration module must be connected. If there is only one RF multiport calibration module and the AutoCal Resource Name property is an empty string, the driver automatically detects the RF multiport calibration module to get the power meter resource name from. If there is more than one NI Automatic RF Calibration Module or the string is not empty, the driver finds the power meter resource name from the RF multiport calibration module specified by the AutoCal Resource Name property. This property does not report a valid resource name until after the niRFPM Init User Calibration VI runs.

This property does not support the mmWave subsystem. Details

Calibration:AutoCal Absolute Vector Calibration Enabled

Specifies whether the automatic calibration routine collects absolute vector error coefficients or relative vector error coefficients.

This property does not support the mmWave subsystem. Details

Calibration:AutoCal Source Scalar Calibration Enabled

Specifies whether the automatic calibration routine collects source scalar offsets.

This property does not support the mmWave subsystem. Details

Calibration:AutoCal Receiver Scalar Calibration Enabled

Specifies whether the automatic calibration routine collects receiver scalar offsets.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Year

Returns the year of the last time the RF multiport calibration module was calibrated.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Month

Returns the month of the last time the RF multiport calibration module was calibrated. The returned value is expressed as an integer. For example, December is represented as 12.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Day

Returns the day of the last time the RF multiport calibration module was calibrated.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Hour

Returns the hour of the last time the RF multiport calibration module was calibrated. The time is expressed in 24-hour clock format according to your local time zone. For example, if the device was calibrated at 2:00 PM, this function returns 14 as the value of this property.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Minute

Returns the minute of the last time the RF multiport calibration module was calibrated.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Second

Returns the second of the last time the RF multiport calibration module was calibrated.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Temperature

Returns the temperature of the RF multiport calibration module for the last time the RF multiport calibration module was calibrated.

This property does not support the mmWave subsystem. Details

Calibration Load Board Calibration Information:Calibration Load Board Calibration Revision

Returns the calibration revision used last time the RF multiport calibration module was calibrated.

This property does not support the mmWave subsystem. Details

Calibration:Calibration Load Board Model Number

Returns the model number of the calibration load board.

This property does not support the mmWave subsystem. Details

Calibration:Calibration Load Board Serial Number

Returns the serial number of the calibration load board.

This property does not support the mmWave subsystem. Details

Driver State

Indicates the current state of the driver. Details

Calibration:Calibration File VST Serial Must Match

Specifies whether a calibration file will be rejected if the calibration was performed with a different VST.

This property does not support the mmWave subsystem. Details

Calibration:Skip Self Calibration Timestamp Check

Specifies whether to skip validation of self calibration timestamp and vector calibration timestamp.

This property does not support the RF subsystem. Details