ADemodResults

Provides methods to fetch and read the ADemod measurement results.

class nirfmxdemod.analog_demod_results.ADemodResults(signal_obj)

Bases: object

Provides methods to fetch and read the ADemod measurement results.

fetch_am_maximum_modulation_depth(selector_string, timeout)

Fetches the AM maximum modulation depth.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

maximum_modulation_depth (float):

This parameter returns the maximum modulation depth, as a percentage, measured across multiple acquisitions.

maximum_half_peak_to_peak (float):

This parameter returns the maximum (peak-to-peak)/2 amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.

maximum_rms (float):

This parameter returns the maximum RMS amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.

maximum_positive_peak (float):

This parameter returns the maximum positive peak amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.

maximum_negative_peak (float):

This parameter returns the maximum negative peak amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.

error_code (int):

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

Return type:

Tuple (maximum_modulation_depth, maximum_half_peak_to_peak, maximum_rms, maximum_positive_peak, maximum_negative_peak, error_code)

fetch_am_mean_modulation_depth(selector_string, timeout)

Fetches AM mean modulation depth for analog demodulation measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_modulation_depth (float):

This parameter returns the mean amplitude variation, as a percentage, around the unmodulated carrier amplitude. If the carrier is suppressed, the amplitude variation of the modulating signal is returned.

mean_half_peak_to_peak (float):

This parameter returns the mean (peak-to-peak)/2 amplitude, as a percentage, of the modulating signal.

mean_rms (float):

This parameter returns the mean RMS amplitude of the modulating signal.

mean_positive_peak (float):

This parameter returns the mean positive peak amplitude, as a percentage, of the modulating signal.

mean_negative_peak (float):

This parameter returns the mean negative peak amplitude, as a percentage, of the modulating signal.

error_code (int):

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

Return type:

Tuple (mean_modulation_depth, mean_half_peak_to_peak, mean_rms, mean_positive_peak, mean_negative_peak, error_code)

fetch_carrier_measurement(selector_string, timeout)

Fetches the carrier measurement.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_carrier_frequency_error (float):

This parameter returns the mean of the measured carrier frequency error, in Hz.

mean_carrier_power (float):

This parameter returns the mean of the measured carrier power, in dBm.

error_code (int):

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

Return type:

Tuple (mean_carrier_frequency_error, mean_carrier_power, error_code)

fetch_demod_signal_trace(selector_string, timeout, demodulated_signal)

Fetches the demodulated signal trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

• demodulated_signal (numpy.float32) – This parameter returns the demodulated signal.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, in seconds.

error_code (int):

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

Return type:

Tuple (x0, dx, error_code)

fetch_demod_spectrum_trace(selector_string, timeout, demodulated_spectrum)

Fetches the demodulated signal spectrum trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

• demodulated_spectrum (numpy.float32) – This parameter returns the demodulated signal spectrum.

Returns:

x0 (float):

This parameter returns the start bin frequency, in Hz.

dx (float):

This parameter returns the frequency bin spacing, 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 (x0, dx, error_code)

fetch_distortions(selector_string, timeout)

Fetches distortions for analog demodulation measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

average_sinad (float):

This parameter returns the averaged signal-to-noise and distortion ratio, in dB, of the demodulated signal.

average_snr (float):

This parameter returns the averaged signal-to-noise ratio, in dB, of the demodulated signal.

average_thd (float):

This parameter returns the averaged total harmonic distortion, as a percentage, of demodulated signal.

average_thd_with_noise (float):

This parameter returns the averaged total harmonic distortion with noise, as a percentage, of the demodulated signal.

error_code (int):

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

Return type:

Tuple (average_sinad, average_snr, average_thd, average_thd_with_noise, error_code)

fetch_fm_maximum_deviation(selector_string, timeout)

Fetches the FM maximum deviation measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

maximum_deviation (float):

This parameter returns the maximum frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

maximum_half_peak_to_peak (float):

This parameter returns the maximum (peak-to-peak)/2 frequency variation, in Hz, around the nominal frequency of the FM carrier measured across multiple acquisitions.

maximum_rms (float):

This parameter returns the maximum RMS frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

maximum_positive_peak (float):

This parameter returns the maximum positive peak frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

maximum_negative_peak (float):

This parameter returns the maximum negative peak frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

