DDemodConfiguration

Provides methods to configure the DDemod measurement.

class nirfmxdemod.digital_demod_configuration.DDemodConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the DDemod measurement.

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

Configures averaging for digital 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.DDemodAveragingEnabled, int) –

This parameter enables averaging for digital 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.

Returns:

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

Return type:

int

configure_equalizer(selector_string, equalizer_mode, equalizer_filter_length, x0, dx, equalizer_initial_coefficients, equalizer_training_count, equalizer_convergence_factor)[source]

Configures the equalizer.

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.

equalizer_mode (enums.DDemodEqualizerMode, int) –

This parameter specifies whether the measurement needs to perform equalization.

The default value is Off.

Name (Value)	Description
Off (0)	Equalization is not performed.
Train (1)	The adaptive feedforward equalizer is turned ON to compensate for the effect of the channel. You can set the initial coefficients to be used by the equalizer. If you do not specify the initial coefficients, an impulse is used.
Hold (2)	The filter that you specify using the initial coefficients is used as the channel filter and is applied before demodulating the acquired signal.

equalizer_filter_length (int) – This parameter specifies the length of the equalization filter to be computed. The length is specified in terms of symbols. This parameter is ignored when the equalizer initial coefficients are specified.
x0 (float) – This parameter always pass 0 to this parameter. Any other values are ignored.
dx (float) – This parameter specifies the spacing between the coefficients as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.
equalizer_initial_coefficients (numpy.complex64) – This parameter specifies the initial coefficients to be used by the equalizer.
equalizer_training_count (int) – This parameter specifies the number of iterations during which the equalizer adapts its coefficients in the training stage.
equalizer_convergence_factor (float) –
This parameter specifies the incremental step used to adapt the equalizer to the channel during the training stage.

The default value is 0.0001.

Returns:

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

Return type:

int

configure_equalizer_initial_coefficients(selector_string, x0, dx, equalizer_initial_coefficients)[source]

Configures the equalizer coefficients.

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.
x0 (float) – This parameter always pass 0 to this parameter. Any other values are ignored.
dx (float) – This parameter specifies the spacing between the coefficients as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.
equalizer_initial_coefficients (numpy.complex64) – This parameter specifies the initial coefficients to be used by the equalizer.

Returns:

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

Return type:

int

configure_evm_normalization_reference(selector_string, evm_normalization_reference)[source]

Configures the error vector magnitude (EVM) normalization reference.

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.

evm_normalization_reference (enums.DDemodEvmNormalizationReference, int) –

This parameter specifies the reference used to normalize the EVM.

Name (Value)	Description
Peak (0)	The EVM is normalized to the peak magnitude of the reference symbols.
RMS (1)	The EVM is normalized to the RMS magnitude of the reference symbols. This value is applicable only to modulation types, such as quadrature-amplitude modulation (QAM). This value is expressed in which the symbols in the map do not have a constant amplitude.

Returns:

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

Return type:

int

configure_fsk_deviation(selector_string, fsk_deviation, fsk_ref_comp_enabled)[source]

Configures the expected FSK deviation.

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.
fsk_deviation (float) – This parameter specifies the expected FSK frequency deviation, in Hz.
fsk_ref_comp_enabled (enums.DDemodFskReferenceCompensationEnabled, int) –
This parameter specifies whether the FSK deviation that you specify is used to compensate for gain errors and to compute the FSK error.

Default value is False.

Name (Value)

Description

False (0)

Does not compensate for gain errors.

True (1)

Compensates for gain errors.

Returns:

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

Return type:

int

configure_m(selector_string, m)[source]

Configures the M-ary number.

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.

m (enums.DDemodM, int) –

This parameter specifies the M-ary number, which is the number of distinct states that represent symbols in the complex baseband modulated waveform.

Recommended values of M for modulation types are as follows: - ASK: 2, 4, 8

FSK , PSK: 2, 4, 8, 16
QAM: 16, 32, 64, 128, 256, 512, 1028, 2048, 4096.

The default value is 4.

Name (Value)	Description
2 (2)	The M-ary number is 2.
4 (4)	The M-ary number is 4.
8 (8)	The M-ary number is 8.
16 (16)	The M-ary number is 16.
32 (32)	The M-ary number is 32.
64 (64)	The M-ary number is 64.
128 (128)	The M-ary number is 128.
256 (256)	The M-ary number is 256.
512 (512)	The M-ary number is 512.
1024 (1024)	The M-ary number is 1,024.
2048 (2048)	The M-ary number is 2,048.
4096 (4096)	The M-ary number is 4,096.

Returns:

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

Return type:

int

configure_measurement_filter(selector_string, measurement_filter_type, x0, dx, measurement_filter_custom_coefficients)[source]

Configures the measurement filter.

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_filter_type (enums.DDemodMeasurementFilterType, int) –

This parameter specifies whether the measurement needs to compute the measurement filter based on the pulse shaping filter type or uses the custom measurement filter coefficients.

The default value is Auto.

Name (Value)	Description
Auto (0)	The signal analyzer computes the measurement filter coefficients based on the pulse-shaping filter information that you specify in the Pulse Shaping Filter Type parameter of the RFmxDemod DDemod Configure Pulse Shaping Filter method. If the Pulse Shaping Filter Type parameter is set to Custom, the signal analyzer enables equalization.
Custom (1)	The signal analyzer uses the coefficients specified by RFmxDemod DDemod Configure Measurement Filter Custom Coefficients method.

x0 (float) – This parameter always pass 0 to this parameter. Any other values are ignored.
dx (float) – This parameter specifies the spacing between the coefficients as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.
measurement_filter_custom_coefficients (numpy.float32) – This parameter specifies the filter coefficients to be used by demodulator.

Returns:

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

Return type:

int

configure_measurement_filter_custom_coefficients(selector_string, x0, dx, measurement_filter_custom_coefficients)[source]

