DpdPreDpd

class nirfmxspecan.dpd_pre_dpd.DpdPreDpd(signal_obj)[source]

Bases: object

apply_pre_dpd_signal_conditioning(selector_string, x0_in, dx_in, waveform_in, idle_duration_present, waveform_out)[source]

Applies crest factor reduction on the input waveform.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
x0_in (float) – Specifies the start time, in seconds.
dx_in (float) – Specifies the sample duration, in seconds.
waveform_in (numpy.complex64) – Specifies the complex baseband equivalent of the RF signal on which the pre-DPD signal conditioning is applied.
idle_duration_present (enums.DpdApplyDpdIdleDurationPresent, int) – Specifies whether the waveform contains an idle duration. The default value is False.
waveform_out (numpy.complex64) – Upon return, contains the complex baseband equivalent of the RF signal after applying signal conditioning on the input waveform.

Returns:

x0_out (float):: Contains the start time, in seconds.
dx_out (float):: Contains the sample duration, in seconds.
papr (float):: Contains the peak-to-average power ratio of the waveform obtained after applying pre-DPD signal conditioning on the input waveform. This value is expressed in dB.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (float, float, float, int)

get_carrier_bandwidth(selector_string)[source]

Gets the carrier bandwidth when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. This value is expressed in Hz.

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

The default value is 20 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the carrier bandwidth when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. 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_carrier_offset(selector_string)[source]

Gets the carrier offset relative to the center of the complex baseband equivalent of the RF signal when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the carrier offset relative to the center of the complex baseband equivalent of the RF signal when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. 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_cfr_enabled(selector_string)[source]

Gets whether to enable the crest factor reduction (CFR) when applying pre-DPD signal conditioning.

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

The default value is False.

Name (Value)	Description
False (0)	Disables the CFR. The RFmxSpecAn DPD Apply Pre-DPD Signal Conditioning method returns an error when the CFR is disabled.
True (1)	Enables the CFR.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdPreDpdCfrEnabled):: Specifies whether to enable the crest factor reduction (CFR) when applying pre-DPD signal conditioning.
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_cfr_filter_enabled(selector_string)[source]

Gets whether to enable the filtering operation when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about filtering.

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

The default value is False.

Name (Value)	Description
False (0)	Disables the filter operation when performing CFR.
True (1)	Enables filter operation when performing CFR. Filter operation is not supported when you set the DPD Pre-DPD CFR Method attribute to Sigmoid.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdPreDpdCfrFilterEnabled):: Specifies whether to enable the filtering operation when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about filtering.
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_cfr_maximum_iterations(selector_string)[source]

Gets the maximum number of iterations allowed to converge waveform PAPR to target PAPR, when you set the CFR_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 maximum number of iterations allowed to converge waveform PAPR to target PAPR, when you set the CFR_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_cfr_method(selector_string)[source]

Gets the method used to perform crest factor reduction (CFR) when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about CFR methods.

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

Name (Value)	Description
Clipping (0)	Hard clips the signal such that the target PAPR is achieved.
Peak Windowing (1)	Scales the peaks in the signal using weighted window function to get smooth peaks and achieve the target PAPR.
Sigmoid (2)	Scales the peaks using modified sigmoid transfer function to get smooth peaks and achieve the target PAPR. This method does not support the filter operation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdPreDpdCfrMethod):: Specifies the method used to perform crest factor reduction (CFR) when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about CFR methods.
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_cfr_number_of_carriers(selector_string)[source]

Gets the number of carriers in the input waveform when you set the CFR_ENABLED attribute and the CFR_FILTER_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 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of carriers in the input waveform when you set the CFR_ENABLED attribute and the CFR_FILTER_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_cfr_shaping_factor(selector_string)[source]

Gets the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to the DPD concept topic for more information about shaping factor.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to the DPD concept topic for more information about shaping factor.
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_cfr_shaping_threshold(selector_string)[source]

Gets the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to the DPD concept topic for more information about shaping threshold.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to the DPD concept topic for more information about shaping threshold.
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_cfr_target_papr(selector_string)[source]

Gets the target peak-to-average power ratio when you set the CFR_ENABLED attribute to True. This value is expressed in dB.

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

The default value is 8.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the target peak-to-average power ratio when you set the CFR_ENABLED attribute to True. This value is expressed in dB.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cfr_window_length(selector_string)[source]

Gets the maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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 maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.
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_cfr_window_type(selector_string)[source]

Gets the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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 Kaiser-Bessel.