error_code (int):

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

Return type:

Tuple (maximum_deviation, maximum_half_peak_to_peak, maximum_rms, maximum_positive_peak, maximum_negative_peak, error_code)

fetch_fm_mean_deviation(selector_string, timeout)

Fetches the FM mean deviation measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_deviation (float):

This parameter returns the mean deviation, in Hz, of the frequency-modulated signal.

mean_half_peak_to_peak (float):

This parameter returns the mean (peak-to-peak)/2 frequency variation, in Hz, around the nominal frequency of the FM carrier.

mean_rms (float):

This parameter returns the mean RMS frequency deviation, in Hz, of the frequency-modulated signal.

mean_positive_peak (float):

This parameter returns the mean positive peak frequency deviation, in Hz, of the frequency-modulated signal.

mean_negative_peak (float):

This parameter returns the mean negative peak frequency deviation of the frequency-modulated signal.

error_code (int):

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

Return type:

Tuple (mean_deviation, mean_half_peak_to_peak, mean_rms, mean_positive_peak, mean_negative_peak, error_code)

fetch_mean_modulation_frequency(selector_string, timeout)

Fetches the mean modulation frequency.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_modulation_frequency (float):

This parameter returns the mean of the demodulated signal frequency.

error_code (int):

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

Return type:

Tuple (mean_modulation_frequency, error_code)

fetch_pm_maximum_deviation(selector_string, timeout)

Fetches the PM maximum deviation measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

maximum_deviation (float):

This parameter returns the maximum phase deviation, in degrees, around the unmodulated carrier phase measured over multiple acquisitions.

maximum_half_peak_to_peak (float):

This parameter returns the maximum (peak to peak)/2 phase deviation, in degrees, around the unmodulated carrier phase measured over multiple acquisitions.

maximum_rms (float):

This parameter returns the maximum RMS phase deviation, in degrees, of the PM signal measured over multiple acquisitions.

maximum_positive_peak (float):

This parameter returns the maximum positive peak phase deviation, in degrees, around the unmodulated carrier phase, measured across multiple acquisitions.

maximum_negative_peak (float):

This parameter returns the maximum negative peak phase deviation, in degrees, around the unmodulated carrier phase, measured across multiple acquisitions.

error_code (int):

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

Return type:

Tuple (maximum_deviation, maximum_half_peak_to_peak, maximum_rms, maximum_positive_peak, maximum_negative_peak, error_code)

fetch_pm_mean_deviation(selector_string, timeout)

Fetches the PM mean deviation measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_deviation (float):

This parameter returns the mean deviation around the unmodulated carrier phase.

mean_half_peak_to_peak (float):

This parameter returns the mean (peak-to-peak)/2 phase deviation, in degrees, around the unmodulated carrier phase.

mean_rms (float):

This parameter returns the mean RMS phase deviation, in degrees, of the phase-modulated signal.

mean_positive_peak (float):

This parameter returns the mean positive peak phase deviation, in degrees, around the unmodulated carrier phase.

mean_negative_peak (float):

This parameter returns the mean negative peak phase deviation, in degrees, around the unmodulated carrier phase.

error_code (int):

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

Return type:

Tuple (mean_deviation, mean_half_peak_to_peak, mean_rms, mean_positive_peak, mean_negative_peak, error_code)

get_am_modulation_depth_maximum_half_peak_to_peak(selector_string)

Gets the maximum (peak-to-peak)/2 amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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):

Returns the maximum (peak-to-peak)/2 amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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_am_modulation_depth_maximum_negative_peak(selector_string)

Gets the maximum negative peak amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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):

Returns the maximum negative peak amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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_am_modulation_depth_maximum_positive_peak(selector_string)

Gets the maximum positive peak amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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):

Returns the maximum positive peak amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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_am_modulation_depth_maximum_rms(selector_string)

Gets the maximum RMS amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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):

Returns the maximum RMS amplitude of the modulating signal measured across multiple acquisitions, as a percentage.

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_am_modulation_depth_maximum_standard_deviation(selector_string)

Gets the maximum modulation depth measured across multiple acquisitions, as a percentage.

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):

Returns the maximum modulation depth measured across multiple acquisitions, as a percentage.

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_am_modulation_depth_mean_half_peak_to_peak(selector_string)

