PhaseNoiseConfiguration

Provides methods to configure the PhaseNoise measurement.

class nirfmxspecan.phase_noise_configuration.PhaseNoiseConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the PhaseNoise measurement.

configure_auto_range(selector_string, start_frequency, stop_frequency, rbw_percentage)[source]

Configures the offset range and the RBW percentage when you set the RANGE_DEFINITION attribute to Auto.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
start_frequency (float) – This parameter specifies the start frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto. This value is expressed in Hz. The default value is 1000.
stop_frequency (float) – This parameter specifies the stop frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto. This value is expressed in Hz. The default value is 1000000.
rbw_percentage (float) – This parameter specifies the RBW as a percentage of the start frequency of each subrange when you set the RANGE_DEFINITION attribute to Manual. This value is expressed as a percentage. The default value is 10.

Returns:

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

Return type:

int

configure_averaging_multiplier(selector_string, averaging_multiplier)[source]

Configures the averaging multiplier.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
averaging_multiplier (int) – This parameter specifies the factor by which you increase the averaging count for each range. This setting applies to both Auto and Manual range definitions. The default value is 1.

Returns:

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

Return type:

int

configure_cancellation(selector_string, cancellation_enabled, cancellation_threshold, frequency, reference_phase_noise)[source]

Configures phase noise cancellation for the measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
cancellation_enabled (enums.PhaseNoiseCancellationEnabled, int) –
This parameter specifies whether to enable or disable the phase noise cancellation.

Refer to the Phase Noise topic for more information on phase noise cancellation.

Name (Value)

Description

False (0)

Disables phase noise cancellation.

True (1)

Enables phase noise cancellation.
cancellation_threshold (float) – This parameter specifies the minimum difference between the reference and pre-cancellation traces that must exist before cancellation is performed. This value is expressed in dB.
frequency (float) – This parameter specifies an array of frequencies where the reference phase noise has been measured. This value is expressed in Hz.
reference_phase_noise (float) – This parameter specifies an array of the reference phase noise at the frequencies specified by the phase noise cancellation frequency parameter. This value is expressed in dBc/Hz.

Returns:

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

Return type:

int

configure_integrated_noise(selector_string, integrated_noise_range_definition, integrated_noise_start_frequency, integrated_noise_stop_frequency)[source]

Configures the integrated noise ranges. The smoothed log plot trace is used when computing integrated measurements.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
integrated_noise_range_definition (enums.PhaseNoiseIntegratedNoiseRangeDefinition, int) – This parameter specifies the frequency range for the integrated noise measurements.
integrated_noise_start_frequency (float) – This parameter specifies an array of the start frequencies when you set the Integrated Noise Range Definition parameter to Custom. This value is expressed in Hz.
integrated_noise_stop_frequency (float) – This parameter specifies an array of the stop frequencies when you set the Integrated Noise Range Definition parameter to Custom. 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

configure_number_of_ranges(selector_string, number_of_ranges)[source]

Configures the number of offset ranges when you set the RANGE_DEFINITION attribute to ** Manual**.

Parameters:

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

number_of_ranges (int) –

This parameter specifies the number of manual ranges. The default value is 1.

Name (Value)	Description
None (0)	Integrated noise measurement is not computed.
Measurement (1)	The complete log plot frequency range, considered as a single range, is used for computing integrated measurements.
Custom (2)	The measurement range(s) specified by PhaseNoise Integrated Noise Start Freq attribute and the PhaseNoise Integrated Noise Stop Freq attribute is used for computing integrated measurements.

Returns:

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

Return type:

int

configure_range_array(selector_string, range_start_frequency, range_stop_frequency, range_rbw_percentage, range_averaging_count)[source]

