Amplitude

SCPI Commands :

FRANalysis:AMPLitude:ENABle
FRANalysis:AMPLitude:MODE
FRANalysis:AMPLitude:OFFSet
FRANalysis:AMPLitude:SCALe
Commands in total: 11
Subgroups: 1
Direct child commands: 4
get_enable() → bool[source]
# FRANalysis:AMPLitude:ENABle
value: bool = driver.franalysis.amplitude.get_enable()

Enables the amplitude signal for the frequency response analysis. You can then define the amplitude profile of the signal.

Returns:

state: OFF | ON

get_mode() → AmplitudeMode[source]
# FRANalysis:AMPLitude:MODE
value: enums.AmplitudeMode = driver.franalysis.amplitude.get_mode()

Selects, if the amplitude is a constant value (method RsMxo.franalysis.generator.amplitude() ) or is defined as an amplitude profile.

Returns:

amplitude_mode: CONStant | PROFile

get_offset() → float[source]
# FRANalysis:AMPLitude:OFFSet
value: float = driver.franalysis.amplitude.get_offset()

Sets a vertical offset of the amplitude waveform.

Returns:

vertical_offset: -100 to 100

get_scale() → float[source]
# FRANalysis:AMPLitude:SCALe
value: float = driver.franalysis.amplitude.get_scale()

Sets the vertical scale for the amplitude waveform.

Returns:

vertical_scale: 0.01 to 10

set_enable(state: bool) → None[source]
# FRANalysis:AMPLitude:ENABle
driver.franalysis.amplitude.set_enable(state = False)

Enables the amplitude signal for the frequency response analysis. You can then define the amplitude profile of the signal.

Parameters:

state – OFF | ON

set_mode(amplitude_mode: AmplitudeMode) → None[source]
# FRANalysis:AMPLitude:MODE
driver.franalysis.amplitude.set_mode(amplitude_mode = enums.AmplitudeMode.CONStant)

Selects, if the amplitude is a constant value (method RsMxo.franalysis.generator.amplitude() ) or is defined as an amplitude profile.

Parameters:

amplitude_mode – CONStant | PROFile

set_offset(vertical_offset: float) → None[source]
# FRANalysis:AMPLitude:OFFSet
driver.franalysis.amplitude.set_offset(vertical_offset = 1.0)

Sets a vertical offset of the amplitude waveform.

Parameters:

vertical_offset – -100 to 100

set_scale(vertical_scale: float) → None[source]
# FRANalysis:AMPLitude:SCALe
driver.franalysis.amplitude.set_scale(vertical_scale = 1.0)

Sets the vertical scale for the amplitude waveform.

Parameters:

vertical_scale – 0.01 to 10

Cloning the Group

# Create a copy of the original group, that exists independently
amplitude_copy = driver.franalysis.amplitude.clone()

Subgroups