OrfsConfiguration

Provides methods to configure the Orfs measurement.

class nirfmxgsm.orfs_configuration.OrfsConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Orfs measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)[source]

Configures averaging for the output radio frequency spectrum (ORFS) measurement.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • averaging_enabled (enums.OrfsAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for the measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The measurement is averaged over multiple acquisitions.

  • averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

  • averaging_type (enums.OrfsAveragingType, int) –

    This parameter specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement. The default value is Log.

    Name (Value)

    Description

    RMS (0)

    The measurement averages the power spectrum linearly. RMS averaging reduces signal fluctuations but not the noise floor.

    Log (1)

    The measurement averages the power spectrum in a logarithmic scale.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_evaluation_symbols(selector_string, evaluation_symbols_start, evaluation_symbols_include_tsc, evaluation_symbols_stop)[source]

Configures the evaluation symbols. The GSM standard specifies that 50% to 90% portion of the burst, excluding the midamble, be measured. However, RFmxGSM allows you to specify the portion of the burst to measure for ORFS due to modulation. RFmx considers the measurement over evaluation symbols for a single burst as one average.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • evaluation_symbols_start (float) – This parameter specifies the start position of the burst over which you perform the ORFS measurement. This value is expressed as a percentage. The default value is 50.

  • evaluation_symbols_include_tsc (enums.OrfsEvaluationSymbolsIncludeTsc, int) –

    This parameter specifies whether to include the TSC portion of burst in the ORFS measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    The TSC portion of the burst is excluded in the ORFS measurement.

    True (1)

    The TSC portion of the burst is included in the ORFS measurement.

  • evaluation_symbols_stop (float) – This parameter specifies the stop position of the burst over which you perform the ORFS measurement. This value is expressed as a percentage. The default value is 90.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_measurement_type(selector_string, measurement_type)[source]

Configures the type of spectral distortion to be measured.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • measurement_type (enums.OrfsMeasurementType, int) –

    This parameter specifies the type of spectral distortion to be measured. The default value is Modulation and Switching.

    Name (Value)

    Description

    Modulation and Switching (0)

    Measures the spectrum on the modulated part and switching part of the waveform.

    Modulation (1)

    Measures the spectrum on the modulated part of the waveform.

    Switching (2)

    Measures the spectrum on the switching part of the waveform.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_noise_compensation_enabled(selector_string, noise_compensation_enabled)[source]

Configures whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • noise_compensation_enabled (enums.OrfsNoiseCompensationEnabled, int) –

    This parameter specifies whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer. The default value is False.

    Name (Value)

    Description

    False (0)

    Disables compensation of the channel powers for the signal analyzer noise floor.

    True (1)

    Enables compensation of the channel powers for the signal analyzer noise floor. The measurement calculates the signal analyzer noise floor for the RF path used by the output radio frequency spectrum (ORFS) measurement and caches the noise floor for future use. If signal analyzer parameters or measurement parameters change, the measurement calculates noise floors again.

    Supported Devices: PXIe-5663/5665/5668R, PXIe-5830/5831/5832

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_offset_frequency_mode(selector_string, offset_frequency_mode)[source]

Configures the list of frequency offsets for which you can perform the output radio frequency spectrum (ORFS) measurements.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • offset_frequency_mode (enums.OrfsOffsetFrequencyMode, int) –

    This parameter specifies the list of frequency offsets for which you can perform the ORFS measurements. The default value is Standard.

    Name (Value)

    Description

    Standard (0)

    Uses a list of lower and upper offset frequencies of 100 kHz, 200 kHz, 250 kHz, 400 kHz, 600 kHz, 800 kHz, 1000 kHz, 1200 kHz, 1400 kHz, 1600 kHz, and 1800 kHz for the spectrum due to the modulation measurement, and the lower and upper offset frequencies of 400 kHz, 600 kHz, 1200 kHz, and 1800 kHz for the spectrum produced by the switching measurement.

    Short (1)

    Uses the list of lower and upper offset frequencies of 200 kHz, 250 kHz, 400 kHz, 600 kHz, and 1200 kHz for the spectrum due to the modulation measurement, and the lower and upper offset frequencies of 400 kHz, 600 kHz, 1200 kHz, and 1800 kHz for the spectrum produced by the switching measurement.

    Custom (2)

    Uses the list of frequencies that is configured using the RFmxGSM ORFS Configure Modulation Custom Offset Frequency (Array) and RFmxGSM ORFS Configure Switching Custom Offset Frequency (Array) methods for measurement of spectrum produced by modulation and switching measurements.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the traces to be stored and retrieved after performing the output radio frequency spectrum (ORFS) measurement.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the ORFS_AVERAGING_ENABLED attribute to 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 String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of acquisitions used for averaging when you set the ORFS_AVERAGING_ENABLED attribute to True.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The measurement is averaged over multiple acquisitions.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsAveragingEnabled):