Configures an array of the offset range, RBW percentage and averaging count when you set the RANGE_DEFINITION attribute to Manual.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
range_start_frequency (float) – This parameter specifies the start frequency of the offset frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Auto. This value is expressed in Hz. The default value is 1000..
range_stop_frequency (float) – This parameter Specifies the stop offset frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual. This value is expressed in Hz. The default value is 1000000.
range_rbw_percentage (float) – This parameter specifies the RBW as a percentage of the start frequency of the specified subrange when you set the RANGE_DEFINITION attribute to Manual. This value is expressed as a percentage. The default value is 10.
range_averaging_count (int) – This parameter specifies the averaging count for the specified range. The default value is 10.

Returns:

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

Return type:

int

configure_range_definition(selector_string, range_definition)[source]

Specifies how the measurement computes offset subranges.

Parameters:

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

range_definition (enums.PhaseNoiseRangeDefinition, int) –

This parameter specifies how the measurement computes offset subranges.

Name (Value)	Description
Manual (0)	Specify the offset sub-ranges used for the measurement. Use the PhaseNoise Range Start Freq attribute and the PhaseNoise Range Stop Freq attribute to configure single or multiple range start and range stop frequencies.
Auto (1)	Measurement computes offset sub-ranges by dividing the user configured offset range into multiple decade sub-ranges. The range is specified by the PhaseNoise Start Freq and the PhaseNoise Stop Freq attributes.

Returns:

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

Return type:

int

configure_smoothing(selector_string, smoothing_type, smoothing_percentage)[source]

Configures the smoothing type and smoothing percentage used to smoothen the measured log plot trace.

Parameters:

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

smoothing_type (enums.PhaseNoiseSmoothingType, int) –

This parameter specifies the smoothing type used to smoothen the measured log plot trace. The default value is Logarithmic.

Name (Value)	Description
None (0)	Smoothing is disabled.
Linear (1)	Performs linear moving average filtering on the measured phase noise log plot trace.
Logarithmic (2)	Performs logarithmic moving average filtering on the measured phase noise log plot trace.
Median (3)	Performs moving median filtering on the measured phase noise log plot trace.

smoothing_percentage (float) – This parameter specifies the number of points to use in the moving average filter as a percentage of total number of points in the log plot trace. This value is expressed as a percentage. The default value is 2.

Returns:

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

Return type:

int

configure_spot_noise_frequency_list(selector_string, frequency_list)[source]

Configures a list of frequencies at which the phase noise values are to be read using the smoothed log plot trace.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
frequency_list (float) – This parameter specifies an array of offset frequencies at which the corresponding phase noise is measured using the smoothed log plot trace. This value is expressed in Hz. The default value is an empty array.

Returns:

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

Return type:

int

configure_spur_removal(selector_string, spur_removal_enabled, peak_excursion)[source]

Configures enabling or disabling of the spur removal and the peak excursion to use when spur removal is enabled.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
spur_removal_enabled (enums.PhaseNoiseSpurRemovalEnabled, int) –
This parameter specifies whether the spur removal is enabled or disabled.

Name (Value)

Description

False (0)

Disables spur removal on the log plot trace.

True (1)

Enables spur removal on the log plot trace.
peak_excursion (float) – This parameter specifies the peak excursion to be used when spur detection is performed.

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 Phase Noise 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 Phase Noise 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_multiplier(selector_string)[source]

Gets the factor by which you increase the averaging count for each range. This setting applies to both Auto and Manual range definitions.

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 factor by which you increase the averaging count for each range. This setting applies to both Auto and Manual range definitions.
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_cancellation_enabled(selector_string)[source]

Gets whether to enable or disable the phase noise cancellation.

Refer to the Phase Noise topic for more information on phase noise cancellation.

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)	Disables phase noise cancellation.
True (1)	Enables phase noise cancellation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PhaseNoiseCancellationEnabled):: Specifies whether to enable or disable the phase noise cancellation.
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_cancellation_frequency(selector_string)[source]

Gets an array of frequencies where the reference phase noise has been 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of frequencies where the reference phase noise has been 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_cancellation_reference_phase_noise(selector_string)[source]

Gets an array of reference phase noise at the frequencies specified by the CANCELLATION_FREQUENCY 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 String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of reference phase noise at the frequencies specified by the CANCELLATION_FREQUENCY attribute .
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_cancellation_threshold(selector_string)[source]

