ADemodConfiguration

Provides methods to configure the ADemod measurement.

class nirfmxdemod.analog_demod_configuration.ADemodConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the ADemod measurement.

configure_am_carrier_suppressed(selector_string, am_carrier_suppressed_enabled)[source]

Configures the presence of the amplitude modulated (AM) carrier.

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.
am_carrier_suppressed_enabled (enums.ADemodAMCarrierSuppressedEnabled, int) –
This parameter specifies whether the carrier of the AM signal is absent.

The default value is False.

Name (Value)

Description

False (0)

The carrier of the AM signal is present.

True (1)

The carrier of the AM signal is absent.

Returns:

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

Return type:

int

configure_audio_filter(selector_string, audio_filter_type, audio_filter_lower_cutoff_frequency, audio_filter_upper_cutoff_frequency)[source]

Configures the audio filter for analog demodulation measurements.

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.

audio_filter_type (enums.ADemodAudioFilterType, int) –

This parameter specifies the audio filter to be applied on the analog demodulated signal.

The default value is None.

For more information about filter response refer to the Analog Demod topic page.

Name (Value)	Description
None (0)	Does not use any audio filter.
Custom (1)	Uses the filter specified by the Ademod Audio Filter Lower Cutoff attribute and the Ademod Audio Filter Upper Cutoff attribute.
A - Weight (2)	Uses an A-weighted filter.
B - Weight (3)	Uses a B-weighted filter.
C - Weight (4)	Uses a C-weighted filter.
CCITT (5)	Uses the filter specified by CCITT.
ITU-R 468-4 (6)	Uses the filter specified by ITU-R 468-4.

audio_filter_lower_cutoff_frequency (float) – This parameter specifies the lower cutoff frequency, in Hz, of the custom audio filter.
audio_filter_upper_cutoff_frequency (float) – This parameter specifies the upper cutoff frequency, in Hz, of the custom audio filter.

Returns:

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

Return type:

int

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

Configures averaging for analog demodulation measurements.

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.

averaging_enabled (enums.ADemodAveragingEnabled, int) –

This parameter enables averaging for analog demodulation measurement.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The measurement uses the value of the Averaging Count parameter for the number of acquisitions over which the measurement is averaged. The traces are not averaged.

averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True.

averaging_type (enums.ADemodAveragingType, int) –

This parameter specifies the averaging type for the measurement.

Name (Value)	Description
Linear (0)	The averaged result is the mean value measured across multiple acquisitions.
Max (1)	The averaged result is the maximum value measured across multiple acquisitions.
Min (2)	The averaged result is the minimum value measured across multiple acquisitions.

Returns:

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

Return type:

int

configure_carrier_correction(selector_string, carrier_frequency_correction_enabled, carrier_phase_correction_enabled)[source]

Configures the carrier correction in analog demodulation measurements.

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.
carrier_frequency_correction_enabled (enums.ADemodCarrierFrequencyCorrectionEnabled, int) –
This parameter specifies whether to correct the frequency error in the carrier when demodulating frequency-modulated or phase-modulated signals.

The default value is True.

Name (Value)

Description

False (0)

Does not correct the carrier frequency error.

True (1)

Corrects the carrier frequency error.
carrier_phase_correction_enabled (enums.ADemodCarrierPhaseCorrectionEnabled, int) –
This parameter specifies whether to correct the phase error in the carrier when demodulating phase-modulated signals.

The default value is True.

Name (Value)

Description

False (0)

Does not correct the carrier phase error.

True (1)

Corrects the carrier phase error.

Returns:

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

Return type:

int

configure_fm_de_emphasis(selector_string, de_emphasis)[source]

Configures the FM de-emphasis filter for analog demodulation measurements.

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.
de_emphasis (float) – This parameter specifies the time constant, in seconds, of the de-emphasis filter, which compensates for the pre-emphasis filter in the FM transmitter.

Returns:

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

Return type:

int

configure_measurement_interval(selector_string, measurement_interval)[source]

Configures the measurement interval for analog demodulation measurements.

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.
measurement_interval (float) – This parameter specifies the signal acquisition time, in seconds, for the analog demodulation measurement.

Returns:

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

Return type:

int

configure_modulation_type(selector_string, modulation_type)[source]

Configures the modulation type for analog demodulation measurements.

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.

modulation_type (enums.ADemodModulationType, int) –

This parameter specifies the analog modulation type of the signal that needs to be analyzed.

The default value is AM.

Name (Value)	Description
AM (0)	The signal to be analyzed is amplitude modulated.
FM (1)	The signal to be analyzed is frequency modulated.
PM (2)	The signal to be analyzed is phase modulated.

