CcdfConfiguration

Provides methods to configure the Ccdf measurement.

class nirfmxspecan.ccdf_configuration.CcdfConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Ccdf measurement.

configure_measurement_interval(selector_string, measurement_interval)[source]

Configures the acquisition time, in seconds, for the complementary cumulative distribution function (CCDF) measurement.

Parameters:

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

  • measurement_interval (float) – This parameter specifies the acquisition time, in seconds, for the measurement. The default value is 1 ms.

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_records(selector_string, number_of_records)[source]

Configures the number of acquisitions used for the complementary cumulative distribution function (CCDF) measurement.

Parameters:

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

  • number_of_records (int) – This parameter specifies the number of acquisitions used for the CCDF measurement. The default value is 1.

Returns:

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

Return type:

int

configure_rbw_filter(selector_string, rbw, rbw_filter_type, rrc_alpha)[source]

Configures the resolution bandwidth (RBW) filter to measure the power statistics of the signal as seen through this filter.

Parameters:

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

  • rbw (float) – This parameter specifies the bandwidth, in Hz, of the resolution bandwidth (RBW) filter used to measure the signal. The default value is 100 kHz.

  • rbw_filter_type (enums.CcdfRbwFilterType, int) –

    This parameter specifies the shape of the digital RBW filter. The default value is None.

    Name (Value)

    Description

    None (5)

    The measurement does not use any RBW filtering.

    Gaussian (1)

    The RBW filter has a Gaussian response.

    Flat (2)

    The RBW filter has a flat response.

    RRC (6)

    The RRC filter with the roll-off specified by RRC Alpha parameter is used as the RBW filter.

  • rrc_alpha (float) – This parameter specifies the roll-off factor for the root-raised-cosine (RRC) filter. The default value is 0.1.

Returns:

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

Return type:

int

configure_threshold(selector_string, threshold_enabled, threshold_level, threshold_type)[source]

Configures the threshold level for the samples that need to be considered for the complementary cumulative distribution function (CCDF) measurement. Enable the threshold when analyzing burst signals or signals with dead time.

Parameters:

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

  • threshold_enabled (enums.CcdfThresholdEnabled, int) –

    This parameter specifies whether to enable thresholding of the acquired samples to be used for the measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    All samples are considered for the measurement.

    True (1)

    The samples above the threshold level specified in the Threshold Level parameter are considered for the measurement.

  • threshold_level (float) – This parameter specifies either the relative or absolute threshold power level based on the value of the Threshold Type parameter. The default value is -20 dB.

  • threshold_type (enums.CcdfThresholdType, int) –

    This parameter specifies the reference for the power level used for thresholding. The default value is Relative.

    Name (Value)

    Description

    Relative (0)

    The threshold is relative to the peak power, in dB, of the acquired samples.

    Absolute (1)

    The threshold is the absolute power, in dBm.

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 CCDF measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the traces to be stored and retrieved after performing the CCDF 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_measurement_enabled(selector_string)[source]

Gets whether to enable the CCDF measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the CCDF 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_measurement_interval(selector_string)[source]

Gets the acquisition time for the CCDF measurement. This value is expressed in seconds.

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

The default value is 0.001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the acquisition time for the CCDF measurement. This value is expressed in seconds.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for CCDF measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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 maximum number of threads used for parallelism for CCDF measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_number_of_records(selector_string)[source]

Gets the number of acquisitions used for the CCDF 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 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of acquisitions used for the CCDF 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_rbw_filter_bandwidth(selector_string)[source]

Gets the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. This value is expressed in Hz.

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

The default value is 100 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. This value is expressed in Hz.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_rbw_filter_rrc_alpha(selector_string)[source]

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

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the roll-off factor for the root-raised-cosine (RRC) filter.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_rbw_filter_type(selector_string)[source]

Gets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is None.

Name (Value)

Description

None (5)

The measurement does not use any RBW filtering.

Gaussian (1)

The RBW filter has a Gaussian response.

Flat (2)

The RBW filter has a flat response.

RRC (6)

The RRC filter with the roll-off specified by the CCDF RBW RRC Alpha attribute is used as the RBW filter.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CcdfRbwFilterType):

Specifies the shape of the digital resolution bandwidth (RBW) filter.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_threshold_enabled(selector_string)[source]

Gets whether to enable thresholding of the acquired samples to be used for the CCDF 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)

All samples are considered for the CCDF measurement.

True (1)

The samples above the threshold level specified in the CCDF Threshold Level attribute are considered for the CCDF measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CcdfThresholdEnabled):

Specifies whether to enable thresholding of the acquired samples to be used for the CCDF 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_threshold_level(selector_string)[source]

Gets either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

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

The default value is -20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_threshold_type(selector_string)[source]

Gets the reference for the power level used for thresholding.

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

Name (Value)

Description

Relative (0)

The threshold is relative to the peak power of the acquired samples.

Absolute (1)

The threshold is the absolute power, in dBm.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CcdfThresholdType):

Specifies the reference for the power level used for thresholding.

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 CCDF measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the CCDF measurement.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the CCDF measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the CCDF measurement.

Returns:

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

Return type:

int

set_measurement_interval(selector_string, value)[source]

Sets the acquisition time for the CCDF measurement. This value is expressed in seconds.

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

The default value is 0.001.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the acquisition time for the CCDF measurement. This value is expressed in seconds.

Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for CCDF measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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 maximum number of threads used for parallelism for CCDF measurement.

Returns:

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

Return type:

int

set_number_of_records(selector_string, value)[source]

Sets the number of acquisitions used for the CCDF 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 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of acquisitions used for the CCDF measurement.

Returns:

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

Return type:

int

set_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. This value is expressed in Hz.

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

The default value is 100 kHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. This value is expressed in Hz.

Returns:

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

Return type:

int

set_rbw_filter_rrc_alpha(selector_string, value)[source]

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

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

The default value is 0.1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the roll-off factor for the root-raised-cosine (RRC) filter.

Returns:

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

Return type:

int

set_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is None.

Name (Value)

Description

None (5)

The measurement does not use any RBW filtering.

Gaussian (1)

The RBW filter has a Gaussian response.

Flat (2)

The RBW filter has a flat response.

RRC (6)

The RRC filter with the roll-off specified by the CCDF RBW RRC Alpha attribute is used as the RBW filter.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CcdfRbwFilterType, int) – Specifies the shape of the digital resolution bandwidth (RBW) filter.

Returns:

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

Return type:

int

set_threshold_enabled(selector_string, value)[source]

Sets whether to enable thresholding of the acquired samples to be used for the CCDF 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)

All samples are considered for the CCDF measurement.

True (1)

The samples above the threshold level specified in the CCDF Threshold Level attribute are considered for the CCDF measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CcdfThresholdEnabled, int) – Specifies whether to enable thresholding of the acquired samples to be used for the CCDF measurement.

Returns:

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

Return type:

int

set_threshold_level(selector_string, value)[source]

Sets either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

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

The default value is -20.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

Returns:

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

Return type:

int

set_threshold_type(selector_string, value)[source]

Sets the reference for the power level used for thresholding.

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

Name (Value)

Description

Relative (0)

The threshold is relative to the peak power of the acquired samples.

Absolute (1)

The threshold is the absolute power, in dBm.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CcdfThresholdType, int) – Specifies the reference for the power level used for thresholding.

Returns:

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

Return type:

int