Gets the minimum difference between the reference and pre-cancellation traces that must exist before cancellation is performed.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the minimum difference between the reference and pre-cancellation traces that must exist before cancellation is performed.
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_fft_window(selector_string)[source]

Gets the FFT window to use.

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

Name (Value)	Description
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.
Flat Top (1)	Measures single-tone amplitudes accurately.
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.
Hamming (3)	Analyzes closely-spaced sine waves.
Gaussian (4)	Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
Blackman (5)	Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.
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.
Kaiser-Bessel (7)	Separates two tones with frequencies close to each other but with widely-differing amplitudes.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PhaseNoiseFftWindow):: Specifies the FFT window to use.
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_integrated_noise_range_definition(selector_string)[source]

Gets the frequency range for integrated noise 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 ** Measurement**.

Name (Value)	Description
None (0)	Integrated noise measurement is not computed.
Measurement (1)	The complete log plot frequency range, considered as a single range, is used for computing integrated measurements.
Custom (2)	The measurement range(s) specified by PhaseNoise Integrated Noise Start Freq attribute and the PhaseNoise Integrated Noise Stop Freq attribute is used for computing integrated measurements.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PhaseNoiseIntegratedNoiseRangeDefinition):: Specifies the frequency range for integrated noise 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_integrated_noise_start_frequency(selector_string)[source]

Gets an array of the start frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of the start frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.
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_integrated_noise_stop_frequency(selector_string)[source]

Gets an array of the stop frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of the stop frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.
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 phase noise 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 phase noise 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_number_of_ranges(selector_string)[source]

Gets the number of manual ranges.

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 number of manual ranges.
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_range_averaging_count(selector_string)[source]

Gets the averaging count for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the averaging count for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.
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_range_definition(selector_string)[source]

Gets how the measurement computes offset subranges.

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

Name (Value)	Description
Manual (0)	Specify the offset sub-ranges used for the measurement. Use the PhaseNoise Range Start Freq attribute and the PhaseNoise Range Stop Freq attribute to configure single or multiple range start and range stop frequencies.
Auto (1)	Measurement computes offset sub-ranges by dividing the user configured offset range into multiple decade sub-ranges. The range is specified by the PhaseNoise Start Freq and the PhaseNoise Stop Freq attributes.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PhaseNoiseRangeDefinition):: Specifies how the measurement computes offset subranges.
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_range_rbw_percentage(selector_string)[source]

Gets the RBW as a percentage of the RANGE_START_FREQUENCY attribute of the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the RBW as a percentage of the RANGE_START_FREQUENCY attribute of the specified subrange when you set the RANGE_DEFINITION attribute to Manual.
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_range_start_frequency(selector_string)[source]

Gets the start frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 1000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the start frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.
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_range_stop_frequency(selector_string)[source]

Gets the stop frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 1E+06.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the stop frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.
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_rbw_percentage(selector_string)[source]

Gets the RBW as a percentage of the start frequency of each subrange when you set the RANGE_DEFINITION attribute to Auto.

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 (float):: Specifies the RBW as a percentage of the start frequency of each subrange when you set the RANGE_DEFINITION attribute to Auto.
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_smoothing_percentage(selector_string)[source]

Gets the number of trace points to use in the moving average filter as a percentage of total number of points in the log plot trace.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the number of trace points to use in the moving average filter as a percentage of total number of points in the log plot trace.
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_smoothing_type(selector_string)[source]

Gets the smoothing type used to smoothen the measured log plot trace.

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

Name (Value)	Description
None (0)	Smoothing is disabled.
Linear (1)	Performs linear moving average filtering on the measured phase noise log plot trace.
Logarithmic (2)	Performs logarithmic moving average filtering on the measured phase noise log plot trace.
Median (3)	Performs moving median filtering on the measured phase noise log plot trace.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PhaseNoiseSmoothingType):: Specifies the smoothing type used to smoothen the measured log plot trace.
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_spot_noise_frequency_list(selector_string)[source]

