PowerListConfiguration

Provides methods to configure the PowerList measurement.

class nirfmxspecan.power_list_configuration.PowerListConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the PowerList measurement.

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

Configures array of the resolution bandwidth (RBW) filter to measure the power of the signal as seen through this filter, each corresponding to a segment.

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 an array of bandwidths, in Hz, of the resolution bandwidth (RBW) filter used to acquire the fundamental signal, each corresponding to a segment.

  • rbw_filter_type (int) –

    This parameterSpecifies an array of digital resolution bandwidth (RBW) filter shapes, each corresponding to a segment.

    Name (Value)

    Description

    None (1)

    The measurement does not use any RBW filtering.

    Gaussian (2)

    The RBW filter has a Gaussian response.

    Flat (3)

    The RBW filter has a flat response.

    RRC (4)

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

  • rrc_alpha (float) – This parameter specifies an array of roll-off factor for the root-raised-cosine (RRC) filter, each corresponding to a segment.

Returns:

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

Return type:

int

get_measurement_enabled(selector_string)[source]

Gets whether to enable the PowerList 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 PowerList 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_segments(selector_string)[source]

Gets the number of segments to be measured.

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 segments to be measured.

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_segment_frequency(selector_string)[source]

Gets an array of expected carrier frequencies for the RF signal to be acquired, each corresponding to a segment, to which the signal analyzer tunes. This value is expressed in Hz.

RFmx returns an error if this attribute is not configured or if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies an array of expected carrier frequencies for the RF signal to be acquired, each corresponding to a segment, to which the signal analyzer tunes. 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_segment_length(selector_string)[source]

Gets an array of durations, each corresponding to a segment, where each value must be at least the sum of SEGMENT_MEASUREMENT_LENGTH and SEGMENT_MEASUREMENT_OFFSET when the DIGITAL_EDGE_TRIGGER_SOURCE attribute is set to TimerEvent. This value is expressed in seconds.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies an array of durations, each corresponding to a segment, where each value must be at least the sum of SEGMENT_MEASUREMENT_LENGTH and SEGMENT_MEASUREMENT_OFFSET when the DIGITAL_EDGE_TRIGGER_SOURCE attribute is set to TimerEvent. 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_segment_measurement_length(selector_string)[source]

Gets an array of durations, each corresponding to a segment, over which the power value is computed. This value is expressed in seconds.

RFmx returns an error if this attribute is not configured or if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies an array of durations, each corresponding to a segment, over which the power value is computed. 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_segment_measurement_offset(selector_string)[source]

Gets an array of time offsets from the start of each segment, over which the power value is computed. This value is expressed in seconds.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies an array of time offsets from the start of each segment, over which the power value is computed. 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_segment_rbw_filter_alpha(selector_string)[source]

Gets an array of roll-off factor for the root-raised-cosine (RRC) filter, each corresponding to a segment.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies an array of roll-off factor for the root-raised-cosine (RRC) filter, each corresponding to a segment.

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_segment_rbw_filter_bandwidth(selector_string)[source]

Gets an array of bandwidth of the resolution bandwidth (RBW) filters used to measure the signal corresponding to each segment. This value is expressed in Hz.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies an array of bandwidth of the resolution bandwidth (RBW) filters used to measure the signal corresponding to each segment. 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_segment_rbw_filter_type(selector_string)[source]

Gets an array of digital resolution bandwidth (RBW) filter shapes, each corresponding to a segment.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS.

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.

Name (value)

Description

Gaussian (1)

The RBW filter has a Gaussian response.

Flat (2)

The RBW filter has a flat response.

None (5)

The measurement does not use any RBW filtering.

RRC (6)

The RRC filter with the roll-off specified by the SEGMENT_RBW_FILTER_ALPHA attribute is used as the RBW filter.

The default value is Gaussian. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies an array of digital resolution bandwidth (RBW) filter shapes, each corresponding to a segment.

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_segment_reference_level(selector_string)[source]

Gets an array of reference levels, each representing the maximum expected power of the RF input signal for its corresponding segment. This value is configured in dBm for RF devices.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies an array of reference levels, each representing the maximum expected power of the RF input signal for its corresponding segment. This value is configured in dBm for RF devices.

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_segment_trigger_type(selector_string)[source]

Gets an array of trigger type, each corresponding to a segment.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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.

Name (value)

Description

None (0)

No Reference Trigger is configured.

Digital Edge (1)

