ChpConfiguration

Provides methods to configure the Chp measurement.

class nirfmxlte.chp_configuration.ChpConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Chp measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)[source]

Configures averaging for the CHP measurement.

Parameters:

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

  • averaging_enabled (enums.ChpAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for the measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The measurement is averaged over multiple acquisitions. The number of acquisitions is obtained by the Averaging Count parameter.

  • averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

  • averaging_type (enums.ChpAveragingType, int) –

    This parameter specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement. The default value is RMS.

    Name (Value)

    Description

    RMS (0)

    The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

    Log (1)

    The power spectrum is averaged in a logarithmic scale.

    Scalar (2)

    The square root of the power spectrum is averaged.

    Max (3)

    The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

    Min (4)

    The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next.

Returns:

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

Return type:

int

configure_integration_bandwidth_type(selector_string, integration_bandwidth_type)[source]

Configures the type of integration bandwidth (IBW), which selects one of the frequency ranges over which the CHP is measured.

Refer to the LTE Channel Power (CHP) topic for more information.

Parameters:

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

  • integration_bandwidth_type (enums.ChpIntegrationBandwidthType, int) –

    This parameter specifies the integration bandwidth (IBW) type used to measure the power of the acquired signal. Integration bandwidth is the frequency interval over which the power in each frequency bin is added to measure the total power in that interval. The default value is Signal Bandwidth.

    Name (Value)

    Description

    Signal Bandwidth (0)

    The IBW excludes the guard bands at the edges of the carrier or subblock from the power calculation.

    Channel Bandwidth (1)

    The IBW includes the guard bands at the edges of the carrier or subblock from the power calculation.

Returns:

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

Return type:

int

configure_rbw_filter(selector_string, rbw_auto, rbw, rbw_filter_type)[source]

Configures the RBW filter.

Parameters:

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

  • rbw_auto (enums.ChpRbwAutoBandwidth, int) –

    This parameter specifies whether the measurement computes the RBW. The default value is True.

    Name (Value)

    Description

    False (0)

    The measurement uses the RBW that you specify in the RBW parameter.

    True (1)

    The measurement computes the RBW.

  • rbw (float) – This parameter specifies the bandwidth of the resolution bandwidth (RBW) filter, used to sweep the acquired signal, when you set the RBW Auto parameter to False. This value is expressed in Hz.

  • rbw_filter_type (enums.ChpRbwFilterType, int) –

    This parameter specifies the shape of the digital RBW filter. The default value is FFT Based.

    Name (Value)

    Description

    FFT Based (0)

    No RBW filtering is performed.

    Gaussian (1)

    An RBW filter with a Gaussian response is applied.

    Flat (2)

    An RBW filter with a flat response is applied.

Returns:

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

Return type:

int

configure_sweep_time(selector_string, sweep_time_auto, sweep_time_interval)[source]

Configures the sweep time.

Parameters:

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

  • sweep_time_auto (enums.ChpSweepTimeAuto, int) –

    This parameter specifies whether the measurement computes the sweep time. The default value is True.

    Name (Value)

    Description

    False (0)

    The measurement uses the sweep time that you specify in the Sweep Time Interval parameter.

    True (1)

    The measurement uses a sweep time of 1 ms.

  • sweep_time_interval (float) – This parameter specifies the sweep time when you set the Sweep Time Auto parameter to False. This value is expressed in seconds. The default value is 1 ms.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the CHP measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the traces to be stored and retrieved after performing the CHP 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)

get_amplitude_correction_type(selector_string)[source]

Gets whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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

The default value is RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpAmplitudeCorrectionType):

Specifies whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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

Gets the number of acquisitions used for averaging when you set the CHP_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of acquisitions used for averaging when you set the CHP_AVERAGING_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_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the CHP measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The CHP measurement uses the value of the CHP Averaging Count attribute as the number of acquisitions over which the CHP measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpAveragingEnabled):

Specifies whether to enable averaging for the CHP 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)

get_averaging_type(selector_string)[source]

Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP measurement.

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

The default value is RMS.

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

Min (4)

The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpAveragingType):

Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP 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)

get_component_carrier_integration_bandwidth(selector_string)[source]

Gets the integration bandwidth of a component carrier. This value is expressed in Hz.

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

The default value is 9 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the integration bandwidth of a component carrier. 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_integration_bandwidth_type(selector_string)[source]

Gets the integration bandwidth (IBW) type used to measure the power of the acquired signal. Integration bandwidth is the frequency interval over which the power in each frequency bin is added to measure the total power in that interval.

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

Refer to the LTE Channel Power topic for more information about CHP IBW types.

The default value is Signal Bandwidth.

Name (Value)

Description

Signal Bandwidth (0)

The IBW excludes the guard bands at the edges of the carrier or subblock.

Channel Bandwidth (1)

The IBW includes the guard bands at the edges of the carrier or subblock.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpIntegrationBandwidthType):

Specifies the integration bandwidth (IBW) type used to measure the power of the acquired signal. Integration bandwidth is the frequency interval over which the power in each frequency bin is added to measure the total power in that interval.

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

Gets whether to enable the channel power measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the channel power 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)