Configures the measurement filter custom coefficients.

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.
x0 (float) – This parameter specifies the filter coefficients to be used by demodulator.
dx (float) – This parameter specifies the spacing between the coefficients as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.
measurement_filter_custom_coefficients (float) – This parameter specifies the filter coefficients to be used by demodulator.

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, m, differential_enabled)[source]

Configures the modulation type of the signal to be analyzed.

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.DDemodModulationType, int) –

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

The default value is PSK.

Name (Value)	Description
ASK (0)	The modulation type is amplitude-shift keying (ASK).
FSK (1)	The modulation type is frequency-shift keying (FSK).
PSK (2)	The modulation type is phase-shift keying (PSK).
QAM (3)	The modulation type is quadrature-amplitude modulation (QAM).
MSK (4)	The modulation type is minimum shift keying (MSK).

m (enums.DDemodM, int) –

This parameter specifies the M-ary number, which is the number of distinct states that represent symbols in the complex baseband modulated waveform.

Recommended values of M for modulation types are as follows: - ASK: 2, 4, 8

FSK , PSK: 2, 4, 8, 16
QAM: 16, 32, 64, 128, 256, 512, 1028, 2048, 4096.

The default value is 4.

Name (Value)	Description
2 (2)	The M-ary number is 2.
4 (4)	The M-ary number is 4.
8 (8)	The M-ary number is 8.
16 (16)	The M-ary number is 16.
32 (32)	The M-ary number is 32.
64 (64)	The M-ary number is 64.
128 (128)	The M-ary number is 128.
256 (256)	The M-ary number is 256.
512 (512)	The M-ary number is 512.
1024 (1024)	The M-ary number is 1,024.
2048 (2048)	The M-ary number is 2,048.
4096 (4096)	The M-ary number is 4,096.

differential_enabled (enums.DDemodDifferentialEnabled, int) –

This parameter specifies whether the symbols are differentially encoded. This attribute is applicable only to PSK and MSK modulation types.

The default value is False.

Name (Value)	Description
False (0)	The symbols are directly mapped onto the symbol map.
True (1)	In case of PSK modulation, the transition between two consecutive symbols is mapped onto the symbol map. In case of MSK modulation, the consecutive bits are XORed. Other modulation types do not have any impact.

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

Configures the number of symbols to be measured.

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.
number_of_symbols (int) – This parameter specifies the number of symbols to be analyzed. The measurement acquires additional symbols to account for filter delays.

Returns:

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

Return type:

int

configure_psk_format(selector_string, psk_format)[source]

Configures the PSK format.

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.

psk_format (enums.DDemodPskFormat, int) –

This parameter specifies the PSK format.

The default value is Normal.

Name (Value)	Description
Normal (0)	Sets the modulation type to PSK.
Offset QPSK (1)	Sets the modulation type to offset quadrature PSK (OQPSK). The ideal symbol timing of Q is offset by half of a symbol period from the ideal symbol timing of I.
PI/4 - QPSK (2)	Sets the modulation type to pi/4 QPSK. In this modulation, each QPSK symbol is rotated by pi/4.
PI/8 - 8PSK (3)	Sets the modulation type to pi/8 8PSK. In this modulation, each 8PSK symbol is rotated by pi/8.
3*PI/8 - 8PSK (4)	Sets the modulation type to 3pi/8-8 PSK. In this modulation, each 8 PSK symbol is rotated by 3pi/8.

Returns:

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

Return type:

int

configure_pulse_shaping_filter(selector_string, pulse_shaping_filter_type, pulse_shaping_filter_parameter, x0, dx, pulse_shaping_filter_custom_coefficients)[source]

Configures the pulse-shaping filter.

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.

pulse_shaping_filter_type (enums.DDemodPulseShapingFilterType, int) –

This parameter specifies the pulse-shaping filter used to transmit the signal and determines the measurement filter to be used for analysis when the DDEMOD_MEASUREMENT_FILTER_TYPE attribute is set to Auto.

Name (Value)	Description
Rectangular (0)	The transmitted waveform is filtered using a rectangular filter.
Raised Cosine (1)	The transmitted waveform is filtered using a raised cosine filter. Specify the filter Alpha in the DDemod Pulse Shaping Filter Parameter attribute.
Root Raised Cosine (2)	The transmitted waveform is filtered using a root raised cosine filter. Specify the filter Alpha in the DDemod Pulse Shaping Filter Parameter attribute.
Gaussian (3)	The transmitted waveform is filtered using a Gaussian filter. Specify the filter bandwidth * sample duration in the DDemod Pulse Shaping Filter Parameter attribute. This filter is applicable only to FSK and MSK modulation types.
Custom (4)	The transmitted waveform is filtered using the coefficients that you specify in the RFmxDemod DDemod Configure Pulse Shaping Filter Custom Coefficients method.
Half Sine (5)	The transmitted waveform is filtered using a half sine filter.
Linearised GMSK - EDGE (6)	The transmitted waveform is filtered using an EDGE-specific linearized GMSK filter.

pulse_shaping_filter_parameter (float) – This parameter specifies the rolloff factor for the raised cosine and root-raised cosine filters that are used as pulse shaping filter, and measurement filter respectively. When pulse-shaping filter type is Gaussian, this attribute specifies bandwidth * sample duration (BT).
x0 (float) – This parameter always pass 0 to this parameter. Any other values are ignored.
dx (float) – This parameter specifies the spacing between the coefficients as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.
pulse_shaping_filter_custom_coefficients (numpy.float32) – This parameter specifies the filter coefficients used as the pulse shaping filter on the transmitter.

Returns:

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

Return type:

int

configure_pulse_shaping_filter_custom_coefficients(selector_string, x0, dx, pulse_shaping_filter_custom_coefficients)[source]

Configures the pulse-shaping filter coefficients.

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.
x0 (float) – This parameter specifies the filter coefficients used as the pulse shaping filter on the transmitter.
dx (float) – This parameter specifies the spacing between the coefficients as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.
pulse_shaping_filter_custom_coefficients (float) – This parameter specifies the filter coefficients used as the pulse shaping filter on the transmitter.