Gets an array of offset frequencies at which the phase noise is measured using the smoothed log plot trace.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of offset frequencies at which the phase noise is measured using the smoothed log plot trace.
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_spur_removal_enabled(selector_string)[source]

Gets whether to remove spurs from the log plot trace.

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)	Disables spur removal on the log plot trace.
True (1)	Enables spur removal on the log plot trace.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PhaseNoiseSpurRemovalEnabled):: Specifies whether to remove spurs from the log plot trace.
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_spur_removal_peak_excursion(selector_string)[source]

Gets the peak excursion to be used when spur detection is performed.

Refer to the Phase Noise topic for more information on spur removal.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the peak excursion to be used when spur detection is performed.
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_start_frequency(selector_string)[source]

Gets the start frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the start frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.
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_stop_frequency(selector_string)[source]

Gets the stop frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.

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 1E+06.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the stop frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.
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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the Phase Noise 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 Phase Noise 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_multiplier(selector_string, value)[source]

Sets the factor by which you increase the averaging count for each range. This setting applies to both Auto and Manual range definitions.

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 factor by which you increase the averaging count for each range. This setting applies to both Auto and Manual range definitions.

Returns:

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

Return type:

int

set_cancellation_enabled(selector_string, value)[source]

Sets whether to enable or disable the phase noise cancellation.

Refer to the Phase Noise topic for more information on phase noise cancellation.

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)	Disables phase noise cancellation.
True (1)	Enables phase noise cancellation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PhaseNoiseCancellationEnabled, int) – Specifies whether to enable or disable the phase noise cancellation.

Returns:

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

Return type:

int

set_cancellation_frequency(selector_string, value)[source]

Sets an array of frequencies where the reference phase noise has been 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.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of frequencies where the reference phase noise has been measured.

Returns:

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

Return type:

int

set_cancellation_reference_phase_noise(selector_string, value)[source]

Sets an array of reference phase noise at the frequencies specified by the CANCELLATION_FREQUENCY 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 String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of reference phase noise at the frequencies specified by the CANCELLATION_FREQUENCY attribute .

Returns:

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

Return type:

int

set_cancellation_threshold(selector_string, value)[source]

Sets the minimum difference between the reference and pre-cancellation traces that must exist before cancellation is performed.

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

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the minimum difference between the reference and pre-cancellation traces that must exist before cancellation is performed.

Returns:

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

Return type:

int

set_fft_window(selector_string, value)[source]

Sets the FFT window to use.

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

Name (Value)	Description
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.
Flat Top (1)	Measures single-tone amplitudes accurately.
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.
Hamming (3)	Analyzes closely-spaced sine waves.
Gaussian (4)	Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
Blackman (5)	Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.
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.
Kaiser-Bessel (7)	Separates two tones with frequencies close to each other but with widely-differing amplitudes.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PhaseNoiseFftWindow, int) – Specifies the FFT window to use.

Returns:

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

Return type:

int

set_integrated_noise_range_definition(selector_string, value)[source]

Sets the frequency range for integrated noise 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 ** Measurement**.

Name (Value)	Description
None (0)	Integrated noise measurement is not computed.
Measurement (1)	The complete log plot frequency range, considered as a single range, is used for computing integrated measurements.
Custom (2)	The measurement range(s) specified by PhaseNoise Integrated Noise Start Freq attribute and the PhaseNoise Integrated Noise Stop Freq attribute is used for computing integrated measurements.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PhaseNoiseIntegratedNoiseRangeDefinition, int) – Specifies the frequency range for integrated noise measurements.

Returns:

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

Return type:

int

set_integrated_noise_start_frequency(selector_string, value)[source]

Sets an array of the start frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of the start frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.

Returns:

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

Return type:

int

set_integrated_noise_stop_frequency(selector_string, value)[source]

Sets an array of the stop frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of the stop frequencies for integrated noise measurement when you set the INTEGRATED_NOISE_RANGE_DEFINITION attribute to Custom.

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 phase noise 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 phase noise measurement.

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_ranges(selector_string, value)[source]