get_measurement_mode(selector_string)[source]

Gets whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Measure.

Name (Value)

Description

Measure (0)

CHP measurement is performed on the acquired signal.

Calibrate Noise Floor (1)

Manual noise calibration of the signal analyzer is performed for the CHP measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpMeasurementMode):

Specifies whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

Gets whether RFmx automatically computes the averaging count used for instrument noise calibration.

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

The default value is True.

Name (Value)

Description

False (0)

RFmx uses the averages that you set for the CHP Noise Cal Averaging Count attribute.

True (1)

RFmx uses a noise calibration averaging count of 32.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCalibrationAveragingAuto):

Specifies whether RFmx automatically computes the averaging count used for instrument noise calibration.

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

Gets the averaging count used for noise calibration when you set the CHP_NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

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

The default value is 32.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the averaging count used for noise calibration when you set the CHP_NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

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

Gets whether the noise calibration and measurement is performed automatically by the measurement or initiated by you. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Auto

Name (Value)

Description

Manual (0)

When you set the CHP Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for CHP measurement manually. When you set the CHP Meas Mode attribute to Measure, you can initiate the CHP measurement manually.

Auto (1)

When you set the CHP Noise Comp Enabled attribute to True, RFmx sets the Input Isolation Enabled attribute to Enabled and calibrates the instrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the CHP measurement, including compensation for the noise contribution of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCalibrationMode):

Specifies whether the noise calibration and measurement is performed automatically by the measurement or initiated by you. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

Gets whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the CHP_NOISE_CALIBRATION_MODE attribute to Auto, or set the CHP Noise Cal Mode attribute to Manual and the CHP_MEASUREMENT_MODE attribute to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is False.

Name (Value)

Description

False (0)

Disables noise compensation.

True (1)

Enables noise compensation.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCompensationEnabled):

Specifies whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the CHP_NOISE_CALIBRATION_MODE attribute to Auto, or set the CHP Noise Cal Mode attribute to Manual and the CHP_MEASUREMENT_MODE attribute to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

Gets the noise compensation type. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Analyzer and Termination.

Name (Value)

Description

Analyzer and Termination (0)

Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.

Analyzer Only (1)

Compensates only for analyzer noise.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCompensationType):

Specifies the noise compensation type. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

Gets the maximum number of threads used for parallelism for the CHP measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for the CHP 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)

get_rbw_filter_auto_bandwidth(selector_string)[source]

Gets whether the CHP measurement computes the RBW.

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

The default value is True.

Name (Value)

Description

False (0)

The measurement uses the RBW that you specify in the CHP RBW (Hz) attribute.

True (1)

The measurement computes the RBW.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpRbwAutoBandwidth):

Specifies whether the CHP measurement computes the RBW.

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

Gets the bandwidth of the RBW filter, used to sweep the acquired signal, when you set the CHP_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

The default value is 30000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth of the RBW filter, used to sweep the acquired signal, when you set the CHP_RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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_rbw_filter_type(selector_string)[source]

Gets the shape of the digital RBW filter.

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

The default value is FFT Based.

Name (Value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpRbwFilterType):

Specifies the shape of the digital RBW filter.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_subblock_integration_bandwidth(selector_string)[source]

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

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

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

Gets whether the measurement computes the sweep time.

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

The default value is True.

Name (Value)

Description

False (0)

The measurement uses the sweep time that you specify in the CHP Sweep Time attribute.

True (1)

The measurement uses a sweep time of 1 ms.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpSweepTimeAuto):

Specifies whether the measurement computes the sweep time.

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

Gets the sweep time when you set the CHP_SWEEP_TIME_AUTO attribute to False. This value is expressed in seconds.

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

The default value is 1 ms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the sweep time when you set the CHP_SWEEP_TIME_AUTO attribute to False. 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the CHP measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the CHP measurement.

Returns:

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

Return type:

int

set_amplitude_correction_type(selector_string, value)[source]

Sets whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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

The default value is RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
Parameters:
Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the CHP_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of acquisitions used for averaging when you set the CHP_AVERAGING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the CHP measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The CHP measurement uses the value of the CHP Averaging Count attribute as the number of acquisitions over which the CHP measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpAveragingEnabled, int) – Specifies whether to enable averaging for the CHP measurement.

Returns:

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

Return type:

int

set_averaging_type(selector_string, value)[source]

Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP measurement.

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

The default value is RMS.

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

Min (4)

The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP measurement.

Returns:

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

Return type:

int

set_integration_bandwidth_type(selector_string, value)[source]

Sets the integration bandwidth (IBW) type used to measure the power of the acquired signal. Integration bandwidth is the frequency interval over which the power in each frequency bin is added to measure the total power in that interval.

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

Refer to the LTE Channel Power topic for more information about CHP IBW types.

The default value is Signal Bandwidth.

Name (Value)

Description

Signal Bandwidth (0)

The IBW excludes the guard bands at the edges of the carrier or subblock.

Channel Bandwidth (1)

