SemResults

Provides methods to fetch and read the Sem measurement results.

class nirfmxcdma2k.sem_results.SemResults(signal_obj)[source]

Bases: object

Provides methods to fetch and read the Sem measurement results.

fetch_carrier_absolute_integrated_power(selector_string, timeout)[source]

Returns the absolute carrier integrated power of the SEM measurement.

Parameters:
  • selector_string (string) –

    This parameter specifies a Selector String comprising of result name. Examples:

    ””

    ”signal::sig1”

    ”result::r1”

    ”signal::sig1/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:

carrier_absolute_integrated_power (float):

This parameter returns the averaged integrated channel power measured in the specified integration bandwidth. 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 (carrier_absolute_integrated_power, error_code)

fetch_lower_offset_margin(selector_string, timeout)[source]

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. Examples:

    ”offset0”

    ”signal::sig1/offset0”

    ”result::r1/offset0”

    ”signal::sig1/result::r1/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 lower offset measurement status based on measurement limits and the failure criteria specified by the standard.

Name (value)

Description

Fail (0)

The measurement fails according to the measurement limits specified by this standard.

Pass (1)

The measurement passes according to the measurement limits specified by this standard.

margin (float):

This parameter returns the margin from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask (absolute or relative).

margin_frequency (float):

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

margin_absolute_power (float):

This parameter returns the power at which the margin occurred in the lower (negative) offset segment relative to the carrier absolute integrated power. This value is expressed in dB.

margin_relative_power (float):

This parameter returns the power at which the margin occurred 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_lower_offset_margin_array(selector_string, timeout)[source]

Returns the array of measurement status 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. Examples:

    ””

    ”signal::sig1”

    ”result::r1”

    ”signal::sig1/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.SemLowerOffsetMeasurementStatus):

This parameter returns the array of lower offset measurement status based on measurement limits and the failure criteria specified by the standard.

Name (value)

Description

Fail (0)

The measurement fails according to the measurement limits specified by this standard.

Pass (1)

The measurement passes according to the measurement limits specified by this standard.

margin (float):

This parameter returns the array of margins from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the limit mask.

margin_frequency (float):

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

margin_absolute_power (float):

This parameter returns the array of powers at which the margin occurred in each lower (negative) offset segment relative to the carrier absolute integrated power. This value is expressed in dB.

margin_relative_power (float):

This parameter returns the array of powers at which the margin occurred 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_lower_offset_power(selector_string, timeout)[source]

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. Examples:

    ”offset0”

    ”signal::sig1/offset0”

    ”result::r1/offset0”

    ”signal::sig1/result::r1/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:

absolute_integrated_power (float):

This parameter returns the lower (negative) offset segment power measured.

relative_integrated_power (float):

This parameter returns the power in the lower (negative) offset segment relative to the carrier absolute integrated power.

absolute_peak_power (float):

This parameter returns the peak power measured in the lower (negative) offset segment. The power is measured in dBm.

peak_frequency (float):

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

relative_peak_power (float):

This parameter returns the frequency at which the peak power occurred in the 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 (absolute_integrated_power, relative_integrated_power, absolute_peak_power, peak_frequency, relative_peak_power, error_code)

fetch_lower_offset_power_array(selector_string, timeout)[source]

Returns the arrays of lower offset segment power measurements.

Parameters:
  • selector_string (string) –

    This parameter specifies a Selector String comprising of result name. Examples:

    ””

    ”signal::sig1”

    ”result::r1”

    ”signal::sig1/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:

absolute_integrated_power (float):

This parameter returns the array of lower (negative) offset segment powers measured.

relative_integrated_power (float):

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

absolute_peak_power (float):

This parameter returns the array of peak powers measured in each lower (negative) offset segment. The power is measured in dBm.

peak_frequency (float):

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

relative_peak_power (float):

This parameter returns the array of frequencies at which the peak power occurred in each 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 (absolute_integrated_power, relative_integrated_power, absolute_peak_power, peak_frequency, relative_peak_power, error_code)

fetch_measurement_status(selector_string, timeout)[source]

Returns the SEM measurement status.

