PowerRampResults

Provides methods to fetch and read the PowerRamp measurement results.

class nirfmxwlan.powerramp_results.PowerRampResults(signal_obj)

Bases: object

Provides methods to fetch and read the PowerRamp measurement results.

fetch_fall_trace(selector_string, timeout, raw_waveform, processed_waveform, threshold, power_reference)

Returns the raw, processed, thresholding and power reference waveforms at the end of a burst.

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 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. This value is expressed in seconds. The default value is 10.

• raw_waveform (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

• processed_waveform (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

• threshold (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

• power_reference (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

Returns:

x0 (float):

This parameter returns the trace start time. This value is expressed in seconds.

dx (float):

This parameter returns the sampling interval. This value is expressed in seconds.

error_code (int):

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

Return type:

Tuple (x0, dx, error_code)

fetch_measurement(selector_string, timeout)

Returns the PowerRamp rise time and fall time.

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 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. This value is expressed in seconds. The default value is 10.

Returns:

rise_time_mean (float):

This parameter returns the rise time of the acquired signal that is the amount of time taken for the power envelope to rise from a level of 10 percent to 90 percent. This value is expressed in seconds. When you set the AVERAGING_ENABLED attribute to True, this parameter returns the mean of the rise time computed for each averaging count. This value is expressed in seconds.

fall_time_mean (float):

This parameter returns the fall time of the acquired signal that is the amount of time taken for the power envelope to fall from a level of 90 percent to 10 percent. This value is expressed in seconds. When you set the PowerRamp Averaging Enabled attribute to True, this parameter returns the mean of the fall time computed for each averaging count. This value is expressed in seconds.

error_code (int):

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

Return type:

Tuple (rise_time_mean, fall_time_mean, error_code)

fetch_rise_trace(selector_string, timeout, raw_waveform, processed_waveform, threshold, power_reference)

Returns the raw, processed, threshold and power-reference traces at the beginning of a burst.

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 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. This value is expressed in seconds. The default value is 10.

• raw_waveform (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

• processed_waveform (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

• threshold (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

• power_reference (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed as a percentage.

Returns:

x0 (float):

This parameter returns the trace start time. This value is expressed in seconds.

dx (float):

This parameter returns the sampling interval. This value is expressed in seconds.

error_code (int):

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

Return type:

Tuple (x0, dx, error_code)

get_fall_time_mean(selector_string)

Gets the power-ramp fall time of the burst. This value is expressed in seconds.

This measurement is performed in accordance with section 16.3.7.7 of IEEE Standard 802.11-2016.

When you set the AVERAGING_ENABLED attribute to True, this attribute returns the mean of the fall time results computed for each averaging count.

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 power-ramp fall time of the burst. This value is expressed in seconds.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_rise_time_mean(selector_string)

Gets the power-ramp rise time of the burst. This value is expressed in seconds.

This measurement is performed in accordance with section 16.3.7.7 of IEEE Standard 802.11-2016.

When you set the AVERAGING_ENABLED attribute to True, this attribute returns the mean of the rise time results computed for each averaging count.

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 power-ramp rise time of the burst. This value is expressed in seconds.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)