FcntResults

Provides methods to fetch and read the Fcnt measurement results.

class nirfmxspecan.fcnt_results.FcntResults(signal_obj)

Bases: object

Provides methods to fetch and read the Fcnt measurement results.

fetch_allan_deviation(selector_string, timeout)

Fetches the two-sample deviation of the measured frequency.

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:

allan_deviation (float):

This parameter returns the two-sample deviation of the measured frequency.

error_code (int):

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

Return type:

Tuple (allan_deviation, error_code)

fetch_frequency_trace(selector_string, timeout, frequency_trace)

Fetches the frequency trace for FCnt 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.

• frequency_trace (numpy.float32) – This parameter returns the frequency, in Hz, measured at each time instance.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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 frequency and phase measured using the FCnt 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:

average_relative_frequency (float):

This parameter returns the signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the FCnt Threshold Enabled attribute to True.

average_absolute_frequency (float):

This parameter returns the RF signal frequency. Only samples above the threshold are used when you set the THRESHOLD_ENABLED attribute to True.

mean_phase (float):

This parameter returns the net phase of the vector sum of the I/Q samples used for frequency 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 (average_relative_frequency, average_absolute_frequency, mean_phase, error_code)

fetch_phase_trace(selector_string, timeout, phase_trace)

Fetches the phase trace for FCnt 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.

• phase_trace (numpy.float32) – This parameter returns the averaged phase, in degrees, measured at each time instance.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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_power_trace(selector_string, timeout, power_trace)

Fetches the power trace for FCnt 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.

• power_trace (numpy.float32) – This parameter returns the measured average power, in dBm, at each time instance.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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_allan_deviation(selector_string)

Gets the two-sample deviation of the measured frequency.

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 two-sample deviation of the measured frequency.

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

Gets the RF signal frequency. Only samples above the threshold are used when you set the THRESHOLD_ENABLED attribute to True.

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 RF signal frequency. Only samples above the threshold are used when you set the THRESHOLD_ENABLED attribute to True.

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

Gets the signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the THRESHOLD_ENABLED attribute to True.

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 signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the THRESHOLD_ENABLED attribute to True.

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

Gets the net phase of the vector sum of the I/Q samples used for frequency measurement.

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 net phase of the vector sum of the I/Q samples used for frequency measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

read(selector_string, timeout)

Configures hardware for acquisition, performs measurement on acquired data, and returns the frequency count (FCnt) measurement results.

Parameters:

• selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

• 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. The default value is 10.

Returns:

average_relative_frequency (float):

This parameter returns the signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the FCnt Threshold Enabled attribute to True.

average_absolute_frequency (float):

This parameter returns the RF signal frequency. Only samples above the threshold are used when you set the THRESHOLD_ENABLED attribute to True.

mean_phase (float):

This parameter returns the net phase of the vector sum of the I/Q samples used for frequency 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 (average_relative_frequency, average_absolute_frequency, mean_phase, error_code)