Parameters:
  • selector_string (string) –

    This parameter specifies a Selector String comprising of result name. Examples:

    ””

    ”signal::sig1”

    ”result::r1”

    ”signal::sig1/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 overall measurement status based on the measurement limits which are specified by the standard for each offset segment.

Name (value)

Description

Fail (0)

The measurement fails according to the measurement limits specified by this standard.

Pass (1)

The measurement passes according to the measurement limits specified by this standard.

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, relative_mask, absolute_mask)[source]

Returns the spectrum used for the SEM measurement.

Parameters:
  • selector_string (string) –

    This parameter specifies a Selector String comprising of result name. Examples:

    ””

    ”signal::sig1”

    ”result::r1”

    ”signal::sig1/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 powers measured at each frequency bin. This value is expressed in dBm.

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

  • absolute_mask (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_upper_offset_margin(selector_string, timeout)[source]

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. Examples:

    ”offset0”

    ”signal::sig1/offset0”

    ”result::r1/offset0”

    ”signal::sig1/result::r1/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 indicates the upper offset measurement status based on measurement limits and the failure criteria specified by the standard.

Name (value)

Description

Fail (0)

The measurement fails according to the measurement limits specified by this standard.

Pass (1)

The measurement passes according to the measurement limits specified by this standard.

margin (float):

This parameter returns the margin from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask (absolute or relative).

margin_frequency (float):

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

margin_absolute_power (float):

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

margin_relative_power (float):

This parameter returns the power at which the margin occurred in the upper (positive) offset segment relative to the carrier absolute integrated 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_upper_offset_margin_array(selector_string, timeout)[source]

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. Examples:

    ””

    ”signal::sig1”

    ”result::r1”

    ”signal::sig1/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.SemUpperOffsetMeasurementStatus):

This parameter returns the array of upper offset measurement statuses based on measurement limits and the failure criteria specified by the standard.

Name (value)

Description

Fail (0)

The measurement fails according to the measurement limits specified by this standard.

Pass (1)

The measurement passes according to the measurement limits specified by this standard.

margin (float):

This parameter returns the array of margins from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask (absolute or relative).

margin_frequency (float):

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

margin_absolute_power (float):

This parameter returns the array of powers at which the margin occurred in each upper (positive) offset segment. This value is expressed in dBm.

margin_relative_power (float):

This parameter returns the array of powers at which the margin occurred in each upper (positive) offset segment relative to the carrier absolute integrated 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 (measurement_status, margin, margin_frequency, margin_absolute_power, margin_relative_power, error_code)

fetch_upper_offset_power(selector_string, timeout)[source]

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. Examples:

    ”offset0”

    ”signal::sig1/offset0”

    ”result::r1/offset0”

    ”signal::sig1/result::r1/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:

absolute_integrated_power (float):

This parameter returns the upper (positive) offset segment power measured.

relative_integrated_power (float):

This parameter returns the power in the upper (positive) offset segment relative to the carrier absolute integrated power.

absolute_peak_power (float):

This parameter returns the peak power measured in the upper (positive) offset segment. The power is measured in dBm.

peak_frequency (float):

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

relative_peak_power (float):

This parameter returns the peak power in the upper (positive) offset segment relative to the carrier absolute integrated 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 (absolute_integrated_power, relative_integrated_power, absolute_peak_power, peak_frequency, relative_peak_power, error_code)

fetch_upper_offset_power_array(selector_string, timeout)[source]

Returns the arrays of upper offset segment power measurements.

Parameters:
  • selector_string (string) –

    This parameter specifies a Selector String comprising of result name. Examples:

    ””

    ”signal::sig1”

    ”result::r1”

    ”signal::sig1/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:

absolute_integrated_power (float):

This parameter returns the array of upper (positive) offset segment powers measured.

relative_integrated_power (float):

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

absolute_peak_power (float):

This parameter returns the array of peak powers measured in each upper (positive) offset segment. The power is measured in dBm.

peak_frequency (float):

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

relative_peak_power (float):

This parameter returns the array of peak powers measured in each upper (positive) offset segment relative to the carrier absolute integrated 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 (absolute_integrated_power, relative_integrated_power, absolute_peak_power, peak_frequency, relative_peak_power, error_code)

get_carrier_absolute_integrated_power(selector_string)[source]