Returns:

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

Return type:

int

configure_rbw_filter(selector_string, rbw, rbw_filter_type, rbw_rrc_alpha)[source]

Configures the resolution bandwidth (RBW) filter for analog demodulation measurements.

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.
rbw (float) – This parameter specifies the bandwidth, in Hz, of the resolution bandwidth (RBW) filter to be applied to the acquired signal.

rbw_filter_type (enums.ADemodRbwFilterType, int) –

This parameter specifies the shape of the digital RBW filter.

Name (Value)	Description
None (0)	RBW filter is not applied on the acquired signal.
Gaussian (1)	RBW filter has a Gaussian response.
Flat (2)	RBW filter has a Flat response.
Synch Tuned - 4 (3)	RBW filter has a response of a 4-pole synchronously-tuned filter.
Synch Tuned - 5 (4)	RBW filter has a response of a 5-pole synchronously-tuned filter.
RRC (5)	RRC filter with roll-off specified by the ADemod RBW RRC Alpha attribute is used as the RBW filter.

rbw_rrc_alpha (float) – This parameter specifies the roll-off factor of the root-raised cosine (RRC) filter.

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 analog demodulation 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 analog demodulation 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_am_carrier_suppressed(selector_string)[source]

Gets whether the carrier of the AM (amplitude modulated) signal is absent.

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

The default value is False.

Name (Value)	Description
False (0)	The carrier of the AM signal is present.
True (1)	The carrier of the AM signal is absent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodAMCarrierSuppressedEnabled):: Specifies whether the carrier of the AM (amplitude modulated) signal is absent.
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_audio_filter_lower_cutoff_frequency(selector_string)[source]

Gets the lower cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute to Custom. 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.

The default value is 100.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the lower cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute to Custom. 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_audio_filter_type(selector_string)[source]

Gets the audio filter to be applied on the analog demodulated signal.

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

Name (Value)	Description
None (0)	Does not use any audio filter.
Custom (1)	Uses the filter specified by the Ademod Audio Filter Lower Cutoff attribute and the Ademod Audio Filter Upper Cutoff attribute.
A - Weight (2)	Uses an A-weighted filter.
B - Weight (3)	Uses a B-weighted filter.
C - Weight (4)	Uses a C-weighted filter.
CCITT (5)	Uses the filter specified by CCITT.
ITU-R 468-4 (6)	Uses the filter specified by ITU-R 468-4.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodAudioFilterType):: Specifies the audio filter to be applied on the analog 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 (attr_val, error_code)

get_audio_filter_upper_cutoff_frequency(selector_string)[source]

Gets the upper cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute to Custom. 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.

The default value is 10,000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the upper cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute to Custom. 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_audio_measurement_enabled(selector_string)[source]

Gets whether to enable the audio signal measurements, such as SINAD, SNR, THD and THD+Noise.

The default value is True.

Name (Value)	Description
False (0)	Disables the audio measurements.
True (1)	Enables the audio measurements.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodAudioMeasurementEnabled):: Specifies whether to enable the audio signal measurements, such as SINAD, SNR, THD and THD+Noise.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the ADEMOD_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of acquisitions used for averaging when you set the ADEMOD_AVERAGING_ENABLED attribute to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the analog demodulation measurement.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The analog demodulation measurement uses the ADemod Averaging Count attribute to calculate the number of acquisitions over which the measurement is averaged. Traces are not averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodAveragingEnabled):: Specifies whether to enable averaging for the analog demodulation measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_type(selector_string)[source]

Gets the averaging type for the 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 Linear.

Name (Value)	Description
Linear (0)	The averaged result is the mean value measured across multiple acquisitions.
Max (1)	The averaged result is the maximum value measured across multiple acquisitions.
Min (2)	The averaged result is the minimum value measured across multiple acquisitions.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodAveragingType):: Specifies the averaging type for the 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_carrier_correction_frequency_enabled(selector_string)[source]

Gets whether to correct the frequency error in the carrier when demodulating frequency-modulated (FM) or phase-modulated (PM) signals.

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

Name (Value)	Description
False (0)	Does not correct the carrier frequency error.
True (1)	Corrects the carrier frequency error.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodCarrierFrequencyCorrectionEnabled):: Specifies whether to correct the frequency error in the carrier when demodulating frequency-modulated (FM) or phase-modulated (PM) signals.
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_carrier_correction_phase_enabled(selector_string)[source]

Gets whether to correct the carrier phase error when demodulating phase-modulated signals.

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

Name (Value)	Description
False (0)	Does not correct the carrier phase error.
True (1)	Corrects the carrier phase error.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodCarrierPhaseCorrectionEnabled):: Specifies whether to correct the carrier phase error when demodulating phase-modulated signals.
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_de_emphasis(selector_string)[source]