Specifies whether to enable averaging for the output radio frequency spectrum (ORFS) measurement.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_type(selector_string)[source]

Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is Log.

Name (Value)

Description

RMS (0)

The measurement averages the power spectrum linearly. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The measurement averages the power spectrum in a logarithmic scale.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsAveragingType):

Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the output radio frequency spectrum (ORFS) measurement.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_evaluation_symbols_include_tsc(selector_string)[source]

Gets whether to include the training sequence code (TSC) portion of burst for measuring ORFS due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)

Description

False (0)

The TSC portion of the burst will be excluded while performing the ORFS measurement.

True (1)

The TSC portion of the burst will be included while performing the ORFS measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsEvaluationSymbolsIncludeTsc):

Specifies whether to include the training sequence code (TSC) portion of burst for measuring ORFS due to modulation.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_evaluation_symbols_scope(selector_string)[source]

Gets the modulation power measurements that will use the part of burst configured using the configure_evaluation_symbols().

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Offset.

Name (Value)

Description

Offset (0)

Modulation Offset Power measurements will only use the part of burst configured using the RFmxGSM ORFS Configure Evaluation Symbols method. Modulation Carrier Power measurement will use all of the useful part of the burst.

Offset and Carrier (1)

Modulation Offset and Carrier Power measurements will both use the part of burst configured using the RFmxGSM ORFS Configure Evaluation Symbols method.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsEvaluationSymbolsScope):

Specifies the modulation power measurements that will use the part of burst configured using the configure_evaluation_symbols().

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_evaluation_symbols_start(selector_string)[source]

Gets the start position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 50.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_evaluation_symbols_stop(selector_string)[source]

Gets the stop position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 90.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the stop position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the output radio frequency spectrum (ORFS) measurement.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_interval(selector_string)[source]

Gets whether the measurement is performed on a single specified timeslot or across multiple timeslots.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default Value is ‘Number of Timeslots’.

Name (Value)

Description

Number of Timeslots (0)

The measurement includes all timeslots defined by the Num Timeslots attribute.

Timeslot at Offset (1)

The measurement is performed only on the timeslot specified by the ORFS Meas Offset attribute. This attribute is applicable only when you set the Trigger Type attribute to IQ Power Edge or **Digital Edge **.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsMeasurementInterval):

Specifies whether the measurement is performed on a single specified timeslot or across multiple timeslots.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_offset(selector_string)[source]

Gets the offset, relative to the trigger, of the timeslot to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0. Valid values are [0, (NUMBER_OF_TIMESLOTS -1)].

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the offset, relative to the trigger, of the timeslot to be measured.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_type(selector_string)[source]

Gets the type of spectral distortion to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Modulation and Switching.

Name (Value)

Description

Modulation and Switching (0)

Measures the spectrum on the modulated part and the switching part of the waveform.

Modulation (1)

Measures the spectrum on the modulated part of the waveform.

Switching (2)

Measures the spectrum on the switching part of the waveform.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsMeasurementType):