Name (Value)	Description
Flat Top (1)	Uses the flat top window function to scale peaks.
Hanning (2)	Uses the Hanning window function to scale peaks.
Hamming (3)	Uses the Hamming window function to scale peaks.
Gaussian (4)	Uses the Gaussian window function to scale peaks.
Blackman (5)	Uses the Blackman window function to scale peaks.
Blackman-Harris (6)	Uses the Blackman-Harris window function to scale peaks.
Kaiser-Bessel (7)	Uses the Kaiser-Bessel window function to scale peaks.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdPreDpdCfrWindowType):: Specifies the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.
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_carrier_bandwidth(selector_string, value)[source]

Sets the carrier bandwidth when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. This value is expressed in Hz.

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

The default value is 20 MHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the carrier bandwidth when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. 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_carrier_offset(selector_string, value)[source]

Sets the carrier offset relative to the center of the complex baseband equivalent of the RF signal when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the carrier offset relative to the center of the complex baseband equivalent of the RF signal when you set the CFR_ENABLED attribute and the CFR_FILTER_ENABLED attribute to True. 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_cfr_enabled(selector_string, value)[source]

Sets whether to enable the crest factor reduction (CFR) when applying pre-DPD signal conditioning.

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

The default value is False.

Name (Value)	Description
False (0)	Disables the CFR. The RFmxSpecAn DPD Apply Pre-DPD Signal Conditioning method returns an error when the CFR is disabled.
True (1)	Enables the CFR.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdPreDpdCfrEnabled, int) – Specifies whether to enable the crest factor reduction (CFR) when applying pre-DPD signal conditioning.

Returns:

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

Return type:

int

set_cfr_filter_enabled(selector_string, value)[source]

Sets whether to enable the filtering operation when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about filtering.

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

The default value is False.

Name (Value)	Description
False (0)	Disables the filter operation when performing CFR.
True (1)	Enables filter operation when performing CFR. Filter operation is not supported when you set the DPD Pre-DPD CFR Method attribute to Sigmoid.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdPreDpdCfrFilterEnabled, int) – Specifies whether to enable the filtering operation when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about filtering.

Returns:

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

Return type:

int

set_cfr_maximum_iterations(selector_string, value)[source]

Sets the maximum number of iterations allowed to converge waveform PAPR to target PAPR, when you set the CFR_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 maximum number of iterations allowed to converge waveform PAPR to target PAPR, when you set the CFR_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_cfr_method(selector_string, value)[source]

Sets the method used to perform crest factor reduction (CFR) when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about CFR methods.

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

Name (Value)	Description
Clipping (0)	Hard clips the signal such that the target PAPR is achieved.
Peak Windowing (1)	Scales the peaks in the signal using weighted window function to get smooth peaks and achieve the target PAPR.
Sigmoid (2)	Scales the peaks using modified sigmoid transfer function to get smooth peaks and achieve the target PAPR. This method does not support the filter operation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdPreDpdCfrMethod, int) – Specifies the method used to perform crest factor reduction (CFR) when you set the CFR_ENABLED attribute to True. Refer to DPD concept topic for more information about CFR methods.

Returns:

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

Return type:

int

set_cfr_number_of_carriers(selector_string, value)[source]

Sets the number of carriers in the input waveform when you set the CFR_ENABLED attribute and the CFR_FILTER_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 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of carriers in the input waveform when you set the CFR_ENABLED attribute and the CFR_FILTER_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_cfr_shaping_factor(selector_string, value)[source]

Sets the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to the DPD concept topic for more information about shaping factor.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to the DPD concept topic for more information about shaping factor.

Returns:

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

Return type:

int

set_cfr_shaping_threshold(selector_string, value)[source]

Sets the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to the DPD concept topic for more information about shaping threshold.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to the DPD concept topic for more information about shaping threshold.

Returns:

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

Return type:

int

set_cfr_target_papr(selector_string, value)[source]

Sets the target peak-to-average power ratio when you set the CFR_ENABLED attribute to True. This value is expressed in dB.

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

The default value is 8.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the target peak-to-average power ratio when you set the CFR_ENABLED attribute to True. This value is expressed in dB.

Returns:

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

Return type:

int

set_cfr_window_length(selector_string, value)[source]

Sets the maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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 maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

Returns:

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

Return type:

int

set_cfr_window_type(selector_string, value)[source]

Sets the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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 Kaiser-Bessel.

Name (Value)	Description
Flat Top (1)	Uses the flat top window function to scale peaks.
Hanning (2)	Uses the Hanning window function to scale peaks.
Hamming (3)	Uses the Hamming window function to scale peaks.
Gaussian (4)	Uses the Gaussian window function to scale peaks.
Blackman (5)	Uses the Blackman window function to scale peaks.
Blackman-Harris (6)	Uses the Blackman-Harris window function to scale peaks.
Kaiser-Bessel (7)	Uses the Kaiser-Bessel window function to scale peaks.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdPreDpdCfrWindowType, int) – Specifies the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

Returns:

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

Return type:

int