SemResults

Provides methods to fetch and read the Sem measurement results.

class nirfmxspecan.sem_results.SemResults(signal_obj)

Bases: object

Provides methods to fetch and read the Sem measurement results.

fetch_absolute_mask_trace(selector_string, timeout, absolute_mask)

Fetches the absolute mask trace used for SEM measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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.

• absolute_mask (numpy.float32) – This parameter returns absolute mask used for the channel.

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_carrier_measurement(selector_string, timeout)

Returns the carrier power measurement. Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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:

absolute_power (float):

This parameter returns the carrier power. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

peak_absolute_power (float):

This parameter returns the peak power in the carrier channel. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

peak_frequency (float):

This parameter returns the frequency, in Hz, at which the peak power occurs in the carrier channel.

total_relative_power (float):

This parameter returns the carrier power, in dB, relative to the total carrier power of all enabled carriers.

error_code (int):

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

Return type:

Tuple (absolute_power, peak_absolute_power, peak_frequency, total_relative_power, error_code)

fetch_composite_measurement_status(selector_string, timeout)

Indicates the overall SEM measurement status based on the measurement limits and the fail criteria that you set in the OFFSET_LIMIT_FAIL_MASK attribute for each offset segment.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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:

composite_measurement_status (enums.SemCompositeMeasurementStatus):

This parameter indicates the overall measurement status based on the measurement limits and the fail criteria that you set in the SEM Offset Seg Limit Fail Mask attribute for each offset segment.

Name (Value)	Description
Fail (0)	The measurement has failed.
Pass (1)	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 (composite_measurement_status, error_code)

fetch_frequency_resolution(selector_string, timeout)

Returns the frequency bin spacing, in Hz, of the spectrum acquired by the measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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:

frequency_resolution (float):

This parameter returns the frequency bin spacing, in Hz, of the spectrum acquired by the measurement.

error_code (int):

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

Return type:

Tuple (frequency_resolution, error_code)

fetch_lower_offset_margin(selector_string, timeout)

Returns the measurement status and margin from the limit line measured in the lower offset segment. Use “offset<n>” as the selector string to read parameters from this method.

Parameters:

• selector_string (string) –

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

  Example:

  ”offset0”

  ”result::r1/offset0”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 indicates the lower offset measurement status based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK attribute.

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, in dB, from the limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. Margin is defined as the maximum difference between the spectrum and the limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Absolute, the margin is with reference to the absolute limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Relative, the margin is with reference to the relative limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs AND Rel, the margin is the maximum of the margins referenced to the absolute and relative limit masks.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs OR Rel, the margin is the minimum of the margins referenced to the absolute and relative limit masks.

margin_frequency (float):

This parameter returns the frequency, in Hz, at which the margin occurred in the lower (negative) offset.

margin_absolute_power (float):

This parameter returns the power, in dBm or dBm/Hz, at which the margin occurred in the lower (negative) offset segment. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

margin_relative_power (float):

This parameter returns the power, in dB, at which the margin occurred in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

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 the array of measurement statuses and margins from the limit line measured in the lower offset segments.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 array of lower offset measurement statuses based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK attribute.

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 array of margins, in dB, from the limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. Margin is defined as the maximum difference between the spectrum and the limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Absolute, the margin is with reference to the absolute limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Relative, the margin is with reference to the relative limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs AND Rel, the margin is the maximum of the margins referenced to the absolute and relative limit masks.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs OR Rel, the margin is the minimum of the margins referenced to the absolute and relative limit masks.

margin_frequency (float):

This parameter returns the array of frequencies, in Hz, at which the margin occurred in each lower (negative) offset segment.

margin_absolute_power (float):

This parameter returns the array of powers, in dBm or dBm/Hz, at which the margin occurred in the lower (negative) offset segment. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

margin_relative_power (float):

This parameter returns the array of powers, in dB, at which the margin occurred in each lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

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 lower offset segment power measurements. Use “offset<n>” as the selector string to read parameters from this method.

Parameters:

• selector_string (string) –

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

  Example:

  ”offset0”

  ”result::r1/offset0”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 measured.

The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

total_relative_power (float):