Returns:

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

Return type:

int

configure_samples_per_symbol(selector_string, samples_per_symbol)[source]

Configures the samples per symbol to be used to acquire the signal for the measurement.

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.

samples_per_symbol (int) –

This parameter specifies the samples per symbol used to acquire the signal for the measurement.

Name (Value)	Description
Auto (-1)	The measurement uses appropriate samples per symbol (SPS) based on modulation type and pulse shaping filter.SPS=8, for FSK.SPS=4, for ASK,PSK, QAM, MSK when pulse shape filter is not rectangular.SPS=8, for ASK, PSK, QAM, MSK when pulse shape filter is rectangular.
4 (4)	The samples per symbol value is 4.
8 (8)	The samples per symbol value is 8.
16 (16)	The samples per symbol value is 16.

Returns:

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

Return type:

int

configure_signal_structure(selector_string, signal_structure)[source]

Configures the structure of the incoming signal to be either a continuous signal or a bursty signal.

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.
signal_structure (enums.DDemodSignalStructure, int) –
This parameter specifies whether the signal is either a bursty signal or a continuous signal.

The default value is Continuous.

Name (Value)

Description

Bursted (0)

The signal is a bursty signal.

Continuous (1)

The signal is a continuous signal.

Returns:

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

Return type:

int

configure_spectrum_inverted(selector_string, spectrum_inverted)[source]

Configures swapping of I and Q channels in the acquired waveform before demodulation.

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.
spectrum_inverted (enums.DDemodSpectrumInverted, int) –
This parameter specifies whether to swap the acquired I and Q samples for demodulation.

The default value is False.

Name (Value)

Description

False (0)

The acquired I and Q samples are used for demodulation as is.

True (1)

The acquired I and Q samples are swapped before using the signal for demodulation.

Returns:

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

Return type:

int

configure_symbol_map(selector_string, symbol_map_type, symbol_map)[source]

Configures the symbol map that you use during 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.
symbol_map_type (enums.DDemodSymbolMapType, int) –
This parameter specifies whether the measurement uses the default symbol map or the map that you configure using the RFmxDemod DDemod Configure Symbol Map method.

Name (Value)

Description

Auto (0)

Uses a default symbol map.

Custom (1)

Uses the map that you specify.
symbol_map (numpy.complex64) – This parameter specifies the custom symbol map.

Returns:

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

Return type:

int

configure_symbol_rate(selector_string, symbol_rate)[source]

Configures the symbol rate for digital 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.
symbol_rate (float) –
This parameter specifies the symbol rate in Hz.

The default value is 100 kHz.

Returns:

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

Return type:

int

configure_synchronization(selector_string, synchronization_enabled, sync_bits, measurement_offset)[source]

Configures bit pattern synchronization.

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.
synchronization_enabled (enums.DDemodSynchronizationEnabled, int) –
This parameter specifies whether the demodulator needs to search and synchronize the signal to a known reference sequence. The reference sequence is the symbol representation of a defined set of bits known to be present in the transmitted signal. If the synchronization is found in the demodulated signal, the measurement is performed from this point onward. If the synchronization is not found, the entire signal is used for the measurement.

Name (Value)

Description

False (0)

Does not search and synchronize the signal.

True (1)

Searches and synchronizes the signal.
sync_bits (numpy.int8) – This parameter specifies the synchronization bits used to create the reference sequence that needs to be searched in the demodulated signal.
measurement_offset (int) – This parameter specifies the offset, which is the location from which the signal is considered for further measurements.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the digital demodulation.

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 digital demodulation.
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_apsk_r2_to_r1_ratio(selector_string)[source]

Gets the ratio of the magnitude of symbols on a ring(R2) to the magnitude of symbols on the inner ring(R1). It is applicable for both 16-APSK and 32-APSK.

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.84. Valid values are from 2 to 8, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the ratio of the magnitude of symbols on a ring(R2) to the magnitude of symbols on the inner ring(R1). It is applicable for both 16-APSK and 32-APSK.
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_apsk_r3_to_r1_ratio(selector_string)[source]

Gets the ratio of the magnitude of symbols on a ring(R3) to the magnitude of symbols on the inner ring(R1). It is applicable for 32-APSK.

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 5.27. Valid values are from 3 to 12, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the ratio of the magnitude of symbols on a ring(R3) to the magnitude of symbols on the inner ring(R1). It is applicable for 32-APSK.
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 DDEMOD_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 DDEMOD_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]

Enables averaging for digital 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.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodAveragingEnabled):: Enables averaging for digital 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_burst_end_exclusion_symbols(selector_string)[source]

Gets the number of symbols that is excluded from the measurement before the falling edge of the burst.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of symbols that is excluded from the measurement before the falling edge of the burst.
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_burst_start_exclusion_symbols(selector_string)[source]

Gets the number of symbols from the start of the burst trigger that is excluded from 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 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of symbols from the start of the burst trigger that is excluded from 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_cfo_estimation_mode(selector_string)[source]

Gets the carrier frequency offset estimation capability of the demodulator. If you select Narrow, coarse carrier frequency offset estimation is disabled and only fine carrier frequency offset estimation is performed. This is useful when analysing low SNR signals.

Name (Value)	Description
Narrow (0)	The measurement disables coarse carrier frequency offset estimation.
Wide (1)	The measurement enables coarse and fine carrier frequency offset estimation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodCfoEstimationMode):: Specifies the carrier frequency offset estimation capability of the demodulator. If you select Narrow, coarse carrier frequency offset estimation is disabled and only fine carrier frequency offset estimation is performed. This is useful when analysing low SNR 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_differential_enabled(selector_string)[source]