Gets the time constant of de-emphasis filter, which compensates for the pre-emphasis filter in the FM transmitter. This value is expressed in seconds.

The lowpass characteristic transfer function of the de-emphasis filter is as shown in the following equation:

H*(*f) = 1/(1+*j*(2*pi**f**τ)

where τ is the de-emphasis filter time constant. This value is expressed in seconds.

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

The default value is 0 seconds. No filter is applied on the demodulated signal when de-emphasis is set to 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the time constant of de-emphasis filter, which compensates for the pre-emphasis filter in the FM transmitter. This value is expressed 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 (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable analog demodulation 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 FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Specifies whether to enable analog demodulation 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_measurement_interval(selector_string)[source]

Gets the signal acquisition time for the analog demodulation measurement. This value is expressed in seconds.

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

The default value is 10 ms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the signal acquisition time for the analog demodulation measurement. This value is expressed 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 (attr_val, error_code)

get_modulation_type(selector_string)[source]

Gets the analog modulation type of the signal that needs to be analyzed.

The default value is AM.

Name (Value)	Description
AM (0)	The signal to be analyzed is amplitude modulated.
FM (1)	The signal to be analyzed is frequency modulated.
PM (2)	The signal to be analyzed is phase modulated.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodModulationType):: Specifies the analog modulation type of the signal that needs to be analyzed.
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_filter_alpha(selector_string)[source]

Gets the roll-off factor of the root-raised cosine (RRC) filter.

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the roll-off factor of the root-raised cosine (RRC) filter.
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_filter_bandwidth(selector_string)[source]

Gets the bandwidth of the resolution bandwidth (RBW) filter to be applied to the acquired 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.

The default value is 100 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the bandwidth of the resolution bandwidth (RBW) filter to be applied to the acquired 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_rbw_filter_type(selector_string)[source]

Gets the shape of the digital RBW filter.

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

The default value is Flat.

Name (Value)	Description
None (0)	RBW filter is not applied on the acquired signal.
Gaussian (1)	RBW filter has a Gaussian response.
Flat (2)	RBW filter has a Flat response.
Synch Tuned - 4 (3)	RBW filter has a response of a 4-pole synchronously-tuned filter.
Synch Tuned - 5 (4)	RBW filter has a response of a 5-pole synchronously-tuned filter.
RRC (5)	RRC filter with roll-off specified by the ADemod RBW RRC Alpha attribute is used as the RBW filter.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ADemodRbwFilterType):: Specifies the shape of the digital RBW filter.
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 analog demodulation 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 analog demodulation measurement.

Returns:

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

Return type:

int

set_am_carrier_suppressed(selector_string, value)[source]

Sets whether the carrier of the AM (amplitude modulated) signal is absent.

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

The default value is False.

Name (Value)	Description
False (0)	The carrier of the AM signal is present.
True (1)	The carrier of the AM signal is absent.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodAMCarrierSuppressedEnabled, int) – Specifies whether the carrier of the AM (amplitude modulated) signal is absent.

Returns:

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

Return type:

int

set_audio_filter_lower_cutoff_frequency(selector_string, value)[source]

Sets the lower cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute to Custom. 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.

The default value is 100.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the lower cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute 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

set_audio_filter_type(selector_string, value)[source]

Sets the audio filter to be applied on the analog demodulated signal.

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

Name (Value)	Description
None (0)	Does not use any audio filter.
Custom (1)	Uses the filter specified by the Ademod Audio Filter Lower Cutoff attribute and the Ademod Audio Filter Upper Cutoff attribute.
A - Weight (2)	Uses an A-weighted filter.
B - Weight (3)	Uses a B-weighted filter.
C - Weight (4)	Uses a C-weighted filter.
CCITT (5)	Uses the filter specified by CCITT.
ITU-R 468-4 (6)	Uses the filter specified by ITU-R 468-4.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodAudioFilterType, int) – Specifies the audio filter to be applied on the analog demodulated signal.

Returns:

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

Return type:

int

set_audio_filter_upper_cutoff_frequency(selector_string, value)[source]

Sets the upper cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute to Custom. 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.

The default value is 10,000.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the upper cutoff frequency of the custom audio filter. This attribute is applicable only when you set the ADEMOD_AUDIO_FILTER_TYPE attribute 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

set_audio_measurement_enabled(selector_string, value)[source]

Sets whether to enable the audio signal measurements, such as SINAD, SNR, THD and THD+Noise.

The default value is True.