The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified using the DIGITAL_EDGE_TRIGGER_SOURCE attribute.

IQ Power Edge (2)

The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), which is configured using the the IQ_POWER_EDGE_TRIGGER_SLOPE attribute.

The default value is None. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies an array of trigger type, each corresponding to a segment.

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_measurement_enabled(selector_string, value)[source]

Sets whether to enable the PowerList 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 PowerList 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_segments(selector_string, value)[source]

Sets the number of segments to be measured.

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 segments to be measured.

Returns:

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

Return type:

int

set_segment_frequency(selector_string, value)[source]

Sets an array of expected carrier frequencies for the RF signal to be acquired, each corresponding to a segment, to which the signal analyzer tunes. This value is expressed in Hz.

RFmx returns an error if this attribute is not configured or if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies an array of expected carrier frequencies for the RF signal to be acquired, each corresponding to a segment, to which the signal analyzer tunes. 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_segment_length(selector_string, value)[source]

Sets an array of durations, each corresponding to a segment, where each value must be at least the sum of SEGMENT_MEASUREMENT_LENGTH and SEGMENT_MEASUREMENT_OFFSET when the DIGITAL_EDGE_TRIGGER_SOURCE attribute is set to TimerEvent. This value is expressed in seconds.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies an array of durations, each corresponding to a segment, where each value must be at least the sum of SEGMENT_MEASUREMENT_LENGTH and SEGMENT_MEASUREMENT_OFFSET when the DIGITAL_EDGE_TRIGGER_SOURCE attribute is set to TimerEvent. 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_segment_measurement_length(selector_string, value)[source]

Sets an array of durations, each corresponding to a segment, over which the power value is computed. This value is expressed in seconds.

RFmx returns an error if this attribute is not configured or if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies an array of durations, each corresponding to a segment, over which the power value is computed. 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_segment_measurement_offset(selector_string, value)[source]

Sets an array of time offsets from the start of each segment, over which the power value is computed. This value is expressed in seconds.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies an array of time offsets from the start of each segment, over which the power value is computed. 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_segment_rbw_filter_alpha(selector_string, value)[source]

Sets an array of roll-off factor for the root-raised-cosine (RRC) filter, each corresponding to a segment.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies an array of roll-off factor for the root-raised-cosine (RRC) filter, each corresponding to a segment.

Returns:

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

Return type:

int

set_segment_rbw_filter_bandwidth(selector_string, value)[source]

Sets an array of bandwidth of the resolution bandwidth (RBW) filters used to measure the signal corresponding to each segment. This value is expressed in Hz.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies an array of bandwidth of the resolution bandwidth (RBW) filters used to measure the signal corresponding to each segment. 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_segment_rbw_filter_type(selector_string, value)[source]

Sets an array of digital resolution bandwidth (RBW) filter shapes, each corresponding to a segment.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS.

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.

Name (value)

Description

Gaussian (1)

The RBW filter has a Gaussian response.

Flat (2)

The RBW filter has a flat response.

None (5)

The measurement does not use any RBW filtering.

RRC (6)

The RRC filter with the roll-off specified by the SEGMENT_RBW_FILTER_ALPHA attribute is used as the RBW filter.

The default value is Gaussian. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies an array of digital resolution bandwidth (RBW) filter shapes, each corresponding to a segment.

Returns:

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

Return type:

int

set_segment_reference_level(selector_string, value)[source]

Sets an array of reference levels, each representing the maximum expected power of the RF input signal for its corresponding segment. This value is configured in dBm for RF devices.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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 an empty array.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies an array of reference levels, each representing the maximum expected power of the RF input signal for its corresponding segment. This value is configured in dBm for RF devices.

Returns:

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

Return type:

int

set_segment_trigger_type(selector_string, value)[source]

Sets an array of trigger type, each corresponding to a segment.

RFmx returns an error if the size of the configured values is smaller than the NUMBER_OF_SEGMENTS. 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.

Name (value)

Description

None (0)

No Reference Trigger is configured.

Digital Edge (1)

The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified using the DIGITAL_EDGE_TRIGGER_SOURCE attribute.

IQ Power Edge (2)

The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), which is configured using the the IQ_POWER_EDGE_TRIGGER_SLOPE attribute.

The default value is None. RFmx applies this default value for all segments when the attribute is either unconfigured or reset to its default.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies an array of trigger type, each corresponding to a segment.

Returns:

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

Return type:

int