Gets whether the symbols are differentially encoded. This attribute is applicable only to PSK and MSK modulation types.

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 symbols are directly mapped onto the symbol map.
True (1)	In case of PSK modulation, the transition between two consecutive symbols is mapped onto the symbol map. In case of MSK modulation, the consecutive bits are XORed. Other modulation types do not have any impact.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodDifferentialEnabled):: Specifies whether the symbols are differentially encoded. This attribute is applicable only to PSK and MSK modulation types.
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_equalizer_convergence_factor(selector_string)[source]

Gets the incremental step used by the equalizer to adapt to the channel during the training stage.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the incremental step used by the equalizer to adapt to the channel during the training stage.
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_equalizer_filter_length(selector_string)[source]

Gets the length of the equalization filter to be computed. The length is specified in terms of symbols.

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

The default value is 20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the length of the equalization filter to be computed. The length is specified in terms of symbols.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_equalizer_initial_coefficients(selector_string, equalizer_initial_coefficients)[source]

Gets the initial equalizer coefficients used by the digital demodulation measurement.

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.
equalizer_initial_coefficients (numpy.complex64) – This parameter returns the filter coefficients used as the equalizer initial coefficients.

Returns:

x0 (float):: This parameter this parameter always returns 0.
dx (float):: This parameter returns the spacing between the coefficients as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.
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)

get_equalizer_mode(selector_string)[source]

Gets whether the measurement needs to perform equalization.

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

Name (Value)	Description
Off (0)	Equalization is not performed.
Train (1)	The adaptive feedforward equalizer is turned ON to compensate for the effect of the channel. You can set the initial coefficients to be used by the equalizer. If you do not specify the initial coefficients, an impulse is used.
Hold (2)	The filter that you specify using the RFmxDemod DDemod Configure Equalizer Initial Coefficients method is used as the channel filter, and it is applied before demodulating the acquired signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodEqualizerMode):: Specifies whether the measurement needs to perform equalization.
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_equalizer_training_count(selector_string)[source]

Gets the number of iterations during which the equalizer adapts its coefficients in the training stage. After the training stage, the measurement is performed over the specified number of averages.

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 iterations during which the equalizer adapts its coefficients in the training stage. After the training stage, the measurement is performed over the specified number of averages.
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_evm_normalization_reference(selector_string)[source]

Gets the reference used to normalize the error vector magnitude (EVM).

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

Name (Value)	Description
Peak (0)	The EVM is normalized to the peak magnitude of the reference symbols.
RMS (1)	The EVM is normalized to the RMS magnitude of the reference symbols. This value is applicable only to modulation types, such as quadrature-amplitude modulation (QAM). This value is expressed in which the symbols in the map do not have a constant amplitude.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodEvmNormalizationReference):: Specifies the reference used to normalize the error vector magnitude (EVM).
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_fsk_deviation(selector_string)[source]

Gets the expected FSK frequency deviation At baseband frequencies, deviations for individual symbols are evenly spaced in the interval [-fd, fd], where fd represents the frequency deviation. 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 15 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the expected FSK frequency deviation At baseband frequencies, deviations for individual symbols are evenly spaced in the interval [-fd, fd], where fd represents the frequency deviation. 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_fsk_reference_compensation_enabled(selector_string)[source]

Gets whether the FSK deviation that you specify is used to compensate for gain errors and compute FSK error.

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)	Does not compensate for gain errors.
True (1)	Compensates for gain errors.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodFskReferenceCompensationEnabled):: Specifies whether the FSK deviation that you specify is used to compensate for gain errors and compute FSK error.
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_iq_offset_removal_enabled(selector_string)[source]

Gets whether to remove the I/Q offset before the EVM 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 True.

Name (Value)	Description
False (0)	The IQ offset is not removed before the EVM measurement.
True (1)	The IQ offset is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodIQOffsetRemovalEnabled):: Specifies whether to remove the I/Q offset before the EVM 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_m(selector_string)[source]

Gets the M-ary number, which is the number of distinct states that represent symbols in the complex baseband modulated waveform.

The M-ary number is calculated using the following formula:

M = 2^{^}(bits per symbol)

Recommended values of M for the modulation types are as follows:

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

Name (Value)	Description
2 (2)	The M-ary number is 2.
4 (4)	The M-ary number is 4.
8 (8)	The M-ary number is 8.
16 (16)	The M-ary number is 16.
32 (32)	The M-ary number is 32.
64 (64)	The M-ary number is 64.
128 (128)	The M-ary number is 128.
256 (256)	The M-ary number is 256.
512 (512)	The M-ary number is 512.
1024 (1024)	The M-ary number is 1,024.
2048 (2048)	The M-ary number is 2,048.
4096 (4096)	The M-ary number is 4,096.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodM):: Specifies the M-ary number, which is the number of distinct states that represent symbols in the complex baseband modulated waveform.
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]

Enables digital 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):: Enables digital 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_filter_type(selector_string)[source]

Gets whether the measurement needs to compute the measurement filter based on the pulse-shaping filter type or uses the custom measurement filter coefficients.

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
Auto (0)	The signal analyzer computes the measurement filter coefficients based on the pulse-shaping filter information that you specify in the DDemod Pulse Shaping Filter Type attribute. If the DDemod Pulse Shaping Filter Type attribute is set to Custom, the signal analyzer enables equalization.
Custom (1)	The signal analyzer uses the coefficients specified by RFmxDemod DDemod Configure Measurement Filter Custom Coefficients method.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodMeasurementFilterType):: Specifies whether the measurement needs to compute the measurement filter based on the pulse-shaping filter type or uses the custom measurement filter coefficients.
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 digital modulation type of the signal that needs to be analyzed.

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

Name (Value)	Description
ASK (0)	The modulation type is amplitude-shift keying (ASK).
FSK (1)	The modulation type is frequency-shift keying (FSK).
PSK (2)	The modulation type is phase-shift keying (PSK).
QAM (3)	The modulation type is quadrature-amplitude modulation (QAM).
MSK (4)	The modulation type is minimum shift keying (MSK).
APSK (5)	The modulation type is amplitude phase-shift keying (APSK).

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodModulationType):: Specifies the digital 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_number_of_symbols(selector_string)[source]