This parameter returns the power in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference.

peak_absolute_power (float):

This parameter returns the peak power measured in the lower (negative) offset segment. The power is measured in dBm when you set the SEM Power Units attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

peak_frequency (float):

This parameter returns the frequency, in Hz, at which the peak power occurred in the offset segment.

peak_relative_power (float):

This parameter returns the peak power in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

When you set the SEM Ref Type attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference carrier.

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 the arrays of lower offset segment power measurements.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 array of lower (negative) offset segment powers measured.

The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

total_relative_power (float):

This parameter returns the array of powers in each lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference.

peak_absolute_power (float):

This parameter returns the array of peak powers measured in each lower (negative) offset segment. The power is measured in dBm when you set the SEM Power Units attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

peak_frequency (float):

This parameter returns the array of frequencies, in Hz, at which the peak power occurred in each offset segment.

peak_relative_power (float):

This parameter returns the array of peak powers in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

When you set the SEM Ref Type attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference carrier.

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_relative_mask_trace(selector_string, timeout, relative_mask)

Fetches the relative mask trace used for SEM measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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.

• relative_mask (numpy.float32) – This parameter returns relative mask used for the channel.

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_spectrum(selector_string, timeout, spectrum)

Fetches the spectrum used for SEM measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 powers measured at each frequency bin. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start frequency. 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_total_carrier_power(selector_string, timeout)

Returns the total integrated power, in dBm, of all the carriers or the power spectral density, in dBm/Hz, based on the value of the POWER_UNITS attribute.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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_carrier_power (float):

This parameter returns the total integrated power, in dBm, of all the active carriers measured when you set the SEM Power Units attribute to dBm. Returns the power spectral density, in dBm/Hz, when you set the SEM Power Units attribute to dBm/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 (total_carrier_power, error_code)

fetch_upper_offset_margin(selector_string, timeout)

Returns the measurement status and margin from the limit line measured in the upper offset segment. Use “offset<n>” as the selector string to read parameters from this method.

Parameters:

• selector_string (string) –

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

  Example:

  ”offset0”

  ”result::r1/offset0”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 indicates the upper offset measurement status based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK attribute.

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, in dB, from the limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. Margin is defined as the maximum difference between the spectrum and the limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Absolute, the margin is with reference to the absolute limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Relative, the margin is with reference to the relative limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs AND Rel, the margin is the maximum of the margins referenced to the absolute and relative limit masks.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs OR Rel, the margin is the minimum of the margins referenced to the absolute and relative limit masks.

margin_frequency (float):

This parameter returns the frequency, in Hz, at which the margin occurred in the upper (positive) offset.

margin_absolute_power (float):

This parameter returns the power, in dBm or dBm/Hz, at which the margin occurred in the upper (positive) offset segment. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

margin_relative_power (float):

This parameter returns the power, in dB, at which the margin occurred in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

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 the measurement status and margin from the limit line measured in the upper offset segments.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 array of upper offset measurement statuses based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK attribute.

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 array of margins, in dB, from the limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. Margin is defined as the maximum difference between the spectrum and the limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Absolute, the margin is with reference to the absolute limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Relative, the margin is with reference to the relative limit mask.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs AND Rel, the margin is the maximum of the margins referenced to the absolute and relative limit masks.

When you set the SEM Offset Seg Limit Fail Mask attribute to Abs OR Rel, the margin is the minimum of the margins referenced to the absolute and relative limit masks.

margin_frequency (float):

This parameter returns the array of frequencies, in Hz, at which the margin occurred in each upper (positive) offset.

margin_absolute_power (float):

This parameter returns the array of powers, in dBm or dBm/Hz, at which the margin occurred in each upper (positive) offset segment. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

margin_relative_power (float):

This parameter returns the array of powers, in dB, at which the margin occurred in each upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

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 upper offset segment power measurements. Use “offset<n>” as the selector string to read parameters from this method.

Parameters:

• selector_string (string) –

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

  Example:

  ”offset0”

  ”result::r1/offset0”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 measured.

The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

total_relative_power (float):

This parameter returns the power in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference.

peak_absolute_power (float):