Specifies the type of spectral distortion to be measured.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_modulation_carrier_rbw(selector_string)[source]

Gets the RBW used for measuring modulation carrier power 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 String topic for information about the string syntax for named signals.

The default value is 30kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the RBW used for measuring modulation carrier power in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_modulation_number_of_offsets(selector_string)[source]

Gets the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to modulation.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_modulation_offset_frequency(selector_string)[source]

Gets the value of positive frequency offset for which to measure the spectrum due to modulation measurement. This value is expressed in Hz.

Use “offset<n>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the value of positive frequency offset for which to measure the spectrum due to modulation measurement. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_modulation_offset_rbw(selector_string)[source]

Gets the resolution bandwidth used for ORFS due to modulation measurement. This value is expressed in Hz.

Use “offset<n>” as the selector string to configure or read this attribute.

The default value is 30000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the resolution bandwidth used for ORFS due to modulation measurement. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_noise_compensation_enabled(selector_string)[source]

Gets whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer. Noise compensation is applicable only on modulation offsets and not on switching offsets.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Supported Devices: PXIe-5663/5665/5668R, PXIe-5830/5831/5832

Name (Value)

Description

False (0)

Disables compensation of the channel powers for the signal analyzer noise floor.

True (1)

Enables compensation of the channel powers for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the output radio frequency spectrum (ORFS) measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsNoiseCompensationEnabled):

Specifies whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer. Noise compensation is applicable only on modulation offsets and not on switching offsets.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for the output radio frequency spectrum (ORFS) measurement.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_offset_frequency_mode(selector_string)[source]

Gets the list of frequency offsets for which you can perform the output radio frequency spectrum (ORFS) measurements.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Standard.

Name (Value)

Description

Standard (0)

Uses the list of lower and upper offset frequencies of 100 kHz, 200 kHz, 250 kHz, 400 kHz, 600 kHz, 800 kHz, 1000 kHz, 1200 kHz, 1400 kHz, 1600 kHz, and 1800 kHz for the spectrum due to the modulation measurement, and the lower and upper offset frequencies of 400 kHz, 600 kHz, 1200 kHz, and 1800 kHz for the spectrum produced by the switching measurement.

Short (1)

Uses the list of lower and upper offset frequencies of 200 kHz, 250 kHz, 400 kHz, 600 kHz, and 1200 kHz for the spectrum due to the modulation measurement, and the lower and upper offset frequencies of 400 kHz, 600 kHz, 1200 kHz, and 1800 kHz for the spectrum produced by the switching measurement.

Custom (2)

Uses the list of frequencies that is configured using the RFmxGSM ORFS Configure Modulation Custom Offset Frequency (Array) and RFmxGSM ORFS Configure Switching Custom Offset Frequency (Array) methods for measurement of spectrum produced by modulation and switching measurements.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.OrfsOffsetFrequencyMode):

Specifies the list of frequency offsets for which you can perform the output radio frequency spectrum (ORFS) measurements.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_switching_carrier_rbw(selector_string)[source]

Gets the RBW used for measuring switching carrier power 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 String topic for information about the string syntax for named signals.

The default value is 300kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the RBW used for measuring switching carrier power in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_switching_number_of_offsets(selector_string)[source]

Gets the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to switching.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to switching.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_switching_offset_frequency(selector_string)[source]

Gets the value of positive frequency offset for which to measure the spectrum due to switching measurement. This value is expressed in Hz.

Use “offset<n>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the value of positive frequency offset for which to measure the spectrum due to switching measurement. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_switching_offset_rbw(selector_string)[source]

Gets the resolution bandwidth used for ORFS due to switching measurement. This value is expressed in Hz.

Use “offset<n>” as the selector string to configure or read this attribute.

The default value is 30kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the resolution bandwidth used for ORFS due to switching measurement. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

orfs_configure_modulation_custom_offset_frequency_array(selector_string, modulation_custom_offset_frequency)[source]