Gets the number of symbols to be analyzed. The measurement acquires additional symbols to account for filter delays.

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,000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of symbols to be analyzed. The measurement acquires additional symbols to account for filter delays.
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_psk_format(selector_string)[source]

Gets the PSK format.

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

Name (Value)	Description
Normal (0)	Sets the modulation type to PSK.
Offset QPSK (1)	Sets the modulation type to offset quadrature PSK (OQPSK). The ideal symbol timing of Q is offset by half of a symbol period from the ideal symbol timing of I.
PI/4 - QPSK (2)	Sets the modulation type to pi/4 QPSK. In this modulation, each QPSK symbol is rotated by pi/4.
PI/8 - 8PSK (3)	Sets the modulation type to pi/8-8 PSK. In this modulation, each 8 PSK symbol is rotated by pi/8.
3*PI/8 - 8PSK (4)	Sets the modulation type to 3pi/8-8 PSK. In this modulation, each 8 PSK symbol is rotated by 3pi/8.
Shaped Offset QPSK (5)	Sets the modulation type to Shaped Offset QPSK.The ideal symbol timing of Q is offset by half of a symbol period from the ideal symbol timing of I and the waveform is shaped using frequency pulse filter.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodPskFormat):: Specifies the PSK format.
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_pulse_shaping_filter_parameter(selector_string)[source]

Gets the rolloff factor for raised cosine and root-raised cosine filter that is used as pulse-shaping filter and measurement filter respectively.

For Gaussian filter, this attribute specifies bandwidth * sample duration.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the rolloff factor for raised cosine and root-raised cosine filter that is used as pulse-shaping filter and measurement filter respectively.
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_pulse_shaping_filter_type(selector_string)[source]

Gets the pulse-shaping filter used to transmit the signal. This attribute determines the measurement filter to be used for analysis when you set the DDEMOD_MEASUREMENT_FILTER_TYPE 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 Root Raised Cosine.

Name (Value)	Description
Rectangular (0)	The transmitted waveform is filtered using a rectangular filter.
Raised Cosine (1)	The transmitted waveform is filtered using a raised cosine filter. Specify the filter Alpha in the DDemod Pulse Shaping Filter Parameter attribute.
Root Raised Cosine (2)	The transmitted waveform is filtered using a root raised cosine filter. Specify the filter Alpha in the DDemod Pulse Shaping Filter Parameter attribute.
Gaussian (3)	The transmitted waveform is filtered using a Gaussian filter. Specify the filter bandwidth * sample duration in the DDemod Pulse Shaping Filter Parameter attribute. This filter is applicable only to FSK and MSK modulation types.
Custom (4)	The transmitted waveform is filtered using the coefficients that you specify in the RFmxDemod DDemod Configure Pulse Shaping Filter Custom Coefficients method.
Half Sine (5)	The transmitted waveform is filtered using a half sine filter.
Linearized GMSK - EDGE (6)	The transmitted waveform is filtered using an EDGE-specific linearized GMSK filter.
SOQPSK - TG (7)	The transmitted waveform is filtered using a SOQPSK - TG filter as defined in IRIG standard.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodPulseShapingFilterType):: Specifies the pulse-shaping filter used to transmit the signal. This attribute determines the measurement filter to be used for analysis when you set the DDEMOD_MEASUREMENT_FILTER_TYPE 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_samples_per_symbol(selector_string)[source]

Gets the samples per symbol used to acquire the signal for the measurement.

Sample rate = Symbol rate * Samples per symbol.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the samples per symbol used to acquire the signal 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_search_length(selector_string)[source]

Gets the length of the waveform within which the synchronization bit pattern needs to be searched when you set the DDEMOD_SEARCH_LENGTH_AUTO 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 0.001 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the length of the waveform within which the synchronization bit pattern needs to be searched when you set the DDEMOD_SEARCH_LENGTH_AUTO 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_search_length_auto(selector_string)[source]

Gets whether the measurement should search for synchronization bit pattern in the waveform of length determined by the measurement or search for length duration.

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)	Synchronization bit pattern is searched in a waveform within the search Length duration.
True (1)	Synchronization bit pattern is searched in a waveform of length determined by the measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodSearchLengthAuto):: Specifies whether the measurement should search for synchronization bit pattern in the waveform of length determined by the measurement or search for length duration.
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_signal_structure(selector_string)[source]

Gets whether the signal is either a bursty signal or a continuous 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 Continuous.

Name (Value)	Description
Bursted (0)	The signal is a bursty signal.
Continuous (1)	The signal is a continuous signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodSignalStructure):: Specifies whether the signal is either a bursty signal or a continuous 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_spectrum_inverted(selector_string)[source]

Gets whether to swap the acquired I and Q samples for demodulation.

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 acquired I and Q samples are used for demodulation as is.
True (1)	The acquired I and Q samples are swapped before using the signal for demodulation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodSpectrumInverted):: Specifies whether to swap the acquired I and Q samples for demodulation.
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_symbol_map(selector_string, symbol_map)[source]

Gets the symbol map that is used for digital demodulation measurements. Call this method after calling commit() method.

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.
symbol_map (numpy.complex64) – This parameter returns the symbol map used for demodulation.

Returns:

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

Return type:

int

get_symbol_map_type(selector_string)[source]

Gets whether the measurement uses the default symbol map or the map that you configure using the configure_symbol_map() method.

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
Auto (0)	Uses a default symbol map.
Custom (1)	Uses the map that you specify using the RFmxDemod DDemod Configure Symbol Map method .

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodSymbolMapType):: Specifies whether the measurement uses the default symbol map or the map that you configure using the configure_symbol_map() method.
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_symbol_rate(selector_string)[source]

Gets the number of symbols transmitted in one second. 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 number of symbols transmitted in one second. 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_synchronization_bits(selector_string)[source]