Gets the mean (peak-to-peak)/2 amplitude of the modulating signal, as a percentage.

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):

Returns the mean (peak-to-peak)/2 amplitude of the modulating signal, as a percentage.

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_am_modulation_depth_mean_negative_peak(selector_string)

Gets the mean negative peak amplitude of the modulating signal, as a percentage.

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):

Returns the mean negative peak amplitude of the modulating signal, as a percentage.

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_am_modulation_depth_mean_positive_peak(selector_string)

Gets the mean positive peak amplitude of the modulating signal, as a percentage.

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):

Returns the mean positive peak amplitude of the modulating signal, as a percentage.

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_am_modulation_depth_mean_rms(selector_string)

Gets the mean RMS amplitude of the modulating signal, as a percentage.

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):

Returns the mean RMS amplitude of the modulating signal, as a percentage.

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_am_modulation_depth_mean_standard_deviation(selector_string)

Gets the mean amplitude variation around the unmodulated carrier amplitude, as a percentage. If the carrier is suppressed, the amplitude variation of the modulating signal is returned.

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):

Returns the mean amplitude variation around the unmodulated carrier amplitude, as a percentage. If the carrier is suppressed, the amplitude variation of the modulating signal is returned.

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_average_sinad(selector_string)

Gets the averaged signal-to-noise and distortion ratio of the demodulated signal. This value is expressed in dB.

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):

Returns the averaged signal-to-noise and distortion ratio of the demodulated signal. This value is expressed in dB.

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_average_snr(selector_string)

Gets the averaged signal-to-noise ratio of the demodulated signal. This value is expressed in dB.

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):

Returns the averaged signal-to-noise ratio of the demodulated signal. This value is expressed in dB.

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_average_thd(selector_string)

Gets the averaged total harmonic distortion of the demodulated signal, as a percentage.

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):

Returns the averaged total harmonic distortion of the demodulated signal, as a percentage.

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_average_thd_with_noise(selector_string)

Gets the averaged total harmonic distortion with noise of the demodulated signal, as a percentage.

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):

Returns the averaged total harmonic distortion with noise of the demodulated signal, as a percentage.

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_fm_deviation_maximum_half_peak_to_peak(selector_string)

Gets the maximum (peak-to-peak)/2 frequency variation around the nominal frequency of the FM carrier measured across multiple acquisitions. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum (peak-to-peak)/2 frequency variation around the nominal frequency of the FM carrier measured across multiple acquisitions. 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_fm_deviation_maximum_negative_peak(selector_string)

Gets the maximum negative peak frequency deviation of the frequency-modulated signal measured across multiple acquisitions. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum negative peak frequency deviation of the frequency-modulated signal measured across multiple acquisitions. 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_fm_deviation_maximum_positive_peak(selector_string)

Gets the maximum positive peak frequency deviation of the frequency-modulated signal measured across multiple acquisitions. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum positive peak frequency deviation of the frequency-modulated signal measured across multiple acquisitions. 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_fm_deviation_maximum_rms(selector_string)

Gets the maximum RMS frequency deviation of the frequency-modulated signal measured across multiple acquisitions. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum RMS frequency deviation of the frequency-modulated signal measured across multiple acquisitions. 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_fm_deviation_maximum_standard_deviation(selector_string)

Gets the maximum frequency deviation of the frequency-modulated signal measured across multiple acquisitions. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum frequency deviation of the frequency-modulated signal measured across multiple acquisitions. 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_fm_deviation_mean_half_peak_to_peak(selector_string)

Gets the mean (peak-to-peak)/2 frequency variation around the nominal frequency of the FM carrier. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean (peak-to-peak)/2 frequency variation around the nominal frequency of the FM carrier. 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_fm_deviation_mean_negative_peak(selector_string)

Gets the mean negative peak frequency deviation of the frequency-modulated signal. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean negative peak frequency deviation of the frequency-modulated signal. 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_fm_deviation_mean_positive_peak(selector_string)

Gets the mean positive peak frequency deviation of the frequency-modulated signal. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean positive peak frequency deviation of the frequency-modulated signal. 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_fm_deviation_mean_rms(selector_string)

Gets the mean RMS frequency deviation of the frequency-modulated signal. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean RMS frequency deviation of the frequency-modulated signal. 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_fm_deviation_mean_standard_deviation(selector_string)