Configures an array of positive offset frequencies relative to the carrier frequency for the spectrum measurement because of modulation when you set the ORFS_OFFSET_FREQUENCY_MODE attribute to Custom.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • modulation_custom_offset_frequency (float) – This parameter specifies an array of positive offset frequencies relative to the frequency of the carrier for the spectrum measurement because of modulation when you set the ORFS_OFFSET_FREQUENCY_MODE attribute to Custom. This value is expressed in Hz. The lower offset frequency or the negative offset value corresponding to each entry is automatically considered for the measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

orfs_configure_switching_custom_offset_frequency_array(selector_string, switching_custom_offset_frequency)[source]

Configures an array of positive offset frequencies relative to the carrier frequency for the spectrum measurement because of switching when you set the ORFS_OFFSET_FREQUENCY_MODE attribute to Custom.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • switching_custom_offset_frequency (float) – This parameter specifies an array of positive offset frequencies relative to the frequency of the carrier for the spectrum measurement because of switching when you set the ORFS_OFFSET_FREQUENCY_MODE attribute to Custom. This value is expressed in Hz. The lower offset frequency or the negative offset value corresponding to each entry is automatically considered for the measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the output radio frequency spectrum (ORFS) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the ORFS_AVERAGING_ENABLED attribute to 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 String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of acquisitions used for averaging when you set the ORFS_AVERAGING_ENABLED attribute to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The measurement is averaged over multiple acquisitions.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.OrfsAveragingEnabled, int) – Specifies whether to enable averaging for the output radio frequency spectrum (ORFS) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_averaging_type(selector_string, value)[source]

Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is Log.

Name (Value)

Description

RMS (0)

The measurement averages the power spectrum linearly. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The measurement averages the power spectrum in a logarithmic scale.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.OrfsAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the output radio frequency spectrum (ORFS) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_evaluation_symbols_include_tsc(selector_string, value)[source]

Sets whether to include the training sequence code (TSC) portion of burst for measuring ORFS due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)

Description

False (0)

The TSC portion of the burst will be excluded while performing the ORFS measurement.

True (1)

The TSC portion of the burst will be included while performing the ORFS measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.OrfsEvaluationSymbolsIncludeTsc, int) – Specifies whether to include the training sequence code (TSC) portion of burst for measuring ORFS due to modulation.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_evaluation_symbols_scope(selector_string, value)[source]

Sets the modulation power measurements that will use the part of burst configured using the configure_evaluation_symbols().

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Offset.

Name (Value)

Description

Offset (0)

Modulation Offset Power measurements will only use the part of burst configured using the RFmxGSM ORFS Configure Evaluation Symbols method. Modulation Carrier Power measurement will use all of the useful part of the burst.

Offset and Carrier (1)

Modulation Offset and Carrier Power measurements will both use the part of burst configured using the RFmxGSM ORFS Configure Evaluation Symbols method.
Parameters:
Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_evaluation_symbols_start(selector_string, value)[source]

Sets the start position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 50.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the start position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_evaluation_symbols_stop(selector_string, value)[source]

Sets the stop position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 90.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the stop position within the useful part of the burst, in percentage, for measuring ORFS due to modulation.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the output radio frequency spectrum (ORFS) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_interval(selector_string, value)[source]

Sets whether the measurement is performed on a single specified timeslot or across multiple timeslots.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default Value is ‘Number of Timeslots’.

Name (Value)

Description

Number of Timeslots (0)

The measurement includes all timeslots defined by the Num Timeslots attribute.

Timeslot at Offset (1)

The measurement is performed only on the timeslot specified by the ORFS Meas Offset attribute. This attribute is applicable only when you set the Trigger Type attribute to IQ Power Edge or **Digital Edge **.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.OrfsMeasurementInterval, int) – Specifies whether the measurement is performed on a single specified timeslot or across multiple timeslots.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_offset(selector_string, value)[source]