Name (Value)	Description
False (0)	Disables the audio measurements.
True (1)	Enables the audio measurements.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodAudioMeasurementEnabled, int) – Specifies whether to enable the audio signal measurements, such as SINAD, SNR, THD and THD+Noise.

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the ADEMOD_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of acquisitions used for averaging when you set the ADEMOD_AVERAGING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the analog demodulation measurement.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The analog demodulation measurement uses the ADemod Averaging Count attribute to calculate the number of acquisitions over which the measurement is averaged. Traces are not averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodAveragingEnabled, int) – Specifies whether to enable averaging for the analog demodulation measurement.

Returns:

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

Return type:

int

set_averaging_type(selector_string, value)[source]

Sets the averaging type for the 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 Linear.

Name (Value)	Description
Linear (0)	The averaged result is the mean value measured across multiple acquisitions.
Max (1)	The averaged result is the maximum value measured across multiple acquisitions.
Min (2)	The averaged result is the minimum value measured across multiple acquisitions.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodAveragingType, int) – Specifies the averaging type for the measurement.

Returns:

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

Return type:

int

set_carrier_correction_frequency_enabled(selector_string, value)[source]

Sets whether to correct the frequency error in the carrier when demodulating frequency-modulated (FM) or phase-modulated (PM) signals.

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

Name (Value)	Description
False (0)	Does not correct the carrier frequency error.
True (1)	Corrects the carrier frequency error.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodCarrierFrequencyCorrectionEnabled, int) – Specifies whether to correct the frequency error in the carrier when demodulating frequency-modulated (FM) or phase-modulated (PM) signals.

Returns:

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

Return type:

int

set_carrier_correction_phase_enabled(selector_string, value)[source]

Sets whether to correct the carrier phase error when demodulating phase-modulated signals.

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

Name (Value)	Description
False (0)	Does not correct the carrier phase error.
True (1)	Corrects the carrier phase error.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodCarrierPhaseCorrectionEnabled, int) – Specifies whether to correct the carrier phase error when demodulating phase-modulated signals.

Returns:

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

Return type:

int

set_fm_de_emphasis(selector_string, value)[source]

Sets the time constant of de-emphasis filter, which compensates for the pre-emphasis filter in the FM transmitter. This value is expressed in seconds.

The lowpass characteristic transfer function of the de-emphasis filter is as shown in the following equation:

H*(*f) = 1/(1+*j*(2*pi**f**τ)

where τ is the de-emphasis filter time constant. This value is expressed in seconds.

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

The default value is 0 seconds. No filter is applied on the demodulated signal when de-emphasis is set to 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the time constant of de-emphasis filter, which compensates for the pre-emphasis filter in the FM transmitter. This value is expressed in seconds.

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 analog demodulation 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 FALSE.

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Specifies whether to enable analog demodulation measurements.

Returns:

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

Return type:

int

set_measurement_interval(selector_string, value)[source]

Sets the signal acquisition time for the analog demodulation measurement. This value is expressed in seconds.

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

The default value is 10 ms.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the signal acquisition time for the analog demodulation measurement. This value is expressed in seconds.

Returns:

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

Return type:

int

set_modulation_type(selector_string, value)[source]

Sets the analog modulation type of the signal that needs to be analyzed.

The default value is AM.

Name (Value)	Description
AM (0)	The signal to be analyzed is amplitude modulated.
FM (1)	The signal to be analyzed is frequency modulated.
PM (2)	The signal to be analyzed is phase modulated.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodModulationType, int) – Specifies the analog modulation type of the signal that needs to be analyzed.

Returns:

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

Return type:

int

set_rbw_filter_alpha(selector_string, value)[source]

Sets the roll-off factor of the root-raised cosine (RRC) filter.

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the roll-off factor of the root-raised cosine (RRC) filter.

Returns:

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

Return type:

int

set_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the resolution bandwidth (RBW) filter to be applied to the acquired 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.

The default value is 100 kHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter to be applied to the acquired signal. This value is expressed in Hz.

Returns:

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

Return type:

int

set_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital RBW filter.

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

The default value is Flat.

Name (Value)	Description
None (0)	RBW filter is not applied on the acquired signal.
Gaussian (1)	RBW filter has a Gaussian response.
Flat (2)	RBW filter has a Flat response.
Synch Tuned - 4 (3)	RBW filter has a response of a 4-pole synchronously-tuned filter.
Synch Tuned - 5 (4)	RBW filter has a response of a 5-pole synchronously-tuned filter.
RRC (5)	RRC filter with roll-off specified by the ADemod RBW RRC Alpha attribute is used as the RBW filter.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ADemodRbwFilterType, int) – Specifies the shape of the digital RBW filter.

Returns:

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

Return type:

int