Gets the synchronization bits used to create the reference sequence that must be located in the demodulated signal. The synchronization bits are modulated based on the modulation type to create the reference sequence.

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 (int):: Specifies the synchronization bits used to create the reference sequence that must be located in the demodulated signal. The synchronization bits are modulated based on the modulation type to create the reference sequence.
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_synchronization_enabled(selector_string)[source]

Gets whether the demodulator needs to search and synchronize the signal to a known reference sequence. The reference sequence is the symbol representation of a defined set of bits known to be present in the transmitted signal. If the synchronization is found in the demodulated signal, the measurement is performed from this point onward. If the synchronization is not found, the entire signal is used 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 False.

Name (Value)	Description
False (0)	Does not search and synchronize the signal.
True (1)	Searches and synchronizes the signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DDemodSynchronizationEnabled):: Specifies whether the demodulator needs to search and synchronize the signal to a known reference sequence. The reference sequence is the symbol representation of a defined set of bits known to be present in the transmitted signal. If the synchronization is found in the demodulated signal, the measurement is performed from this point onward. If the synchronization is not found, the entire signal is used 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_synchronization_measurement_offset(selector_string)[source]

Gets the offset, which is the location from which the signal is considered for further measurements. The offset is specified in symbols of the reference sequence. This offset is not applicable when the synchronization bits are not found.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the offset, which is the location from which the signal is considered for further measurements. The offset is specified in symbols of the reference sequence. This offset is not applicable when the synchronization bits are not found.
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 digital demodulation.

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 digital demodulation.

Returns:

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

Return type:

int

set_apsk_r2_to_r1_ratio(selector_string, value)[source]

Sets the ratio of the magnitude of symbols on a ring(R2) to the magnitude of symbols on the inner ring(R1). It is applicable for both 16-APSK and 32-APSK.

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.84. Valid values are from 2 to 8, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the ratio of the magnitude of symbols on a ring(R2) to the magnitude of symbols on the inner ring(R1). It is applicable for both 16-APSK and 32-APSK.

Returns:

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

Return type:

int

set_apsk_r3_to_r1_ratio(selector_string, value)[source]

Sets the ratio of the magnitude of symbols on a ring(R3) to the magnitude of symbols on the inner ring(R1). It is applicable for 32-APSK.

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 5.27. Valid values are from 3 to 12, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the ratio of the magnitude of symbols on a ring(R3) to the magnitude of symbols on the inner ring(R1). It is applicable for 32-APSK.

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 DDEMOD_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 DDEMOD_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]

Enables averaging for digital 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.

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

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodAveragingEnabled, int) – Enables averaging for digital 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_burst_end_exclusion_symbols(selector_string, value)[source]

Sets the number of symbols that is excluded from the measurement before the falling edge of the burst.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of symbols that is excluded from the measurement before the falling edge of the burst.

Returns:

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

Return type:

int

set_burst_start_exclusion_symbols(selector_string, value)[source]

Sets the number of symbols from the start of the burst trigger that is excluded from 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 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of symbols from the start of the burst trigger that is excluded from 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_cfo_estimation_mode(selector_string, value)[source]

Sets the carrier frequency offset estimation capability of the demodulator. If you select Narrow, coarse carrier frequency offset estimation is disabled and only fine carrier frequency offset estimation is performed. This is useful when analysing low SNR signals.

Name (Value)	Description
Narrow (0)	The measurement disables coarse carrier frequency offset estimation.
Wide (1)	The measurement enables coarse and fine carrier frequency offset estimation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodCfoEstimationMode, int) – Specifies the carrier frequency offset estimation capability of the demodulator. If you select Narrow, coarse carrier frequency offset estimation is disabled and only fine carrier frequency offset estimation is performed. This is useful when analysing low SNR signals.

Returns:

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

Return type:

int

set_differential_enabled(selector_string, value)[source]

Sets whether the symbols are differentially encoded. This attribute is applicable only to PSK and MSK modulation types.

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 symbols are directly mapped onto the symbol map.
True (1)	In case of PSK modulation, the transition between two consecutive symbols is mapped onto the symbol map. In case of MSK modulation, the consecutive bits are XORed. Other modulation types do not have any impact.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodDifferentialEnabled, int) – Specifies whether the symbols are differentially encoded. This attribute is applicable only to PSK and MSK modulation types.

Returns:

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

Return type:

int

set_equalizer_convergence_factor(selector_string, value)[source]

Sets the incremental step used by the equalizer to adapt to the channel during the training stage.

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

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the incremental step used by the equalizer to adapt to the channel during the training stage.

Returns:

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

Return type:

int

set_equalizer_filter_length(selector_string, value)[source]

Sets the length of the equalization filter to be computed. The length is specified in terms of symbols.

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

The default value is 20.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the length of the equalization filter to be computed. The length is specified in terms of symbols.

Returns:

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

Return type:

int

set_equalizer_mode(selector_string, value)[source]

Sets whether the measurement needs to perform equalization.

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

Name (Value)	Description
Off (0)	Equalization is not performed.
Train (1)	The adaptive feedforward equalizer is turned ON to compensate for the effect of the channel. You can set the initial coefficients to be used by the equalizer. If you do not specify the initial coefficients, an impulse is used.
Hold (2)	The filter that you specify using the RFmxDemod DDemod Configure Equalizer Initial Coefficients method is used as the channel filter, and it is applied before demodulating the acquired signal.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodEqualizerMode, int) – Specifies whether the measurement needs to perform equalization.

Returns:

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

Return type:

int

set_equalizer_training_count(selector_string, value)[source]

Sets the number of iterations during which the equalizer adapts its coefficients in the training stage. After the training stage, the measurement is performed over the specified number of averages.

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 iterations during which the equalizer adapts its coefficients in the training stage. After the training stage, the measurement is performed over the specified number of averages.

Returns:

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

Return type:

int

set_evm_normalization_reference(selector_string, value)[source]

