SemResults

Provides methods to fetch and read the Sem measurement results.

class nirfmxnr.sem_results.SemResults(signal_obj)

Bases: object

Provides methods to fetch and read the Sem measurement results.

fetch_lower_offset_margin(selector_string, timeout)

Returns the measurement status, margin, frequency at margin, absolute, and relative powers at the margin for lower offset segments. The relative power is relative to the total aggregated power.

Use “offset<n>” or “subblock<n>/offset<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, subblock number, carrier number, and offset number.

  Example:

  ”subblock0/offset0”

  ”result::r1/subblock0/offset0”

  You can use the build_offset_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

measurement_status (enums.SemLowerOffsetMeasurementStatus):

This parameter returns the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

margin (float):

This parameter returns the margin from the absolute limit mask for lower (negative) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. This value is expressed in dB.

margin_frequency (float):

This parameter returns the frequency at which the margin occurs in the lower offset. This value is expressed in Hz.

margin_absolute_power (float):

This parameter returns the power at which the margin occurs in the lower offset segment. This value is expressed in dBm.

margin_relative_power (float):

This parameter returns the power at which the margin occurs in the lower offset segment. 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_lower_offset_margin_array(selector_string, timeout)

Returns an array of measurement status, margin, frequency at margin, absolute, and relative power at margin for lower offset segments. The relative power is relative to the total aggregated power.

Use “subblock<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and subblock number.

  Example:

  ”subblock0”

  ”result::r1/subblock0”

  You can use the build_subblock_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

measurement_status (enums.SemLowerOffsetMeasurementStatus):

This parameter returns an array of the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

margin (float):

This parameter returns an array of the margin from the absolute limit mask for lower (negative) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. This value is expressed in dB.

margin_frequency (float):

This parameter returns an array of the frequency at which the margin occurs in the lower offset. This value is expressed in Hz.

margin_absolute_power (float):

This parameter returns an array of the power at which the margin occurs in the lower offset segment. This value is expressed in dBm.

margin_relative_power (float):

This parameter returns an array of the power at which the margin occurs in the lower offset segment. 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_lower_offset_power(selector_string, timeout)

Returns the total absolute and relative powers, peak, absolute, and relative powers, and the frequency at the peak absolute power of the lower offset segment. The relative power is relative to the total aggregated power.

Use “offset<n>” or “subblock<n>/offset<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, subblock number, carrier number, and offset number.

  Example:

  ”subblock0/offset0”

  ”result::r1/subblock0/offset0”

  You can use the build_offset_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

total_absolute_power (float):

This parameter returns the lower (negative) offset segment power. This value is expressed in dBm.

total_relative_power (float):

This parameter returns the power in the lower offset segment relative to total aggregated power. This value is expressed in dB.

peak_absolute_power (float):

This parameter returns the peak power in the lower offset segment. This value is expressed in dBm.

peak_frequency (float):

This parameter returns the frequency at which the peak power occurs in the lower offset segment. This value is expressed in Hz.

peak_relative_power (float):

This parameter returns the peak power in the lower offset segment relative to total aggregated power. 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 (total_absolute_power, total_relative_power, peak_absolute_power, peak_frequency, peak_relative_power, error_code)

fetch_lower_offset_power_array(selector_string, timeout)

Returns an array of total absolute and relative powers, peak, absolute, and relative powers, and frequencies at peak absolute powers of lower offset segments. The relative power is relative to total aggregated power.

Use “subblock<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and subblock number.

  Example:

  ”subblock0”

  ”result::r1/subblock0”

  You can use the build_subblock_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

total_absolute_power (float):

This parameter returns an array of the lower (negative) segment power. This value is expressed in dBm.

total_relative_power (float):

This parameter returns an array of the power in the lower offset segment relative to total aggregated power. This value is expressed in dB.

peak_absolute_power (float):

This parameter returns an array of the peak power in the lower offset segment. This value is expressed in dBm.