Gets the mean frequency deviation around the nominal frequency of the FM carrier. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean frequency deviation around the nominal frequency of the FM carrier. 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_mean_carrier_frequency_error(selector_string)

Gets the mean of the measured carrier frequency offset. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean of the measured carrier frequency offset. 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_mean_carrier_power(selector_string)

Gets the mean of the measured carrier power. This value is expressed in dBm.

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):

Returns the mean of the measured carrier power. This value is expressed in dBm.

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_mean_modulation_frequency(selector_string)

Gets the mean of the demodulated signal frequency. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean of the demodulated signal frequency. 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_pm_deviation_maximum_half_peak_to_peak(selector_string)

Gets the maximum (peak-to-peak)/2 phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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):

Returns the maximum (peak-to-peak)/2 phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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_pm_deviation_maximum_negative_peak(selector_string)

Gets the maximum negative peak phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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):

Returns the maximum negative peak phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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_pm_deviation_maximum_positive_peak(selector_string)

Gets the maximum positive peak phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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):

Returns the maximum positive peak phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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_pm_deviation_maximum_rms(selector_string)

Gets the maximum RMS phase deviation of the phase-modulated signal measured across multiple acquisitions. This value is expressed in degrees.

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):

Returns the maximum RMS phase deviation of the phase-modulated signal measured across multiple acquisitions. This value is expressed in degrees.

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_pm_deviation_maximum_standard_deviation(selector_string)

Gets the maximum phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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):

Returns the maximum phase deviation around the unmodulated carrier phase, measured across multiple acquisitions. This value is expressed in degrees.

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_pm_deviation_mean_half_peak_to_peak(selector_string)

Gets the mean (peak-to-peak)/2 phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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):

Returns the mean (peak-to-peak)/2 phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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_pm_deviation_mean_negative_peak(selector_string)

Gets the mean negative peak phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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):

Returns the mean negative peak phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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_pm_deviation_mean_positive_peak(selector_string)

Gets the mean positive peak phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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):

Returns the mean positive peak phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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_pm_deviation_mean_rms(selector_string)

Gets the mean RMS phase deviation of the phase-modulated signal. This value is expressed in degrees.

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):

Returns the mean RMS phase deviation of the phase-modulated signal. This value is expressed in degrees.

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_pm_deviation_mean_standard_deviation(selector_string)

Gets the mean phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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):

Returns the mean phase deviation around the unmodulated carrier phase. This value is expressed in degrees.

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)

read_am(selector_string, timeout)

Configures hardware for acquisition, performs measurement on acquired data, and returns the AM measurement results.

Parameters:

• selector_string (string) –

  This parameter comprises of the signal name.

  Example:

  ””

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_modulation_depth (float):

This parameter returns the mean amplitude variation, as a percentage, around the unmodulated carrier amplitude. If the carrier is suppressed, the amplitude variation of the modulating signal is returned.

mean_carrier_power (float):

This parameter returns the mean of the measured carrier power, in dBm.

error_code (int):

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

Return type:

Tuple (mean_modulation_depth, mean_carrier_power, error_code)

read_fm(selector_string, timeout)

Configures hardware for acquisition, performs measurement on acquired data, and returns the FM measurement results.

Parameters:

• selector_string (string) –

  This parameter comprises of the signal name.

  Example:

  ””

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_deviation (float):

This parameter returns the mean frequency deviation, in Hz, around the nominal frequency of the FM carrier.

mean_carrier_frequency_error (float):

This parameter returns the mean of the measured carrier frequency error, 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 (mean_deviation, mean_carrier_frequency_error, error_code)

read_pm(selector_string, timeout)

Configures hardware for acquisition, performs measurement on acquired data, and returns the PM measurement results.

Parameters:

• selector_string (string) –

  This parameter comprises of the signal name.

  Example:

  ””

  You can use the build_result_string() method to build the Selector String.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. This value is expressed in seconds.

Returns:

mean_deviation (float):

This parameter returns the mean phase deviation, in degrees, of a phase modulated signal.

mean_carrier_frequency_error (float):

This parameter returns the mean of the measured carrier frequency error, 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 (mean_deviation, mean_carrier_frequency_error, error_code)