This parameter returns the peak power measured in the upper (positive) offset segment. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

peak_frequency (float):

This parameter returns the frequency, in Hz, at which the peak power occurred in the offset segment.

peak_relative_power (float):

This parameter returns the peak power in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference carrier.

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 the arrays of upper offset segment power measurements.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. 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 array of upper (positive) offset segment powers measured.

The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

total_relative_power (float):

This parameter returns the array of powers measured in each upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference.

peak_absolute_power (float):

This parameter returns the array of peak powers measured in each upper (positive) offset segment. The power is measured in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

peak_frequency (float):

This parameter returns the array of frequencies, in Hz, at which the peak power occurred in each offset segment.

peak_relative_power (float):

This parameter returns the array of peak powers measured in each upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference carrier.

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

Gets the carrier power.

The carrier power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the carrier power.

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

Gets the center frequency of the carrier relative to the CENTER_FREQUENCY attribute. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the center frequency of the carrier relative to the CENTER_FREQUENCY attribute. 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_integration_bandwidth(selector_string)

Gets the frequency range, over which the measurement integrates the carrier power. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency range, over which the measurement integrates the carrier power. 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_peak_absolute_power(selector_string)

Gets the peak power in the carrier channel.

The power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

Use “carrier<n>” 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 carrier channel.

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

Gets the frequency at which the peak power occurs in the carrier channel. This value is expressed in Hz.

Use “carrier<n>” 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 carrier channel. 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_total_relative_power(selector_string)

Gets the carrier power relative to the total carrier power of all enabled carriers. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the carrier power relative to the total carrier power of all enabled carriers. 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_composite_measurement_status(selector_string)

Indicates the overall measurement status based on the measurement limits and the fail criteria that you set in the OFFSET_LIMIT_FAIL_MASK attribute for each offset segment.

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

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.SemCompositeMeasurementStatus):

Indicates the overall measurement status based on the measurement limits and the fail criteria that you set in the OFFSET_LIMIT_FAIL_MASK attribute for each offset 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_frequency_resolution(selector_string)

Gets the frequency bin spacing of the spectrum acquired by the measurement. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency bin spacing of the spectrum acquired by the measurement. 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(selector_string)

Gets the margin from the limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the limit mask.

When you set the SEM Offset Limit Fail Mask attribute to Absolute, the margin is with reference to the absolute limit mask.

When you set the SEM Offset Limit Fail Mask attribute to Relative, the margin is with reference to the relative limit mask.

When you set the SEM Offset Limit Fail Mask attribute to Abs AND Rel, the margin is the maximum of the margins referenced to the absolute and relative limit masks.

When you set the SEM Offset Limit Fail Mask attribute to Abs OR Rel, the margin is the minimum of the margins referenced to the absolute and relative limit masks.

Use “offset<n>” 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 limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the limit mask.

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 occurred in the lower (negative) offset segment.

The power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

Use “offset<n>” 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 occurred in the lower (negative) offset 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_lower_offset_margin_frequency(selector_string)

Gets the frequency at which the margin occurred in the lower (negative) offset segment. This value is expressed in Hz.

Use “offset<n>” 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 occurred 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_margin_relative_power(selector_string)

Gets the power at which the margin occurred in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier. This value is expressed in dB.

Use “offset<n>” 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 occurred in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier. 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)

Indicates the lower offset segment measurement status based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK attribute.

Use “offset<n>” 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):

Indicates the lower offset segment measurement status based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK 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_absolute_power(selector_string)

Gets the peak power measured in the lower (negative) offset segment.

The power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power measured in the lower (negative) offset 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_lower_offset_peak_frequency(selector_string)

Gets the frequency at which the peak power occurred in the lower offset segment. This value is expressed in Hz.

Use “offset<n>” 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 occurred in the lower 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_peak_relative_power(selector_string)

Gets the peak power measured in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference carrier.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power measured in the lower (negative) offset segment relative to the integrated or peak power of the reference carrier.

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