Gets the carrier power. The carrier power is the power centered at the center frequency and integrated over the carrier bandwidth of 1.23 MHz. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the carrier power. The carrier power is the power centered at the center frequency and integrated over the carrier bandwidth of 1.23 MHz. 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_integrated_power(selector_string)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute power measured 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_absolute_peak_power(selector_string)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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. 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)[source]

Gets the margin from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask, which can be absolute or relative.

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Setting Specified by the Standard

Margin Description

Absolute

Returns the margin with reference to the absolute limit mask.

Relative

Returns the margin with reference to the relative limit mask.

Abs AND Rel

Returns the margin as the maximum of the margin referenced to the absolute and relative limit masks.

Abs OR Rel

Returns the margin as the minimum of the margin referenced to the absolute and relative limit masks.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the margin from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask, which can be absolute or relative.

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

Gets the absolute power at which the margin occurred in the lower (negative) offset segment. This value is expressed in dBm.

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute power at which the margin occurred 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)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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 carrier absolute integrated 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 (attr_val, error_code)

get_lower_offset_measurement_status(selector_string)[source]

Indicates the lower offset segment measurement status based on measurement limits specified by the standard.

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Name (Value)

Description

Fail (0)

The lower offset segment measurement fails according to the measurement limits specified by the standard.

Pass (1)

The lower offset segment measurement passes according to the measurement limits specified by the standard.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemLowerOffsetMeasurementStatus):

Indicates the lower offset segment measurement status based on measurement limits specified by the standard.

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

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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_relative_integrated_power(selector_string)[source]

Gets the power measured in the lower (negative) offset segment relative to the carrier absolute integrated power. This value is expressed in dB.

Use “offset< <format type=”monospace-italic”>n</format> >” 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 the carrier absolute integrated 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 (attr_val, error_code)

get_lower_offset_relative_peak_power(selector_string)[source]

Gets the peak power measured in the lower (negative) offset segment relative to the carrier absolute integrated power. This value is expressed in dB.

Use “offset< <format type=”monospace-italic”>n</format> >” 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 carrier absolute integrated 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 (attr_val, error_code)

get_measurement_status(selector_string)[source]

Indicates the overall measurement status based on the measurement limits, which are specified by the standard for each offset segment.

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

Name (Value)

Description

Fail (0)

The measurement fails according to the measurement limits specified by this standard.

Pass (1)

The measurement passes according to the measurement limits specified by this standard.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemMeasurementStatus):

Indicates the overall measurement status based on the measurement limits, which are specified by the standard 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_upper_offset_absolute_integrated_power(selector_string)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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. 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_absolute_peak_power(selector_string)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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. 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)[source]

Gets the margin from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask (absolute or relative).

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Setting Specified by the Standard

Margin Description

Absolute

Returns the margin with reference to the absolute limit mask.

Relative

Returns the margin with reference to the relative limit mask.

Abs AND Rel

Returns the margin as the maximum of the margin referenced to the absolute and relative limit masks.

Abs OR Rel

Returns the margin as the minimum of the margin referenced to the absolute and relative limit masks.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the margin from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask (absolute or relative).

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

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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. 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)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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)[source]

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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. 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_measurement_status(selector_string)[source]

Indicates the upper offset measurement status based on measurement limits set by the standard.

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Name (Value)

Description

Fail (0)

The lower offset segment measurement fails according to the measurement limits specified by this standard.

Pass (1)

The lower offset segment measurement passes according to the measurement limits specified by this standard.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemUpperOffsetMeasurementStatus):

Indicates the upper offset measurement status based on measurement limits set by the standard.

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

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

Use “offset< <format type=”monospace-italic”>n</format> >” 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_relative_integrated_power(selector_string)[source]

Gets the power measured in the upper (positive) offset segment relative to the carrier absolute integrated power. This value is expressed in dB.

Use “offset< <format type=”monospace-italic”>n</format> >” 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 carrier absolute integrated 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 (attr_val, error_code)

get_upper_offset_relative_peak_power(selector_string)[source]

Gets the peak power measured in the upper (positive) offset segment relative to the carrier absolute integrated power. This value is expressed in dB.

Use “offset< <format type=”monospace-italic”>n</format> >” 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 carrier absolute integrated 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 (attr_val, error_code)