The IBW includes the guard bands at the edges of the carrier or subblock.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpIntegrationBandwidthType, int) – Specifies the integration bandwidth (IBW) type used to measure the power of the acquired signal. Integration bandwidth is the frequency interval over which the power in each frequency bin is added to measure the total power in that interval.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the channel power measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the channel power measurement.

Returns:

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

Return type:

int

set_measurement_mode(selector_string, value)[source]

Sets whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Measure.

Name (Value)

Description

Measure (0)

CHP measurement is performed on the acquired signal.

Calibrate Noise Floor (1)

Manual noise calibration of the signal analyzer is performed for the CHP measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpMeasurementMode, int) –

    Specifies whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

Returns:

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

Return type:

int

set_noise_calibration_averaging_auto(selector_string, value)[source]

Sets whether RFmx automatically computes the averaging count used for instrument noise calibration.

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

The default value is True.

Name (Value)

Description

False (0)

RFmx uses the averages that you set for the CHP Noise Cal Averaging Count attribute.

True (1)

RFmx uses a noise calibration averaging count of 32.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpNoiseCalibrationAveragingAuto, int) – Specifies whether RFmx automatically computes the averaging count used for instrument noise calibration.

Returns:

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

Return type:

int

set_noise_calibration_averaging_count(selector_string, value)[source]

Sets the averaging count used for noise calibration when you set the CHP_NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

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

The default value is 32.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the averaging count used for noise calibration when you set the CHP_NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

Returns:

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

Return type:

int

set_noise_calibration_mode(selector_string, value)[source]

Sets whether the noise calibration and measurement is performed automatically by the measurement or initiated by you. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Auto

Name (Value)

Description

Manual (0)

When you set the CHP Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for CHP measurement manually. When you set the CHP Meas Mode attribute to Measure, you can initiate the CHP measurement manually.

Auto (1)

When you set the CHP Noise Comp Enabled attribute to True, RFmx sets the Input Isolation Enabled attribute to Enabled and calibrates the instrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the CHP measurement, including compensation for the noise contribution of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpNoiseCalibrationMode, int) –

    Specifies whether the noise calibration and measurement is performed automatically by the measurement or initiated by you. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

Returns:

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

Return type:

int

set_noise_compensation_enabled(selector_string, value)[source]

Sets whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the CHP_NOISE_CALIBRATION_MODE attribute to Auto, or set the CHP Noise Cal Mode attribute to Manual and the CHP_MEASUREMENT_MODE attribute to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is False.

Name (Value)

Description

False (0)

Disables noise compensation.

True (1)

Enables noise compensation.
Parameters:
Returns:

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

Return type:

int

set_noise_compensation_type(selector_string, value)[source]

Sets the noise compensation type. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Analyzer and Termination.

Name (Value)

Description

Analyzer and Termination (0)

Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.

Analyzer Only (1)

Compensates only for analyzer noise.
Parameters:
Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the CHP measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for the CHP measurement.

Returns:

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

Return type:

int

set_rbw_filter_auto_bandwidth(selector_string, value)[source]

Sets whether the CHP measurement computes the RBW.

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

The default value is True.

Name (Value)

Description

False (0)

The measurement uses the RBW that you specify in the CHP RBW (Hz) attribute.

True (1)

The measurement computes the RBW.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpRbwAutoBandwidth, int) – Specifies whether the CHP measurement computes the RBW.

Returns:

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

Return type:

int

set_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the RBW filter, used to sweep the acquired signal, when you set the CHP_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

The default value is 30000.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the bandwidth of the RBW filter, used to sweep the acquired signal, when you set the CHP_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

Returns:

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

Return type:

int

set_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital RBW filter.

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

The default value is FFT Based.

Name (Value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpRbwFilterType, int) – Specifies the shape of the digital RBW filter.

Returns:

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

Return type:

int

set_sweep_time_auto(selector_string, value)[source]

Sets whether the measurement computes the sweep time.

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

The default value is True.

Name (Value)

Description

False (0)

The measurement uses the sweep time that you specify in the CHP Sweep Time attribute.

True (1)

The measurement uses a sweep time of 1 ms.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpSweepTimeAuto, int) – Specifies whether the measurement computes the sweep time.

Returns:

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

Return type:

int

set_sweep_time_interval(selector_string, value)[source]

Sets the sweep time when you set the CHP_SWEEP_TIME_AUTO attribute to False. This value is expressed in seconds.

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

The default value is 1 ms.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the sweep time when you set the CHP_SWEEP_TIME_AUTO attribute to False. This value is expressed in seconds.

Returns:

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

Return type:

int

validate_noise_calibration_data(selector_string)[source]

Indicates whether calibration data is valid for the configuration specified by the signal name in the Selector string parameter.

Parameters:

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

Returns:

noise_calibration_data_valid (enums.ChpNoiseCalibrationDataValid):

This parameter returns whether the calibration data is valid.

Name (Value)

Description

False (0)

Returns false if the calibration data is not present for the specified configuration or if the difference between the current device temperature and the calibration temperature exceeds the [-5 °C, 5 °C] range.

True (1)

Returns true if the calibration data is present for the configuration specified by the signal name in the Selector string parameter.
error_code (int):

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

Return type:

Tuple (noise_calibration_data_valid, error_code)