Sets the number of manual ranges.

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 number of manual ranges.

Returns:

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

Return type:

int

set_range_averaging_count(selector_string, value)[source]

Sets the averaging count for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the averaging count for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Returns:

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

Return type:

int

set_range_definition(selector_string, value)[source]

Sets how the measurement computes offset subranges.

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

Name (Value)	Description
Manual (0)	Specify the offset sub-ranges used for the measurement. Use the PhaseNoise Range Start Freq attribute and the PhaseNoise Range Stop Freq attribute to configure single or multiple range start and range stop frequencies.
Auto (1)	Measurement computes offset sub-ranges by dividing the user configured offset range into multiple decade sub-ranges. The range is specified by the PhaseNoise Start Freq and the PhaseNoise Stop Freq attributes.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PhaseNoiseRangeDefinition, int) – Specifies how the measurement computes offset subranges.

Returns:

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

Return type:

int

set_range_rbw_percentage(selector_string, value)[source]

Sets the RBW as a percentage of the RANGE_START_FREQUENCY attribute of the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the RBW as a percentage of the RANGE_START_FREQUENCY attribute of the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Returns:

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

Return type:

int

set_range_start_frequency(selector_string, value)[source]

Sets the start frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 1000.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the start frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Returns:

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

Return type:

int

set_range_stop_frequency(selector_string, value)[source]

Sets the stop frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Use “range<n>” as the Selector String to configure or read this attribute.

The default value is 1E+06.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the stop frequency for the specified subrange when you set the RANGE_DEFINITION attribute to Manual.

Returns:

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

Return type:

int

set_rbw_percentage(selector_string, value)[source]

Sets the RBW as a percentage of the start frequency of each subrange when you set the RANGE_DEFINITION attribute to Auto.

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 (float) – Specifies the RBW as a percentage of the start frequency of each subrange when you set the RANGE_DEFINITION attribute to Auto.

Returns:

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

Return type:

int

set_smoothing_percentage(selector_string, value)[source]

Sets the number of trace points to use in the moving average filter as a percentage of total number of points in the log plot trace.

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

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the number of trace points to use in the moving average filter as a percentage of total number of points in the log plot trace.

Returns:

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

Return type:

int

set_smoothing_type(selector_string, value)[source]

Sets the smoothing type used to smoothen the measured log plot trace.

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

Name (Value)	Description
None (0)	Smoothing is disabled.
Linear (1)	Performs linear moving average filtering on the measured phase noise log plot trace.
Logarithmic (2)	Performs logarithmic moving average filtering on the measured phase noise log plot trace.
Median (3)	Performs moving median filtering on the measured phase noise log plot trace.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PhaseNoiseSmoothingType, int) – Specifies the smoothing type used to smoothen the measured log plot trace.

Returns:

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

Return type:

int

set_spot_noise_frequency_list(selector_string, value)[source]

Sets an array of offset frequencies at which the phase noise is measured using the smoothed log plot trace.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of offset frequencies at which the phase noise is measured using the smoothed log plot trace.

Returns:

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

Return type:

int

set_spur_removal_enabled(selector_string, value)[source]

Sets whether to remove spurs from the log plot trace.

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)	Disables spur removal on the log plot trace.
True (1)	Enables spur removal on the log plot trace.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PhaseNoiseSpurRemovalEnabled, int) – Specifies whether to remove spurs from the log plot trace.

Returns:

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

Return type:

int

set_spur_removal_peak_excursion(selector_string, value)[source]

Sets the peak excursion to be used when spur detection is performed.

Refer to the Phase Noise topic for more information on spur removal.

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

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the peak excursion to be used when spur detection is performed.

Returns:

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

Return type:

int

set_start_frequency(selector_string, value)[source]

Sets the start frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.

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

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the start frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.

Returns:

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

Return type:

int

set_stop_frequency(selector_string, value)[source]

Sets the stop frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.

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 1E+06.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the stop frequency of the offset frequency range when you set the RANGE_DEFINITION attribute to Auto.

Returns:

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

Return type:

int