SParameterQuantity
The S-parameter quantity properties.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]]) -- Retrieve the 'SParameterData' called 'SParameter1' from the S-parameter configuration sParameterData = app.Models[1].Configurations["SParameterConfiguration1"].SParameters["SParameter1"] -- Add the s-parameter to the a Cartesian graph graph = app.CartesianGraphs:Add() sParameterTrace = graph.Traces:Add(sParameterData) -- Configure the fixed axis sParameterTrace.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Real sParameterTrace.Quantity.ValuesNormalised = true
Usage locations
The SParameterQuantity object can be accessed from the following locations:
- Properties
- SParameterSurfacePlot object has property Quantity.
- SParameterTrace object has property Quantity.
Property List
- ComplexComponent
- The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum)
- PhaseUnwrapped
- Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase. (Read/Write boolean)
- ValuesNormalised
- Specifies whether the quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. This property is not valid when the ComplexComponent is Phase. (Read/Write boolean)
- ValuesScaledToDB
- Specifies whether the quantity values are scaled to dB before plotting. This property is only valid when the ComplexComponent is Magnitude. (Read/Write boolean)
Property Details
- ComplexComponent
- The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary.
- Type
- ComplexComponentEnum
- Access
- Read/Write
- PhaseUnwrapped
- Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase.
- Type
- boolean
- Access
- Read/Write
- ValuesNormalised
- Specifies whether the quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. This property is not valid when the ComplexComponent is Phase.
- Type
- boolean
- Access
- Read/Write
- ValuesScaledToDB
- Specifies whether the quantity values are scaled to dB before plotting. This property is only valid when the ComplexComponent is Magnitude.
- Type
- boolean
- Access
- Read/Write