Sets the offset, relative to the trigger, of the timeslot to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0. Valid values are [0, (NUMBER_OF_TIMESLOTS -1)].

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the offset, relative to the trigger, of the timeslot to be measured.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_type(selector_string, value)[source]

Sets the type of spectral distortion to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Modulation and Switching.

Name (Value)

Description

Modulation and Switching (0)

Measures the spectrum on the modulated part and the switching part of the waveform.

Modulation (1)

Measures the spectrum on the modulated part of the waveform.

Switching (2)

Measures the spectrum on the switching part of the waveform.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.OrfsMeasurementType, int) – Specifies the type of spectral distortion to be measured.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_modulation_carrier_rbw(selector_string, value)[source]

Sets the RBW used for measuring modulation carrier power 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 String topic for information about the string syntax for named signals.

The default value is 30kHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the RBW used for measuring modulation carrier power in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_modulation_number_of_offsets(selector_string, value)[source]

Sets the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to modulation.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to modulation.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_modulation_offset_frequency(selector_string, value)[source]

Sets the value of positive frequency offset for which to measure the spectrum due to modulation measurement. This value is expressed in Hz.

Use “offset<n>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the value of positive frequency offset for which to measure the spectrum due to modulation measurement. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_noise_compensation_enabled(selector_string, value)[source]

Sets whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer. Noise compensation is applicable only on modulation offsets and not on switching offsets.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Supported Devices: PXIe-5663/5665/5668R, PXIe-5830/5831/5832

Name (Value)

Description

False (0)

Disables compensation of the channel powers for the signal analyzer noise floor.

True (1)

Enables compensation of the channel powers for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the output radio frequency spectrum (ORFS) measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.OrfsNoiseCompensationEnabled, int) – Specifies whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer. Noise compensation is applicable only on modulation offsets and not on switching offsets.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the output radio frequency spectrum (ORFS) 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 String topic for information about the string syntax for named signals.

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for the output radio frequency spectrum (ORFS) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_offset_frequency_mode(selector_string, value)[source]

Sets the list of frequency offsets for which you can perform the output radio frequency spectrum (ORFS) measurements.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Standard.

Name (Value)

Description

Standard (0)

Uses the list of lower and upper offset frequencies of 100 kHz, 200 kHz, 250 kHz, 400 kHz, 600 kHz, 800 kHz, 1000 kHz, 1200 kHz, 1400 kHz, 1600 kHz, and 1800 kHz for the spectrum due to the modulation measurement, and the lower and upper offset frequencies of 400 kHz, 600 kHz, 1200 kHz, and 1800 kHz for the spectrum produced by the switching measurement.

Short (1)

Uses the list of lower and upper offset frequencies of 200 kHz, 250 kHz, 400 kHz, 600 kHz, and 1200 kHz for the spectrum due to the modulation measurement, and the lower and upper offset frequencies of 400 kHz, 600 kHz, 1200 kHz, and 1800 kHz for the spectrum produced by the switching measurement.

Custom (2)

Uses the list of frequencies that is configured using the RFmxGSM ORFS Configure Modulation Custom Offset Frequency (Array) and RFmxGSM ORFS Configure Switching Custom Offset Frequency (Array) methods for measurement of spectrum produced by modulation and switching measurements.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.OrfsOffsetFrequencyMode, int) – Specifies the list of frequency offsets for which you can perform the output radio frequency spectrum (ORFS) measurements.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_switching_carrier_rbw(selector_string, value)[source]

Sets the RBW used for measuring switching carrier power 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 String topic for information about the string syntax for named signals.

The default value is 300kHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the RBW used for measuring switching carrier power in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_switching_number_of_offsets(selector_string, value)[source]

Sets the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to switching.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of positive frequency offsets relative to the frequency of the carrier for the measurement of the spectrum due to switching.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_switching_offset_frequency(selector_string, value)[source]

Sets the value of positive frequency offset for which to measure the spectrum due to switching measurement. This value is expressed in Hz.

Use “offset<n>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the value of positive frequency offset for which to measure the spectrum due to switching measurement. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int