Sets the reference used to normalize the error vector magnitude (EVM).

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

Name (Value)	Description
Peak (0)	The EVM is normalized to the peak magnitude of the reference symbols.
RMS (1)	The EVM is normalized to the RMS magnitude of the reference symbols. This value is applicable only to modulation types, such as quadrature-amplitude modulation (QAM). This value is expressed in which the symbols in the map do not have a constant amplitude.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodEvmNormalizationReference, int) – Specifies the reference used to normalize the error vector magnitude (EVM).

Returns:

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

Return type:

int

set_fsk_deviation(selector_string, value)[source]

Sets the expected FSK frequency deviation At baseband frequencies, deviations for individual symbols are evenly spaced in the interval [-fd, fd], where fd represents the frequency deviation. 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 15 kHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the expected FSK frequency deviation At baseband frequencies, deviations for individual symbols are evenly spaced in the interval [-fd, fd], where fd represents the frequency deviation. 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_fsk_reference_compensation_enabled(selector_string, value)[source]

Sets whether the FSK deviation that you specify is used to compensate for gain errors and compute FSK error.

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)	Does not compensate for gain errors.
True (1)	Compensates for gain errors.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodFskReferenceCompensationEnabled, int) – Specifies whether the FSK deviation that you specify is used to compensate for gain errors and compute FSK error.

Returns:

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

Return type:

int

set_iq_offset_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q offset before the EVM 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 True.

Name (Value)	Description
False (0)	The IQ offset is not removed before the EVM measurement.
True (1)	The IQ offset is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodIQOffsetRemovalEnabled, int) – Specifies whether to remove the I/Q offset before the EVM measurement.

Returns:

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

Return type:

int

set_m(selector_string, value)[source]

Sets the M-ary number, which is the number of distinct states that represent symbols in the complex baseband modulated waveform.

The M-ary number is calculated using the following formula:

M = 2^{^}(bits per symbol)

Recommended values of M for the modulation types are as follows:

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

Name (Value)	Description
2 (2)	The M-ary number is 2.
4 (4)	The M-ary number is 4.
8 (8)	The M-ary number is 8.
16 (16)	The M-ary number is 16.
32 (32)	The M-ary number is 32.
64 (64)	The M-ary number is 64.
128 (128)	The M-ary number is 128.
256 (256)	The M-ary number is 256.
512 (512)	The M-ary number is 512.
1024 (1024)	The M-ary number is 1,024.
2048 (2048)	The M-ary number is 2,048.
4096 (4096)	The M-ary number is 4,096.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodM, int) – Specifies the M-ary number, which is the number of distinct states that represent symbols in the complex baseband modulated waveform.

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]

Enables digital 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) – Enables digital 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_filter_type(selector_string, value)[source]

Sets whether the measurement needs to compute the measurement filter based on the pulse-shaping filter type or uses the custom measurement filter coefficients.

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
Auto (0)	The signal analyzer computes the measurement filter coefficients based on the pulse-shaping filter information that you specify in the DDemod Pulse Shaping Filter Type attribute. If the DDemod Pulse Shaping Filter Type attribute is set to Custom, the signal analyzer enables equalization.
Custom (1)	The signal analyzer uses the coefficients specified by RFmxDemod DDemod Configure Measurement Filter Custom Coefficients method.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodMeasurementFilterType, int) – Specifies whether the measurement needs to compute the measurement filter based on the pulse-shaping filter type or uses the custom measurement filter coefficients.

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 digital modulation type of the signal that needs to be analyzed.

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

Name (Value)	Description
ASK (0)	The modulation type is amplitude-shift keying (ASK).
FSK (1)	The modulation type is frequency-shift keying (FSK).
PSK (2)	The modulation type is phase-shift keying (PSK).
QAM (3)	The modulation type is quadrature-amplitude modulation (QAM).
MSK (4)	The modulation type is minimum shift keying (MSK).
APSK (5)	The modulation type is amplitude phase-shift keying (APSK).

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodModulationType, int) – Specifies the digital 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_number_of_symbols(selector_string, value)[source]

Sets the number of symbols to be analyzed. The measurement acquires additional symbols to account for filter delays.

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,000.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of symbols to be analyzed. The measurement acquires additional symbols to account for filter delays.

Returns:

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

Return type:

int

set_psk_format(selector_string, value)[source]

Sets the PSK format.

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

Name (Value)	Description
Normal (0)	Sets the modulation type to PSK.
Offset QPSK (1)	Sets the modulation type to offset quadrature PSK (OQPSK). The ideal symbol timing of Q is offset by half of a symbol period from the ideal symbol timing of I.
PI/4 - QPSK (2)	Sets the modulation type to pi/4 QPSK. In this modulation, each QPSK symbol is rotated by pi/4.
PI/8 - 8PSK (3)	Sets the modulation type to pi/8-8 PSK. In this modulation, each 8 PSK symbol is rotated by pi/8.
3*PI/8 - 8PSK (4)	Sets the modulation type to 3pi/8-8 PSK. In this modulation, each 8 PSK symbol is rotated by 3pi/8.
Shaped Offset QPSK (5)	Sets the modulation type to Shaped Offset QPSK.The ideal symbol timing of Q is offset by half of a symbol period from the ideal symbol timing of I and the waveform is shaped using frequency pulse filter.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodPskFormat, int) – Specifies the PSK format.

Returns:

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

Return type:

int

set_pulse_shaping_filter_parameter(selector_string, value)[source]

Sets the rolloff factor for raised cosine and root-raised cosine filter that is used as pulse-shaping filter and measurement filter respectively.

For Gaussian filter, this attribute specifies bandwidth * sample duration.

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

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the rolloff factor for raised cosine and root-raised cosine filter that is used as pulse-shaping filter and measurement filter respectively.

Returns:

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

Return type:

int

set_pulse_shaping_filter_type(selector_string, value)[source]