peak_frequency (float):

This parameter returns an array of the frequency at which the peak power occurs in the lower offset segment. This value is expressed in Hz.

peak_relative_power (float):

This parameter returns an array of the peak power in the lower offset segment relative to total aggregated power. 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 (total_absolute_power, total_relative_power, peak_absolute_power, peak_frequency, peak_relative_power, error_code)

fetch_measurement_status(selector_string, timeout)

Returns the overall measurement status based on the standard mask type that you configure.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

measurement_status (enums.SemMeasurementStatus):

This parameter returns the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

error_code (int):

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

Return type:

Tuple (measurement_status, error_code)

fetch_spectrum(selector_string, timeout, spectrum, composite_mask)

Fetches the spectrum used for SEM measurements.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

• spectrum (numpy.float32) – This parameter returns the array of averaged power measured at each frequency bin. This value is expressed in dBm.

• composite_mask (numpy.float32) – This parameter returns the array of averaged power measured at each frequency bin. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start frequency of the channel. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing. 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 (x0, dx, error_code)

fetch_subblock_measurement(selector_string, timeout)

Fetches the power, integration bandwidth, and center frequency of the subblock.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and subblock number.

  Example:

  ”subblock0”

  ”result::r1/subblock0”

  You can use the build_subblock_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

subblock_power (float):

This parameter returns the sum of powers of all the frequency bins over the integration bandwidth of the subblock. This includes the power in inter-carrier gaps within a subblock. This value is expressed in dBm.

integration_bandwidth (float):

This parameter returns the integration bandwidth used in calculating the power of the subblock. Integration bandwidth is the span from left edge of the leftmost carrier to the right edge of the rightmost carrier within a subblock. This value is expressed in Hz.

frequency (float):

This parameter returns the absolute center frequency of the subblock. This value is the center of the subblock integration bandwidth. 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 (subblock_power, integration_bandwidth, frequency, error_code)

fetch_total_aggregated_power(selector_string, timeout)

Returns the sum of powers in all the subblocks.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

total_aggregated_power (float):

This parameter returns the total power of all the subblocks. The power in each subblock is the sum of powers of all the frequency bins over the integration bandwidth of the subblocks. This value includes the power in the inter-carrier gaps within a subblock, but it does not include the power within the subblock gaps. This value is expressed in dBm.

error_code (int):

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

Return type:

Tuple (total_aggregated_power, error_code)

fetch_upper_offset_margin(selector_string, timeout)

Returns the measurement status, margin, frequency at margin, absolute, and relative powers at the margin for upper offset segments. The relative power is relative to the total aggregated power.

Use “offset<n>” or “subblock<n>/offset<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, subblock number, carrier number, and offset number.

  Example:

  ”subblock0/offset0”

  ”result::r1/subblock0/offset0”

  You can use the build_offset_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

measurement_status (enums.SemUpperOffsetMeasurementStatus):

This parameter returns the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

margin (float):

This parameter returns the margin from the absolute limit mask for upper (positive) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. This value is expressed in dB.

margin_frequency (float):

This parameter returns the frequency at which the margin occurs in the upper offset. This value is expressed in Hz.

margin_absolute_power (float):

This parameter returns the power at which the margin occurs in the upper offset segment. This value is expressed in dBm.

margin_relative_power (float):

This parameter returns the power at which the margin occurs in the upper offset segment. 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_upper_offset_margin_array(selector_string, timeout)

Returns an array of measurement status, margin, frequency at margin, absolute, and relative power at margin for upper offset segments. The relative power is relative to the total aggregated power.

Use “subblock<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and subblock number.

  Example:

  ”subblock0”

  ”result::r1/subblock0”

  You can use the build_subblock_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

measurement_status (enums.SemUpperOffsetMeasurementStatus):

This parameter returns an array of the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

margin (float):

This parameter returns an array of the margin from the absolute limit mask for upper (positive) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. This value is expressed in dB.