Gets the index of the carrier that was used as the power reference to define the lower (negative) offset segment relative power. The reference carrier is the carrier that has an offset closest to the offset segment.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the index of the carrier that was used as the power reference to define the lower (negative) offset segment relative power. The reference carrier is the carrier that has an offset closest to the offset 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_lower_offset_start_frequency(selector_string)

Gets the start frequency of the lower (negative) offset segment. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the start frequency of 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_stop_frequency(selector_string)

Gets the stop frequency of the lower (negative) offset segment. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the stop frequency of 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_total_absolute_power(selector_string)

Gets the power measured in the lower (negative) offset segment.

The power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

Use “offset<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 in the lower (negative) offset 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_lower_offset_total_relative_power(selector_string)

Gets the power measured in the lower (negative) offset segment relative to either the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference carrier.

Use “offset<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 in the lower (negative) offset segment relative to either the integrated or peak power of the reference carrier.

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

Gets the total integrated power, in dBm, of all the enabled carriers measured when you set the POWER_UNITS attribute to dBm. Returns the power spectral density, in dBm/Hz, when you set the SEM Power Units attribute to dBm/Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the total integrated power, in dBm, of all the enabled carriers measured when you set the POWER_UNITS attribute to dBm. Returns the power spectral density, in dBm/Hz, when you set the SEM Power Units attribute to dBm/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(selector_string)

Gets the margin from the limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the limit mask.

When you set the SEM Offset Limit Fail Mask attribute to Absolute, the margin is with reference to the absolute limit mask.

When you set the SEM Offset Limit Fail Mask attribute to Relative, the margin is with reference to the relative limit mask.

When you set the SEM Offset Limit Fail Mask attribute to Abs AND Rel, the margin is the maximum of the margin referenced to the absolute and relative limit masks.

When you set the SEM Offset Limit Fail Mask attribute to Abs OR Rel, the margin is the minimum of the margin referenced to the absolute and relative limit masks.

Use “offset<n>” 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 limit mask value that you set in the OFFSET_LIMIT_FAIL_MASK attribute. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the limit mask.

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 occurred in the upper (positive) offset segment.

The power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

Use “offset<n>” 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 occurred in the upper (positive) offset 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_upper_offset_margin_frequency(selector_string)

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

Use “offset<n>” 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 occurred 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 occurred in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier. This value is expressed in dB.

Use “offset<n>” 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 occurred in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier. 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)

Indicates the upper offset measurement status based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK attribute.

Use “offset<n>” 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):

Indicates the upper offset measurement status based on measurement limits and the fail criteria that you specify in the OFFSET_LIMIT_FAIL_MASK 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_absolute_power(selector_string)

Gets the peak power measured in the upper (positive) offset segment.

The power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power measured in the upper (positive) offset 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_upper_offset_peak_frequency(selector_string)

Gets the frequency at which the peak power occurred in the upper offset segment. This value is expressed in Hz.

Use “offset<n>” 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 occurred in the upper 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_peak_relative_power(selector_string)

Gets the peak power measured in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference carrier.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power measured in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

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

Gets the index of the carrier that was used as the power reference to define the upper (positive) offset segment relative power. The reference carrier is the carrier that has an offset closest to the offset segment.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the index of the carrier that was used as the power reference to define the upper (positive) offset segment relative power. The reference carrier is the carrier that has an offset closest to the offset 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_upper_offset_start_frequency(selector_string)

Gets the start frequency of the upper (positive) offset segment. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the start frequency of 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_stop_frequency(selector_string)

Gets the stop frequency of the upper (positive) offset segment. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the stop frequency of 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_total_absolute_power(selector_string)

Gets the offset segment power measured in the upper (positive) offset segment.

The power is reported in dBm when you set the POWER_UNITS attribute to dBm, and in dBm/Hz when you set the SEM Power Units attribute to dBm/Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the offset segment power measured in the upper (positive) offset 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_upper_offset_total_relative_power(selector_string)

Gets the power measured in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

When you set the REFERENCE_TYPE attribute to Integration, the reference carrier power is the total power in the reference carrier. When you set the SEM Ref Type attribute to Peak, the reference carrier power is the peak power in the reference.

Use “offset<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 in the upper (positive) offset segment relative to the integrated or peak power of the reference carrier.

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)