Sets the pulse-shaping filter used to transmit the signal. This attribute determines the measurement filter to be used for analysis when you set the DDEMOD_MEASUREMENT_FILTER_TYPE 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 Root Raised Cosine.

Name (Value)	Description
Rectangular (0)	The transmitted waveform is filtered using a rectangular filter.
Raised Cosine (1)	The transmitted waveform is filtered using a raised cosine filter. Specify the filter Alpha in the DDemod Pulse Shaping Filter Parameter attribute.
Root Raised Cosine (2)	The transmitted waveform is filtered using a root raised cosine filter. Specify the filter Alpha in the DDemod Pulse Shaping Filter Parameter attribute.
Gaussian (3)	The transmitted waveform is filtered using a Gaussian filter. Specify the filter bandwidth * sample duration in the DDemod Pulse Shaping Filter Parameter attribute. This filter is applicable only to FSK and MSK modulation types.
Custom (4)	The transmitted waveform is filtered using the coefficients that you specify in the RFmxDemod DDemod Configure Pulse Shaping Filter Custom Coefficients method.
Half Sine (5)	The transmitted waveform is filtered using a half sine filter.
Linearized GMSK - EDGE (6)	The transmitted waveform is filtered using an EDGE-specific linearized GMSK filter.
SOQPSK - TG (7)	The transmitted waveform is filtered using a SOQPSK - TG filter as defined in IRIG standard.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodPulseShapingFilterType, int) – Specifies the pulse-shaping filter used to transmit the signal. This attribute determines the measurement filter to be used for analysis when you set the DDEMOD_MEASUREMENT_FILTER_TYPE 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_samples_per_symbol(selector_string, value)[source]

Sets the samples per symbol used to acquire the signal for the measurement.

Sample rate = Symbol rate * Samples per symbol.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the samples per symbol used to acquire the signal 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_search_length(selector_string, value)[source]

Sets the length of the waveform within which the synchronization bit pattern needs to be searched when you set the DDEMOD_SEARCH_LENGTH_AUTO 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 0.001 seconds.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the length of the waveform within which the synchronization bit pattern needs to be searched when you set the DDEMOD_SEARCH_LENGTH_AUTO 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_search_length_auto(selector_string, value)[source]

Sets whether the measurement should search for synchronization bit pattern in the waveform of length determined by the measurement or search for length duration.

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)	Synchronization bit pattern is searched in a waveform within the search Length duration.
True (1)	Synchronization bit pattern is searched in a waveform of length determined by the measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodSearchLengthAuto, int) – Specifies whether the measurement should search for synchronization bit pattern in the waveform of length determined by the measurement or search for length duration.

Returns:

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

Return type:

int

set_signal_structure(selector_string, value)[source]

Sets whether the signal is either a bursty signal or a continuous 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 Continuous.

Name (Value)	Description
Bursted (0)	The signal is a bursty signal.
Continuous (1)	The signal is a continuous signal.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodSignalStructure, int) – Specifies whether the signal is either a bursty signal or a continuous signal.

Returns:

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

Return type:

int

set_spectrum_inverted(selector_string, value)[source]

Sets whether to swap the acquired I and Q samples for demodulation.

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 acquired I and Q samples are used for demodulation as is.
True (1)	The acquired I and Q samples are swapped before using the signal for demodulation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodSpectrumInverted, int) – Specifies whether to swap the acquired I and Q samples for demodulation.

Returns:

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

Return type:

int

set_symbol_map(selector_string, symbol_map)[source]

Sets the symbol map that is used for digital demodulation measurements.

Parameters:

selector_string (string) –
Comprises the signal name.

Example:

””

You can use the build_result_string() function to build the selector string.
symbol_map (numpy.complex64) – Specifies the symbol map used for demodulation.

Returns:

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

Return type:

int

set_symbol_map_type(selector_string, value)[source]

Sets whether the measurement uses the default symbol map or the map that you configure using the configure_symbol_map() method.

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
Auto (0)	Uses a default symbol map.
Custom (1)	Uses the map that you specify using the RFmxDemod DDemod Configure Symbol Map method .

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodSymbolMapType, int) – Specifies whether the measurement uses the default symbol map or the map that you configure using the configure_symbol_map() method.

Returns:

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

Return type:

int

set_symbol_rate(selector_string, value)[source]

Sets the number of symbols transmitted in one second. 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 number of symbols transmitted in one second. 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_synchronization_bits(selector_string, value)[source]

Sets the synchronization bits used to create the reference sequence that must be located in the demodulated signal. The synchronization bits are modulated based on the modulation type to create the reference sequence.

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 (int) – Specifies the synchronization bits used to create the reference sequence that must be located in the demodulated signal. The synchronization bits are modulated based on the modulation type to create the reference sequence.

Returns:

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

Return type:

int

set_synchronization_enabled(selector_string, value)[source]

Sets whether the demodulator needs to search and synchronize the signal to a known reference sequence. The reference sequence is the symbol representation of a defined set of bits known to be present in the transmitted signal. If the synchronization is found in the demodulated signal, the measurement is performed from this point onward. If the synchronization is not found, the entire signal is used 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 False.

Name (Value)	Description
False (0)	Does not search and synchronize the signal.
True (1)	Searches and synchronizes the signal.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DDemodSynchronizationEnabled, int) – Specifies whether the demodulator needs to search and synchronize the signal to a known reference sequence. The reference sequence is the symbol representation of a defined set of bits known to be present in the transmitted signal. If the synchronization is found in the demodulated signal, the measurement is performed from this point onward. If the synchronization is not found, the entire signal is used 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_synchronization_measurement_offset(selector_string, value)[source]

Sets the offset, which is the location from which the signal is considered for further measurements. The offset is specified in symbols of the reference sequence. This offset is not applicable when the synchronization bits are not found.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the offset, which is the location from which the signal is considered for further measurements. The offset is specified in symbols of the reference sequence. This offset is not applicable when the synchronization bits are not found.

Returns:

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

Return type:

int