margin_frequency (float):

This parameter returns an array of the frequency at which the margin occurs in the upper offset. This value is expressed in Hz.

margin_absolute_power (float):

This parameter returns an array of the power at which the margin occurs in the upper offset segment. This value is expressed in dBm.

margin_relative_power (float):

This parameter returns an array of the power at which the margin occurs in the upper (positive) offset segment. 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_upper_offset_power(selector_string, timeout)

Returns the total absolute and relative powers, peak, absolute, and relative powers, and the frequency at the peak absolute power of the upper offset segment. The relative power is relative to the total aggregated power.

Use “offset<n>” or “subblock<n>/offset<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, subblock number, carrier number, and offset number.

  Example:

  ”subblock0/offset0”

  ”result::r1/subblock0/offset0”

  You can use the build_offset_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

total_absolute_power (float):

This parameter returns the upper (positive) offset segment power. This value is expressed in dBm.

total_relative_power (float):

This parameter returns the power in the upper offset segment relative to total aggregated power. This value is expressed in dB.

peak_absolute_power (float):

This parameter returns the peak power in the upper offset segment. This value is expressed in dBm.

peak_frequency (float):

This parameter returns the frequency at which the peak power occurs in the upper offset segment. This value is expressed in Hz.

peak_relative_power (float):

This parameter returns the peak power in the upper offset segment relative to total aggregated power. 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 (total_absolute_power, total_relative_power, peak_absolute_power, peak_frequency, peak_relative_power, error_code)

fetch_upper_offset_power_array(selector_string, timeout)

Returns an array of total absolute and relative powers, peak, absolute, and relative powers, and frequencies at peak absolute powers of upper offset segments. The relative power is relative to total aggregated power.

Use “subblock<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and subblock number.

  Example:

  ”subblock0”

  ”result::r1/subblock0”

  You can use the build_subblock_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

total_absolute_power (float):

This parameter returns an array of the upper segment power. This value is expressed in dBm.

total_relative_power (float):

This parameter returns an array of the power in the upper offset segment relative to total aggregated power. This value is expressed in dB.

peak_absolute_power (float):

This parameter returns an array of the peak power in the upper offset segment. This value is expressed in dBm.

peak_frequency (float):

This parameter returns an array of the frequency at which the peak power occurs in the upper offset segment. This value is expressed in Hz.

peak_relative_power (float):

This parameter returns an array of the peak power in the upper offset segment relative to total aggregated power. 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 (total_absolute_power, total_relative_power, peak_absolute_power, peak_frequency, peak_relative_power, error_code)

get_lower_offset_absolute_integrated_power(selector_string)

Gets the lower (negative) offset segment power. This value is expressed in dBm.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the lower (negative) offset segment power. This value is expressed in dBm.

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_lower_offset_absolute_peak_power(selector_string)

Gets the peak power in the lower (negative) offset segment. This value is expressed in dBm.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power in the lower (negative) offset segment. This value is expressed in dBm.

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_lower_offset_margin(selector_string)

Gets the margin from the absolute limit mask for lower (negative) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the margin from the absolute limit mask for lower (negative) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. 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_lower_offset_margin_absolute_power(selector_string)

Gets the power at which the Margin occurs in the lower (negative) offset segment. This value is expressed in dBm.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power at which the Margin occurs in the lower (negative) offset segment. This value is expressed in dBm.

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_lower_offset_margin_frequency(selector_string)

Gets the frequency at which the Margin occurs in the lower (negative) offset. This value is expressed in Hz.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency at which the Margin occurs in the lower (negative) offset. 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_lower_offset_margin_relative_power(selector_string)

Gets the power at which the Margin occurs in the lower (negative) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power at which the Margin occurs in the lower (negative) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. 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_lower_offset_measurement_status(selector_string)

Gets the measurement status based on the spectrum emission limits defined by the standard mask type that you configure in the SEM_UPLINK_MASK_TYPE attribute.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemLowerOffsetMeasurementStatus):

Returns the measurement status based on the spectrum emission limits defined by the standard mask type that you configure in the SEM_UPLINK_MASK_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_lower_offset_peak_frequency(selector_string)

Gets the frequency at which the peak power occurs in the lower (negative) offset segment. This value is expressed in Hz.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency at which the peak power occurs in the lower (negative) offset 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_lower_offset_relative_integrated_power(selector_string)

Gets the power in the lower (negative) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power in the lower (negative) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. 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_lower_offset_relative_peak_power(selector_string)

Gets the peak power in the lower (negative) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power in the lower (negative) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. 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_measurement_status(selector_string)

Gets the overall measurement status based on the standard mask type that you configure in the SEM_UPLINK_MASK_TYPE attribute.

You do not need to use a selector string to 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
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemMeasurementStatus):

Returns the overall measurement status based on the standard mask type that you configure in the SEM_UPLINK_MASK_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_subblock_power(selector_string)

Gets the power measured over the SEM_COMPONENT_CARRIER_INTEGRATION_BANDWIDTH attribute. This value is expressed in dBm.

Use “subblock<n>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power measured over the SEM_COMPONENT_CARRIER_INTEGRATION_BANDWIDTH attribute. This value is expressed in dBm.

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_total_aggregated_power(selector_string)

Gets the sum of powers of all the subblocks. This value includes the power in the inter-carrier gap within a subblock, but it excludes power in the inter-subblock gaps. This value is expressed in dBm.

You do not need to use a selector string to 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 (float):

Returns the sum of powers of all the subblocks. This value includes the power in the inter-carrier gap within a subblock, but it excludes power in the inter-subblock gaps. This value is expressed in dBm.

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_upper_offset_absolute_integrated_power(selector_string)

Gets the upper (positive) offset segment power. This value is expressed in dBm.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the upper (positive) offset segment power. This value is expressed in dBm.

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_upper_offset_absolute_peak_power(selector_string)

Gets the peak power in the upper (positive) offset segment. This value is expressed in dBm.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power in the upper (positive) offset segment. This value is expressed in dBm.

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_upper_offset_margin(selector_string)

Gets the margin from the absolute limit mask for upper (positive) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the margin from the absolute limit mask for upper (positive) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. 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_upper_offset_margin_absolute_power(selector_string)

Gets the power at which the Margin occurs in the upper (positive) offset segment. This value is expressed in dBm.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power at which the Margin occurs in the upper (positive) offset segment. This value is expressed in dBm.

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_upper_offset_margin_frequency(selector_string)

Gets the frequency at which the Margin occurs in the upper (positive) offset. This value is expressed in Hz.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency at which the Margin occurs in the upper (positive) offset. 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_upper_offset_margin_relative_power(selector_string)

Gets the power at which the Margin occurs in the upper (positive) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power at which the Margin occurs in the upper (positive) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. 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_upper_offset_measurement_status(selector_string)

Gets the measurement status based on the user-configured standard measurement limits. Spectrum emission limits can be defined by setting SEM_UPLINK_MASK_TYPE attribute.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemUpperOffsetMeasurementStatus):

Returns the measurement status based on the user-configured standard measurement limits. Spectrum emission limits can be defined by setting SEM_UPLINK_MASK_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_upper_offset_peak_frequency(selector_string)

Gets the frequency at which the peak power occurs in the upper (positive)offset segment. This value is expressed in Hz.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency at which the peak power occurs in the upper (positive)offset 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_upper_offset_relative_integrated_power(selector_string)

Gets the power in the upper (positive) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power in the upper (positive) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. 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_upper_offset_relative_peak_power(selector_string)

Gets the peak power in the upper (positive) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. This value is expressed in dB.

Use “offset<k>” or “subblock<n>” or “subblock<n>/offset<k>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power in the upper (positive) offset segment relative to SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. 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)